UserPoolClientType
Contains information about a user pool client.
Contents
- AccessTokenValidity
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 86400.
Required: No
- AllowedOAuthFlows
-
The allowed OAuth flows.
- code
-
Use 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. - implicit
-
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
- client_credentials
-
Issue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Valid Values:
code | implicit | client_credentials
Required: No
- AllowedOAuthFlowsUserPoolClient
-
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 Amazon CLI or SDKs, it defaults tofalse
.Type: Boolean
Required: No
-
- AllowedOAuthScopes
-
The OAuth scopes that your app client supports. Possible values that OAuth provides are
phone
,email
,openid
, andprofile
. Possible values that Amazon provides areaws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that you create in Resource Servers.Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\x21\x23-\x5B\x5D-\x7E]+
Required: No
- AnalyticsConfiguration
-
The Amazon Pinpoint analytics configuration for the user pool client.
Note
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
Type: AnalyticsConfigurationType object
Required: No
- AuthSessionValidity
-
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.Type: Integer
Valid Range: Minimum value of 3. Maximum value of 15.
Required: No
- CallbackURLs
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
-
- ClientId
-
The ID of the client associated with the user pool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+]+
Required: No
- ClientName
-
The client name from the user pool request of the client type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w\s+=,.@-]+
Required: No
- ClientSecret
-
The client secret from the user pool request of the client type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w+]+
Required: No
- CreationDate
-
The date and time, in ISO 8601
format, when the item was created. Type: Timestamp
Required: No
- DefaultRedirectURI
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
-
- EnablePropagateAdditionalUserContextData
-
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.Type: Boolean
Required: No
- EnableTokenRevocation
-
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.
Type: Boolean
Required: No
- ExplicitAuthFlows
-
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 for
ExplicitAuthFlows
, your user client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.Valid values include:
-
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
.Type: Array of strings
Valid Values:
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
Required: No
-
- IdTokenValidity
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 86400.
Required: No
- LastModifiedDate
-
The date and time, in ISO 8601
format, when the item was modified. Type: Timestamp
Required: No
- LogoutURLs
-
A list of allowed logout URLs for the IdPs.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
- PreventUserExistenceErrors
-
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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
This setting affects the behavior of following APIs:
Type: String
Valid Values:
LEGACY | ENABLED
Required: No
-
- ReadAttributes
-
The Read-only attributes.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- RefreshTokenValidity
-
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.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 315360000.
Required: No
- SupportedIdentityProviders
-
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
,Facebook
,Google
,SignInWithApple
,LoginWithAmazon
, and the names of your own SAML and OIDC providers.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\p{Z}]+
Required: No
- TokenValidityUnits
-
The time units used to specify the token validity times of each token type: ID, access, and refresh.
Type: TokenValidityUnitsType object
Required: No
- UserPoolId
-
The user pool ID for the user pool client.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: No
- WriteAttributes
-
The writeable attributes.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: