CognitoIdentityProvider / Client / admin_initiate_auth
admin_initiate_auth#
- CognitoIdentityProvider.Client.admin_initiate_auth(**kwargs)#
Starts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that you’d like to begin. The authentication flow that you specify must be supported in your app client configuration. For more information about authentication flows, see Authentication flows.
Note
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Note
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
See also: AWS API Documentation
Request Syntax
response = client.admin_initiate_auth( UserPoolId='string', ClientId='string', AuthFlow='USER_SRP_AUTH'|'REFRESH_TOKEN_AUTH'|'REFRESH_TOKEN'|'CUSTOM_AUTH'|'ADMIN_NO_SRP_AUTH'|'USER_PASSWORD_AUTH'|'ADMIN_USER_PASSWORD_AUTH'|'USER_AUTH', AuthParameters={ 'string': 'string' }, ClientMetadata={ 'string': 'string' }, AnalyticsMetadata={ 'AnalyticsEndpointId': 'string' }, ContextData={ 'IpAddress': 'string', 'ServerName': 'string', 'ServerPath': 'string', 'HttpHeaders': [ { 'headerName': 'string', 'headerValue': 'string' }, ], 'EncodedData': 'string' }, Session='string' )
- Parameters:
UserPoolId (string) –
[REQUIRED]
The ID of the user pool where the user wants to sign in.
ClientId (string) –
[REQUIRED]
The ID of the app client where the user wants to sign in.
AuthFlow (string) –
[REQUIRED]
The authentication flow that you want to initiate. Each
AuthFlow
has linkedAuthParameters
that you must submit. The following are some example flows.USER_AUTH
The entry point for choice-based authentication with passwords, one-time passwords, and WebAuthn authenticators. Request a preferred authentication type or review available authentication types. From the offered authentication types, select one in a challenge response and then authenticate with that method in an additional challenge response. To activate this setting, your user pool must be in the Essentials tier or higher.
USER_SRP_AUTH
Username-password authentication with the Secure Remote Password (SRP) protocol. For more information, see Use SRP password verification in custom authentication flow.
REFRESH_TOKEN_AUTH and REFRESH_TOKEN
Receive new ID and access tokens when you pass a
REFRESH_TOKEN
parameter with a valid refresh token as the value. For more information, see Using the refresh token.CUSTOM_AUTH
Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.
ADMIN_USER_PASSWORD_AUTH
Server-side username-password authentication with the password sent directly in the request. For more information about client-side and server-side authentication, see SDK authorization models.
AuthParameters (dict) –
The authentication parameters. These are inputs corresponding to the
AuthFlow
that you’re invoking. The required values depend on the value ofAuthFlow
for example:For
USER_AUTH
:USERNAME
(required),PREFERRED_CHALLENGE
. If you don’t provide a value forPREFERRED_CHALLENGE
, Amazon Cognito responds with theAvailableChallenges
parameter that specifies the available sign-in methods.For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.For
ADMIN_USER_PASSWORD_AUTH
:USERNAME
(required),PASSWORD
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
For more information about
SECRET_HASH
, see Computing secret hash values. For information aboutDEVICE_KEY
, see Working with user devices in your user pool.(string) –
(string) –
ClientMetadata (dict) –
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
Pre signup
Pre authentication
User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a
validationData
attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process thevalidationData
value to enhance your workflow for your specific needs.When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn’t provide the ClientMetadata value as input:
Post authentication
Custom message
Pre token generation
Create auth challenge
Define auth challenge
Custom email sender
Custom SMS sender
For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.
Note
When you use the
ClientMetadata
parameter, note that Amazon Cognito won’t do the following:Store the
ClientMetadata
value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn’t include triggers, theClientMetadata
parameter serves no purpose.Validate the
ClientMetadata
value.Encrypt the
ClientMetadata
value. Don’t send sensitive information in this parameter.
(string) –
(string) –
AnalyticsMetadata (dict) –
Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
AnalyticsEndpointId (string) –
The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send notifications.
ContextData (dict) –
Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
For more information, see Collecting data for threat protection in applications.
IpAddress (string) – [REQUIRED]
The source IP address of your user’s device.
ServerName (string) – [REQUIRED]
The name of your application’s service endpoint.
ServerPath (string) – [REQUIRED]
The path of your application’s service endpoint.
HttpHeaders (list) – [REQUIRED]
The HTTP headers from your user’s authentication request.
(dict) –
The HTTP header in the
ContextData
parameter.headerName (string) –
The header name.
headerValue (string) –
The header value.
EncodedData (string) –
Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
Session (string) – The optional session ID from a
ConfirmSignUp
API request. You can sign in a user directly from the sign-up process with anAuthFlow
ofUSER_AUTH
andAuthParameters
ofEMAIL_OTP
orSMS_OTP
, depending on how your user pool sent the confirmation-code message.
- Return type:
dict
- Returns:
Response Syntax
{ 'ChallengeName': 'SMS_MFA'|'EMAIL_OTP'|'SOFTWARE_TOKEN_MFA'|'SELECT_MFA_TYPE'|'MFA_SETUP'|'PASSWORD_VERIFIER'|'CUSTOM_CHALLENGE'|'SELECT_CHALLENGE'|'DEVICE_SRP_AUTH'|'DEVICE_PASSWORD_VERIFIER'|'ADMIN_NO_SRP_AUTH'|'NEW_PASSWORD_REQUIRED'|'SMS_OTP'|'PASSWORD'|'WEB_AUTHN'|'PASSWORD_SRP', 'Session': 'string', 'ChallengeParameters': { 'string': 'string' }, 'AuthenticationResult': { 'AccessToken': 'string', 'ExpiresIn': 123, 'TokenType': 'string', 'RefreshToken': 'string', 'IdToken': 'string', 'NewDeviceMetadata': { 'DeviceKey': 'string', 'DeviceGroupKey': 'string' } }, 'AvailableChallenges': [ 'SMS_MFA'|'EMAIL_OTP'|'SOFTWARE_TOKEN_MFA'|'SELECT_MFA_TYPE'|'MFA_SETUP'|'PASSWORD_VERIFIER'|'CUSTOM_CHALLENGE'|'SELECT_CHALLENGE'|'DEVICE_SRP_AUTH'|'DEVICE_PASSWORD_VERIFIER'|'ADMIN_NO_SRP_AUTH'|'NEW_PASSWORD_REQUIRED'|'SMS_OTP'|'PASSWORD'|'WEB_AUTHN'|'PASSWORD_SRP', ] }
Response Structure
(dict) –
Initiates the authentication response, as an administrator.
ChallengeName (string) –
The name of the challenge that you’re responding to with this call. This is returned in the
AdminInitiateAuth
response if you must pass another challenge.Possible challenges include the following:
Note
All of the following challenges require
USERNAME
and, when the app client has a client secret,SECRET_HASH
in the parameters.WEB_AUTHN
: Respond to the challenge with the results of a successful authentication with a WebAuthn authenticator, or passkey. Examples of WebAuthn authenticators include biometric devices and security keys.PASSWORD
: Respond withUSER_PASSWORD_AUTH
parameters:USERNAME
(required),PASSWORD
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.PASSWORD_SRP
: Respond withUSER_SRP_AUTH
parameters:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.SELECT_CHALLENGE
: Respond to the challenge withUSERNAME
and anANSWER
that matches one of the challenge types in theAvailableChallenges
response parameter.SMS_MFA
: Respond with anSMS_MFA_CODE
that your user pool delivered in an SMS message.EMAIL_OTP
: Respond with anEMAIL_OTP_CODE
that your user pool delivered in an email message.PASSWORD_VERIFIER
: Respond withPASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
, andTIMESTAMP
after client-side SRP calculations.CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. The parameters of the challenge are determined by your Lambda function.DEVICE_SRP_AUTH
: Respond with the initial parameters of device SRP authentication. For more information, see Signing in with a device.DEVICE_PASSWORD_VERIFIER
: Respond withPASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
, andTIMESTAMP
after client-side SRP calculations. For more information, see Signing in with a device.NEW_PASSWORD_REQUIRED
: For users who are required to change their passwords after successful first login. Respond to this challenge withNEW_PASSWORD
and any required attributes that Amazon Cognito returned in therequiredAttributes
parameter. You can also set values for attributes that aren’t required by your user pool and that your app client can write. Amazon Cognito only returns this challenge for users who have temporary passwords. When you create passwordless users, you must provide values for all required attributes.
Note
In a
NEW_PASSWORD_REQUIRED
challenge response, you can’t modify a required attribute that already has a value. InAdminRespondToAuthChallenge
orRespondToAuthChallenge
, set a value for any keys that Amazon Cognito returned in therequiredAttributes
parameter, then use theAdminUpdateUserAttributes
orUpdateUserAttributes
API operation to modify the value of any additional attributes.MFA_SETUP
: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parametersMFAS_CAN_SETUP
value. To set up time-based one-time password (TOTP) MFA, use the session returned in this challenge fromInitiateAuth
orAdminInitiateAuth
as an input toAssociateSoftwareToken
. Then, use the session returned byVerifySoftwareToken
as an input toRespondToAuthChallenge
orAdminRespondToAuthChallenge
with challenge nameMFA_SETUP
to complete sign-in. To set up SMS or email MFA, collect aphone_number
oremail
attribute for the user. Then restart the authentication flow with anInitiateAuth
orAdminInitiateAuth
request.
Session (string) –
The session that must be passed to challenge-response requests. If an
AdminInitiateAuth
orAdminRespondToAuthChallenge
API request results in another authentication challenge, Amazon Cognito returns a session ID and the parameters of the next challenge. Pass this session ID in theSession
parameter ofAdminRespondToAuthChallenge
.ChallengeParameters (dict) –
The parameters of an authentication challenge. Amazon Cognito returns challenge parameters as a guide to the responses your user or application must provide for the returned
ChallengeName
. Calculate responses to the challenge parameters and pass them in theChallengeParameters
ofAdminRespondToAuthChallenge
.All challenges require
USERNAME
and, when the app client has a client secret,SECRET_HASH
.In SRP challenges, Amazon Cognito returns the
username
attribute inUSER_ID_FOR_SRP
instead of any email address, preferred username, or phone number alias that you might have specified in yourAdminInitiateAuth
request. You must use the username and not an alias in theChallengeResponses
of your challenge response.(string) –
(string) –
AuthenticationResult (dict) –
The outcome of successful authentication. This is only returned if the user pool has no additional challenges to return. If Amazon Cognito returns another challenge, the response includes
ChallengeName
,ChallengeParameters
, andSession
so that your user can answer the challenge.AccessToken (string) –
Your user’s access token.
ExpiresIn (integer) –
The expiration period of the authentication result in seconds.
TokenType (string) –
The intended use of the token, for example
Bearer
.RefreshToken (string) –
Your user’s refresh token.
IdToken (string) –
Your user’s ID token.
NewDeviceMetadata (dict) –
The new device metadata from an authentication result.
DeviceKey (string) –
The device key, an identifier used in generating the
DEVICE_PASSWORD_VERIFIER
for device SRP authentication.DeviceGroupKey (string) –
The device group key, an identifier used in generating the
DEVICE_PASSWORD_VERIFIER
for device SRP authentication.
AvailableChallenges (list) –
This response parameter lists the available authentication challenges that users can select from in choice-based authentication. For example, they might be able to choose between passkey authentication, a one-time password from an SMS message, and a traditional password.
(string) –
Exceptions
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.InternalErrorException
CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException
CognitoIdentityProvider.Client.exceptions.InvalidUserPoolConfigurationException
CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException
CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException
CognitoIdentityProvider.Client.exceptions.MFAMethodNotFoundException
CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleAccessPolicyException
CognitoIdentityProvider.Client.exceptions.InvalidEmailRoleAccessPolicyException
CognitoIdentityProvider.Client.exceptions.InvalidSmsRoleTrustRelationshipException
CognitoIdentityProvider.Client.exceptions.PasswordResetRequiredException
CognitoIdentityProvider.Client.exceptions.UserNotFoundException
CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException