AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . cognito-idp ]
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken .
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
create-user-pool-client
--user-pool-id <value>
--client-name <value>
[--generate-secret | --no-generate-secret]
[--refresh-token-validity <value>]
[--access-token-validity <value>]
[--id-token-validity <value>]
[--token-validity-units <value>]
[--read-attributes <value>]
[--write-attributes <value>]
[--explicit-auth-flows <value>]
[--supported-identity-providers <value>]
[--callback-urls <value>]
[--logout-urls <value>]
[--default-redirect-uri <value>]
[--allowed-o-auth-flows <value>]
[--allowed-o-auth-scopes <value>]
[--allowed-o-auth-flows-user-pool-client | --no-allowed-o-auth-flows-user-pool-client]
[--analytics-configuration <value>]
[--prevent-user-existence-errors <value>]
[--enable-token-revocation | --no-enable-token-revocation]
[--enable-propagate-additional-user-context-data | --no-enable-propagate-additional-user-context-data]
[--auth-session-validity <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--user-pool-id
(string)
The user pool ID for the user pool where you want to create a user pool client.
--client-name
(string)
The client name for the user pool client you would like to create.
--generate-secret
| --no-generate-secret
(boolean)
Boolean to specify whether you want to generate a secret for the user pool client being created.
--refresh-token-validity
(integer)
The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for
RefreshTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
RefreshTokenValidity
as10
andTokenValidityUnits
asdays
, your user can refresh their session and retrieve new access and ID tokens for 10 days.The default time unit for
RefreshTokenValidity
in an API request is days. You can't setRefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
--access-token-validity
(integer)
The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for
AccessTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
AccessTokenValidity
to10
andTokenValidityUnits
tohours
, your user can authorize access with their access token for 10 hours.The default time unit for
AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
--id-token-validity
(integer)
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for
IdTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
IdTokenValidity
as10
andTokenValidityUnits
ashours
, your user can authenticate their session with their ID token for 10 hours.The default time unit for
IdTokenValidity
in an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
--token-validity-units
(structure)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
AccessToken -> (string)
A time unit for the value that you set in theAccessTokenValidity
parameter. The defaultAccessTokenValidity
time unit ishours
.AccessTokenValidity
duration can range from five minutes to one day.IdToken -> (string)
A time unit for the value that you set in theIdTokenValidity
parameter. The defaultIdTokenValidity
time unit ishours
.IdTokenValidity
duration can range from five minutes to one day.RefreshToken -> (string)
A time unit for the value that you set in theRefreshTokenValidity
parameter. The defaultRefreshTokenValidity
time unit isdays
.RefreshTokenValidity
duration can range from 60 minutes to 10 years.
Shorthand Syntax:
AccessToken=string,IdToken=string,RefreshToken=string
JSON Syntax:
{
"AccessToken": "seconds"|"minutes"|"hours"|"days",
"IdToken": "seconds"|"minutes"|"hours"|"days",
"RefreshToken": "seconds"|"minutes"|"hours"|"days"
}
--read-attributes
(list)
The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the
ReadAttributes
for your app client, your app can read the values ofemail_verified
,phone_number_verified
, and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes,ReadAttributes
doesn't return any information. Amazon Cognito only populatesReadAttributes
in the API response if you have specified your own custom set of read attributes.(string)
Syntax:
"string" "string" ...
--write-attributes
(list)
The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets
family_name
to the new value.When you don't specify the
WriteAttributes
for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes,WriteAttributes
doesn't return any information. Amazon Cognito only populatesWriteAttributes
in the API response if you have specified your own custom set of write attributes.If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .
(string)
Syntax:
"string" "string" ...
--explicit-auth-flows
(list)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
Note
If you don't specify a value forExplicitAuthFlows
, your user client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.Valid values include:
ALLOW_USER_AUTH
: Enable selection-based sign-in withUSER_AUTH
. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without otherExplicitAuthFlows
permitting them. For example users can complete an SRP challenge throughUSER_AUTH
without the flowUSER_SRP_AUTH
being active for the app client. This flow doesn't includeCUSTOM_AUTH
.ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.In some environments, you will see the values
ADMIN_NO_SRP_AUTH
,CUSTOM_AUTH_FLOW_ONLY
, orUSER_PASSWORD_AUTH
. You can't assign these legacyExplicitAuthFlows
values to user pool clients at the same time as values that begin withALLOW_
, likeALLOW_USER_SRP_AUTH
.(string)
Syntax:
"string" "string" ...
Where valid values are:
ADMIN_NO_SRP_AUTH
CUSTOM_AUTH_FLOW_ONLY
USER_PASSWORD_AUTH
ALLOW_ADMIN_USER_PASSWORD_AUTH
ALLOW_CUSTOM_AUTH
ALLOW_USER_PASSWORD_AUTH
ALLOW_USER_SRP_AUTH
ALLOW_REFRESH_TOKEN_AUTH
ALLOW_USER_AUTH
--supported-identity-providers
(list)
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported:
COGNITO
,SignInWithApple
, andLoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for exampleMySAMLIdP
orMyOIDCIdP
.This setting applies to providers that you can access with the hosted UI and OAuth 2.0 authorization server . The removal of
COGNITO
from this list doesn't prevent authentication operations for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to block access with a WAF rule .(string)
Syntax:
"string" "string" ...
--callback-urls
(list)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
(string)
Syntax:
"string" "string" ...
--logout-urls
(list)
A list of allowed logout URLs for the IdPs.
(string)
Syntax:
"string" "string" ...
--default-redirect-uri
(string)
The default redirect URI. In app clients with one assigned IdP, replaces
redirect_uri
in authentication requests. Must be in theCallbackURLs
list.A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
For more information, see Default redirect URI .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
--allowed-o-auth-flows
(list)
The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add
client_credentials
as the only allowed OAuth flow.codeUse a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint.implicitIssue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentialsIssue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.(string)
Syntax:
"string" "string" ...
Where valid values are:
code
implicit
client_credentials
--allowed-o-auth-scopes
(list)
The allowed OAuth scopes. Possible values provided by OAuth are
phone
,openid
, andprofile
. Possible values provided by Amazon Web Services areaws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.(string)
Syntax:
"string" "string" ...
--allowed-o-auth-flows-user-pool-client
| --no-allowed-o-auth-flows-user-pool-client
(boolean)
Set to
true
to use OAuth 2.0 features in your user pool app client.AllowedOAuthFlowsUserPoolClient
must betrue
before you can configure the following features in your app client.
CallBackURLs
: Callback URLs.LogoutURLs
: Sign-out redirect URLs.AllowedOAuthScopes
: OAuth 2.0 scopes.AllowedOAuthFlows
: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient
totrue
in aCreateUserPoolClient
orUpdateUserPoolClient
API request. If you don't set a value forAllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults tofalse
.
--analytics-configuration
(structure)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
Note
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.ApplicationId -> (string)
Your Amazon Pinpoint project ID.ApplicationArn -> (string)
The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project thatApplicationArn
declares. You can also configure your application to pass an endpoint ID in theAnalyticsMetadata
parameter of sign-in operations. The endpoint ID is information about the destination for push notificationsRoleArn -> (string)
The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.ExternalId -> (string)
The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.UserDataShared -> (boolean)
IfUserDataShared
istrue
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
Shorthand Syntax:
ApplicationId=string,ApplicationArn=string,RoleArn=string,ExternalId=string,UserDataShared=boolean
JSON Syntax:
{
"ApplicationId": "string",
"ApplicationArn": "string",
"RoleArn": "string",
"ExternalId": "string",
"UserDataShared": true|false
}
--prevent-user-existence-errors
(string)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to
ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs return aUserNotFoundException
exception if the user doesn't exist in the user pool.Valid values include:
ENABLED
- This prevents user existence-related errors.LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.Defaults to
LEGACY
when you don't provide a value.Possible values:
LEGACY
ENABLED
--enable-token-revocation
| --no-enable-token-revocation
(boolean)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken .
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
--enable-propagate-additional-user-context-data
| --no-enable-propagate-additional-user-context-data
(boolean)
Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activateEnablePropagateAdditionalUserContextData
in an app client that has a client secret.
--auth-session-validity
(integer)
Amazon Cognito creates a session token for each API request in an authentication flow.AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a user pool client
This example creates a new user pool client with two explicit authorization flows: USER_PASSWORD_AUTH and ADMIN_NO_SRP_AUTH.
Command:
aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH"
Output:
{
"UserPoolClient": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"ClientName": "MyNewClient",
"ClientId": "6p3bs000no6a4ue1idruvd05ad",
"LastModifiedDate": 1548697449.497,
"CreationDate": 1548697449.497,
"RefreshTokenValidity": 30,
"ExplicitAuthFlows": [
"USER_PASSWORD_AUTH",
"ADMIN_NO_SRP_AUTH"
],
"AllowedOAuthFlowsUserPoolClient": false
}
}
UserPoolClient -> (structure)
The user pool client that was just created.
UserPoolId -> (string)
The ID of the user pool associated with the app client.ClientName -> (string)
The name of the app client.ClientId -> (string)
The ID of the app client.ClientSecret -> (string)
The app client secret.LastModifiedDate -> (timestamp)
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a JavaDate
object.CreationDate -> (timestamp)
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a JavaDate
object.RefreshTokenValidity -> (integer)
The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for
RefreshTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
RefreshTokenValidity
as10
andTokenValidityUnits
asdays
, your user can refresh their session and retrieve new access and ID tokens for 10 days.The default time unit for
RefreshTokenValidity
in an API request is days. You can't setRefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
AccessTokenValidity -> (integer)
The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for
AccessTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
AccessTokenValidity
to10
andTokenValidityUnits
tohours
, your user can authorize access with their access token for 10 hours.The default time unit for
AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
IdTokenValidity -> (integer)
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for
IdTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
IdTokenValidity
as10
andTokenValidityUnits
ashours
, your user can authenticate their session with their ID token for 10 hours.The default time unit for
IdTokenValidity
in an API request is hours. Valid range is displayed below in seconds.If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
TokenValidityUnits -> (structure)
The time units that, with
IdTokenValidity
,AccessTokenValidity
, andRefreshTokenValidity
, set and display the duration of ID, access, and refresh tokens for an app client. You can assign a separate token validity unit to each type of token.AccessToken -> (string)
A time unit for the value that you set in theAccessTokenValidity
parameter. The defaultAccessTokenValidity
time unit ishours
.AccessTokenValidity
duration can range from five minutes to one day.IdToken -> (string)
A time unit for the value that you set in theIdTokenValidity
parameter. The defaultIdTokenValidity
time unit ishours
.IdTokenValidity
duration can range from five minutes to one day.RefreshToken -> (string)
A time unit for the value that you set in theRefreshTokenValidity
parameter. The defaultRefreshTokenValidity
time unit isdays
.RefreshTokenValidity
duration can range from 60 minutes to 10 years.ReadAttributes -> (list)
The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the
ReadAttributes
for your app client, your app can read the values ofemail_verified
,phone_number_verified
, and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes,ReadAttributes
doesn't return any information. Amazon Cognito only populatesReadAttributes
in the API response if you have specified your own custom set of read attributes.(string)
WriteAttributes -> (list)
The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets
family_name
to the new value.When you don't specify the
WriteAttributes
for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes,WriteAttributes
doesn't return any information. Amazon Cognito only populatesWriteAttributes
in the API response if you have specified your own custom set of write attributes.If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .
(string)
ExplicitAuthFlows -> (list)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
Note
If you don't specify a value forExplicitAuthFlows
, your user client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.Valid values include:
ALLOW_USER_AUTH
: Enable selection-based sign-in withUSER_AUTH
. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without otherExplicitAuthFlows
permitting them. For example users can complete an SRP challenge throughUSER_AUTH
without the flowUSER_SRP_AUTH
being active for the app client. This flow doesn't includeCUSTOM_AUTH
.ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication.ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.In some environments, you will see the values
ADMIN_NO_SRP_AUTH
,CUSTOM_AUTH_FLOW_ONLY
, orUSER_PASSWORD_AUTH
. You can't assign these legacyExplicitAuthFlows
values to user pool clients at the same time as values that begin withALLOW_
, likeALLOW_USER_SRP_AUTH
.(string)
SupportedIdentityProviders -> (list)
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported:
COGNITO
,SignInWithApple
, andLoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for exampleMySAMLIdP
orMyOIDCIdP
.This setting applies to providers that you can access with the hosted UI and OAuth 2.0 authorization server . The removal of
COGNITO
from this list doesn't prevent authentication operations for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to block access with a WAF rule .(string)
CallbackURLs -> (list)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
(string)
LogoutURLs -> (list)
A list of allowed logout URLs for the IdPs.
(string)
DefaultRedirectURI -> (string)
The default redirect URI. Must be in the
CallbackURLs
list.A redirect URI must:
- Be an absolute URI.
- Be registered with the authorization server.
- Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
AllowedOAuthFlows -> (list)
The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add
client_credentials
as the only allowed OAuth flow.codeUse a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint.implicitIssue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentialsIssue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.(string)
AllowedOAuthScopes -> (list)
The OAuth 2.0 scopes that you want your app client to support. Can include standard OAuth scopes like
phone
,openid
, andprofile
. Can also include theaws.cognito.signin.user.admin
scope that authorizes user profile self-service operations and custom scopes from resource servers.(string)
AllowedOAuthFlowsUserPoolClient -> (boolean)
Set to
true
to use OAuth 2.0 features in your user pool app client.AllowedOAuthFlowsUserPoolClient
must betrue
before you can configure the following features in your app client.
CallBackURLs
: Callback URLs.LogoutURLs
: Sign-out redirect URLs.AllowedOAuthScopes
: OAuth 2.0 scopes.AllowedOAuthFlows
: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient
totrue
in aCreateUserPoolClient
orUpdateUserPoolClient
API request. If you don't set a value forAllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults tofalse
.AnalyticsConfiguration -> (structure)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
Note
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.ApplicationId -> (string)
Your Amazon Pinpoint project ID.ApplicationArn -> (string)
The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project thatApplicationArn
declares. You can also configure your application to pass an endpoint ID in theAnalyticsMetadata
parameter of sign-in operations. The endpoint ID is information about the destination for push notificationsRoleArn -> (string)
The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish events to Amazon Pinpoint analytics.ExternalId -> (string)
The external ID of the role that Amazon Cognito assumes to send analytics data to Amazon Pinpoint.UserDataShared -> (boolean)
IfUserDataShared
istrue
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.PreventUserExistenceErrors -> (string)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to
ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs return aUserNotFoundException
exception if the user doesn't exist in the user pool.Valid values include:
ENABLED
- This prevents user existence-related errors.LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.Defaults to
LEGACY
when you don't provide a value.EnableTokenRevocation -> (boolean)
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken .EnablePropagateAdditionalUserContextData -> (boolean)
When
EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts anIpAddress
value that you send in theUserContextData
parameter. TheUserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis. You can sendUserContextData
when you sign in Amazon Cognito native users with theInitiateAuth
andRespondToAuthChallenge
API operations.When
EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations.EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in aContextData
parameter with the authenticated API operationsAdminInitiateAuth
andAdminRespondToAuthChallenge
.You can only activate
EnablePropagateAdditionalUserContextData
in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests .AuthSessionValidity -> (integer)
Amazon Cognito creates a session token for each API request in an authentication flow.AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.