CreateUserPoolClient
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.
Request Syntax
{
"AccessTokenValidity": number
,
"AllowedOAuthFlows": [ "string
" ],
"AllowedOAuthFlowsUserPoolClient": boolean
,
"AllowedOAuthScopes": [ "string
" ],
"AnalyticsConfiguration": {
"ApplicationArn": "string
",
"ApplicationId": "string
",
"ExternalId": "string
",
"RoleArn": "string
",
"UserDataShared": boolean
},
"CallbackURLs": [ "string
" ],
"ClientName": "string
",
"DefaultRedirectURI": "string
",
"EnablePropagateAdditionalUserContextData": boolean
,
"EnableTokenRevocation": boolean
,
"ExplicitAuthFlows": [ "string
" ],
"GenerateSecret": boolean
,
"IdTokenValidity": number
,
"LogoutURLs": [ "string
" ],
"PreventUserExistenceErrors": "string
",
"ReadAttributes": [ "string
" ],
"RefreshTokenValidity": number
,
"SupportedIdentityProviders": [ "string
" ],
"TokenValidityUnits": {
"AccessToken": "string
",
"IdToken": "string
",
"RefreshToken": "string
"
},
"UserPoolId": "string
",
"WriteAttributes": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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.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 if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
Type: Boolean
Required: No
- AllowedOAuthScopes
-
The allowed OAuth scopes. Possible values provided by OAuth are
phone
,email
,openid
, andprofile
. Possible values provided by Amazon areaws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.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 user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
Note In Amazon Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
Type: AnalyticsConfigurationType object
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
-
- ClientName
-
The client name for the user pool client you would like to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w\s+=,.@-]+
Required: Yes
- 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
-
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 activate
EnablePropagateAdditionalUserContextData
in an app client that has a client secret.Type: Boolean
Required: No
- EnableTokenRevocation
-
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.
Type: Boolean
Required: No
- ExplicitAuthFlows
-
The authentication flows that are supported by the user pool clients. Flow names without the
ALLOW_
prefix are no longer supported, in favor of new names with theALLOW_
prefix.Note Values with
ALLOW_
prefix must be used only along with theALLOW_
prefix.Valid values include:
- ALLOW_ADMIN_USER_PASSWORD_AUTH
-
Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords. - ALLOW_CUSTOM_AUTH
-
Enable Amazon 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 the authflow that refreshes tokens.
If you don't specify a value for
ExplicitAuthFlows
, your user client supportsALLOW_USER_SRP_AUTH
andALLOW_CUSTOM_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
- GenerateSecret
-
Boolean to specify whether you want to generate a secret for the user pool client being created.
Type: Boolean
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
AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 86400.
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 early 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 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.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 315360000.
Required: No
- SupportedIdentityProviders
-
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported:
COGNITO
,Facebook
,Google
,SignInWithApple
, andLoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for exampleMySAMLIdP
orMyOIDCIdP
.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}]+
Required: No
- TokenValidityUnits
-
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.
Type: TokenValidityUnitsType object
Required: No
- UserPoolId
-
The user pool ID for the user pool where you want to create a user pool client.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
- WriteAttributes
-
The user pool attributes that the app client can write to.
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.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax
{
"UserPoolClient": {
"AccessTokenValidity": number,
"AllowedOAuthFlows": [ "string" ],
"AllowedOAuthFlowsUserPoolClient": boolean,
"AllowedOAuthScopes": [ "string" ],
"AnalyticsConfiguration": {
"ApplicationArn": "string",
"ApplicationId": "string",
"ExternalId": "string",
"RoleArn": "string",
"UserDataShared": boolean
},
"CallbackURLs": [ "string" ],
"ClientId": "string",
"ClientName": "string",
"ClientSecret": "string",
"CreationDate": number,
"DefaultRedirectURI": "string",
"EnablePropagateAdditionalUserContextData": boolean,
"EnableTokenRevocation": boolean,
"ExplicitAuthFlows": [ "string" ],
"IdTokenValidity": number,
"LastModifiedDate": number,
"LogoutURLs": [ "string" ],
"PreventUserExistenceErrors": "string",
"ReadAttributes": [ "string" ],
"RefreshTokenValidity": number,
"SupportedIdentityProviders": [ "string" ],
"TokenValidityUnits": {
"AccessToken": "string",
"IdToken": "string",
"RefreshToken": "string"
},
"UserPoolId": "string",
"WriteAttributes": [ "string" ]
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UserPoolClient
-
The user pool client that was just created.
Type: UserPoolClientType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidOAuthFlowException
-
This exception is thrown when the specified OAuth flow is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- LimitExceededException
-
This exception is thrown when a user exceeds the limit for a requested Amazon resource.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- ScopeDoesNotExistException
-
This exception is thrown when the specified scope doesn't exist.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: