AWS::Cognito::UserPoolClient
The AWS::Cognito::UserPoolClient
resource specifies an Amazon Cognito user
pool client.
Note
If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Cognito::UserPoolClient", "Properties" : { "AccessTokenValidity" :
Integer
, "AllowedOAuthFlows" :[ String, ... ]
, "AllowedOAuthFlowsUserPoolClient" :Boolean
, "AllowedOAuthScopes" :[ String, ... ]
, "AnalyticsConfiguration" :AnalyticsConfiguration
, "AuthSessionValidity" :Integer
, "CallbackURLs" :[ String, ... ]
, "ClientName" :String
, "DefaultRedirectURI" :String
, "EnablePropagateAdditionalUserContextData" :Boolean
, "EnableTokenRevocation" :Boolean
, "ExplicitAuthFlows" :[ String, ... ]
, "GenerateSecret" :Boolean
, "IdTokenValidity" :Integer
, "LogoutURLs" :[ String, ... ]
, "PreventUserExistenceErrors" :String
, "ReadAttributes" :[ String, ... ]
, "RefreshTokenValidity" :Integer
, "SupportedIdentityProviders" :[ String, ... ]
, "TokenValidityUnits" :TokenValidityUnits
, "UserPoolId" :String
, "WriteAttributes" :[ String, ... ]
} }
YAML
Type: AWS::Cognito::UserPoolClient Properties: AccessTokenValidity:
Integer
AllowedOAuthFlows:- String
AllowedOAuthFlowsUserPoolClient:Boolean
AllowedOAuthScopes:- String
AnalyticsConfiguration:AnalyticsConfiguration
AuthSessionValidity:Integer
CallbackURLs:- String
ClientName:String
DefaultRedirectURI:String
EnablePropagateAdditionalUserContextData:Boolean
EnableTokenRevocation:Boolean
ExplicitAuthFlows:- String
GenerateSecret:Boolean
IdTokenValidity:Integer
LogoutURLs:- String
PreventUserExistenceErrors:String
ReadAttributes:- String
RefreshTokenValidity:Integer
SupportedIdentityProviders:- String
TokenValidityUnits:TokenValidityUnits
UserPoolId:String
WriteAttributes:- String
Properties
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.Required: No
Type: Integer
Minimum:
1
Maximum:
86400
Update requires: No interruption
AllowedOAuthFlows
-
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.- 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.
Required: No
Type: Array of String
Minimum:
0
Maximum:
3
Update requires: No interruption
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 AWS CLI or SDKs, it defaults tofalse
.Required: No
Type: Boolean
Update requires: No interruption
-
AllowedOAuthScopes
-
The allowed OAuth scopes. Possible values provided by OAuth are
phone
,email
,openid
, andprofile
. Possible values provided by AWS areaws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.Required: No
Type: Array of String
Maximum:
50
Update requires: No interruption
AnalyticsConfiguration
-
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
Note
In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
Required: No
Type: AnalyticsConfiguration
Update requires: No interruption
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.Required: No
Type: Integer
Minimum:
3
Maximum:
15
Update requires: No interruption
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.
Required: No
Type: Array of String
Minimum:
0
Maximum:
100
Update requires: No interruption
-
ClientName
-
The client name for the user pool client you would like to create.
Required: No
Type: String
Minimum:
1
Maximum:
128
Update requires: No interruption
DefaultRedirectURI
-
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.
Required: No
Type: String
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Minimum:
1
Maximum:
1024
Update requires: No interruption
-
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.Required: No
Type: Boolean
Update requires: No interruption
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.
Required: No
Type: Boolean
Update requires: No interruption
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
.Required: No
Type: Array of String
Update requires: No interruption
-
GenerateSecret
-
Boolean to specify whether you want to generate a secret for the user pool client being created.
Required: No
Type: Boolean
Update requires: Replacement
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.Required: No
Type: Integer
Minimum:
1
Maximum:
86400
Update requires: No interruption
LogoutURLs
-
A list of allowed logout URLs for the IdPs.
Required: No
Type: Array of String
Minimum:
0
Maximum:
100
Update requires: No interruption
PreventUserExistenceErrors
-
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to
ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs will return aUserNotFoundException
exception if the user does not exist in the user pool.Required: No
Type: String
Allowed values:
LEGACY | ENABLED
Update requires: No interruption
ReadAttributes
-
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.Required: No
Type: Array of String
Update requires: No interruption
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.Required: No
Type: Integer
Minimum:
1
Maximum:
315360000
Update requires: No interruption
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
.Required: No
Type: Array of String
Update requires: No interruption
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.
Required: No
Type: TokenValidityUnits
Update requires: No interruption
UserPoolId
-
The user pool ID for the user pool where you want to create a user pool client.
Required: Yes
Type: String
Pattern:
[\w-]+_[0-9a-zA-Z]+
Minimum:
1
Maximum:
55
Update requires: Replacement
WriteAttributes
-
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.
Required: No
Type: Array of String
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the Amazon Cognito user pool client ID, such as
1h57kf5cpq17m0eml12EXAMPLE
.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
ClientId
-
The ID of the app client, for example
1example23456789
.