Initiate Auth
cognitoidentityprovider_initiate_auth | R Documentation |
Declares an authentication flow and initiates sign-in for a user in the Amazon Cognito user directory¶
Description¶
Declares an authentication flow and initiates sign-in for a user in the
Amazon Cognito user directory. Amazon Cognito might respond with an
additional challenge or an AuthenticationResult
that contains the
outcome of a successful authentication. You can't sign in a user with a
federated IdP with initiate_auth
. For more information, see
Authentication.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
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.
Usage¶
cognitoidentityprovider_initiate_auth(AuthFlow, AuthParameters,
ClientMetadata, ClientId, AnalyticsMetadata, UserContextData, Session)
Arguments¶
AuthFlow |
[required] The authentication flow that you want to initiate.
Each 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
CUSTOM_AUTH Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers. USER_PASSWORD_AUTH Client-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 |
The authentication parameters. These are inputs corresponding to
the The required values are specific to the InitiateAuthRequest$AuthFlow. The following are some authentication flows and their parameters. Add
a
For more information about |
ClientMetadata |
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 send an
When Amazon Cognito invokes the functions for these triggers, it
passes a JSON payload as input to the function. This payload contains a
For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide. When you use the
|
ClientId |
[required] The ID of the app client that your user wants to sign in to. |
AnalyticsMetadata |
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. |
UserContextData |
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. |
Session |
The optional session ID from a |
Value¶
A list with the following syntax:
list(
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 = list(
"string"
),
AuthenticationResult = list(
AccessToken = "string",
ExpiresIn = 123,
TokenType = "string",
RefreshToken = "string",
IdToken = "string",
NewDeviceMetadata = list(
DeviceKey = "string",
DeviceGroupKey = "string"
)
),
AvailableChallenges = list(
"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"
)
)
Request syntax¶
svc$initiate_auth(
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 = list(
"string"
),
ClientMetadata = list(
"string"
),
ClientId = "string",
AnalyticsMetadata = list(
AnalyticsEndpointId = "string"
),
UserContextData = list(
IpAddress = "string",
EncodedData = "string"
),
Session = "string"
)