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. 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.
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 for clients in managed login authentication. 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 the ID token when scopes like
openid
andprofile
are requested, directly to your user. - client_credentials
-
Issue the access token from the
/oauth2/token
endpoint directly to a non-person user, authorized by 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 authorization server features in your app client.This parameter must have a value of
true
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 authorization server 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
. Whenfalse
, only SDK-based API sign-in is permitted.Required: No
Type: Boolean
Update requires: No interruption
-
AllowedOAuthScopes
-
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. Scopes govern access control to user pool self-service API operations, user data from the
userInfo
endpoint, and third-party APIs. Scope values includephone
,email
,openid
, andprofile
. Theaws.cognito.signin.user.admin
scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.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.
In AWS Regions where Amazon Pinpoint isn't available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see Using Amazon Pinpoint analytics.
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, or callback, URLs for managed login authentication. These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.
A redirect URI must meet the following requirements:
-
Be an absolute URI.
-
Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with
redirect_uri
values that aren't in the list ofCallbackURLs
that you provide in this parameter. -
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
-
A friendly name for the app client that you want 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.Required: No
Type: String
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Minimum:
1
Maximum:
1024
Update requires: No interruption
EnablePropagateAdditionalUserContextData
-
When
true
, your application can include additionalUserContextData
in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests. If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activateEnablePropagateAdditionalUserContextData
in an app client that has a client secret.Required: No
Type: Boolean
Update requires: No interruption
EnableTokenRevocation
-
Activates or deactivates token revocation.
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 app client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.The values for authentication flow options include the following.
-
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
.To activate this setting, your user pool must be in the Essentials tier or higher.
-
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
-
When
true
, generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types.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. 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.
Required: No
Type: Integer
Minimum:
1
Maximum:
86400
Update requires: No interruption
LogoutURLs
-
A list of allowed logout URLs for managed login authentication. When you pass
logout_uri
andclient_id
parameters to/logout
, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets oflogout_uri
. A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint.Required: No
Type: Array of String
Minimum:
0
Maximum:
100
Update requires: No interruption
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.
Defaults to
LEGACY
when you don't provide a value.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.
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. 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.
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
.This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of
COGNITO
from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a AWS WAF rule.Required: No
Type: Array of String
Update requires: No interruption
TokenValidityUnits
-
The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
Required: No
Type: TokenValidityUnits
Update requires: No interruption
UserPoolId
-
The ID of the user pool where you want to create an app 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.
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
.
Examples
Creating a new app client for a user pool
The following example creates an app client with analytics, custom scopes, OAuth services, and third-party identity providers. An app client with this configuration is used with managed login.
JSON
{ "UserPoolClient": { "Properties": { "AccessTokenValidity": 30, "AllowedOAuthFlows": [ "code", "implicit" ], "AllowedOAuthFlowsUserPoolClient": true, "AllowedOAuthScopes": [ "openid", "profile", "email", "myapi.example.com/international.read", "myapi.example.com/domestic.read" ], "AnalyticsConfiguration": { "ApplicationArn": "arn:aws:mobiletargeting:us-west-2:123456789012:apps/d70b2ba36a8c4dc5a04a0451aEXAMPLE", "UserDataShared": true }, "AuthSessionValidity": 9, "CallbackURLs": [ "https://www.example.com", "myapp://example" ], "ClientName": "my-test-app-client", "DefaultRedirectURI": "https://www.example.com", "EnablePropagateAdditionalUserContextData": true, "EnableTokenRevocation": true, "ExplicitAuthFlows": [ "ALLOW_USER_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "GenerateSecret": true, "IdTokenValidity": 30, "LogoutURLs": [ "https://www.example.com/logout", "http://localhost:8080" ], "PreventUserExistenceErrors": "ENABLED", "ReadAttributes": [ "email", "phone_number", "oidc:profile", "custom:department" ], "RefreshTokenValidity": 10, "SupportedIdentityProviders": [ "Google", "LoginWithAmazon", "SignInWithApple", "Facebook", "MYSSO" ], "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "UserPoolId": "us-west-2_EXAMPLE", "WriteAttributes": [ "email", "oidc:profile", "custom:department" ] }, "Type": "AWS::Cognito::UserPoolClient" } }
YAML
UserPoolClient: Type: AWS::Cognito::UserPoolClient Properties: AccessTokenValidity: 30 AllowedOAuthFlows: - code - implicit AllowedOAuthFlowsUserPoolClient: true AllowedOAuthScopes: - openid - profile - email - myapi.example.com/international.read - myapi.example.com/domestic.read AnalyticsConfiguration: ApplicationArn: arn:aws:mobiletargeting:us-west-2:123456789012:apps/d70b2ba36a8c4dc5a04a0451aEXAMPLE UserDataShared: true AuthSessionValidity: 9 CallbackURLs: - https://www.example.com - myapp://example ClientName: my-test-app-client DefaultRedirectURI: https://www.example.com EnablePropagateAdditionalUserContextData: true EnableTokenRevocation: true ExplicitAuthFlows: - ALLOW_USER_AUTH - ALLOW_ADMIN_USER_PASSWORD_AUTH - ALLOW_USER_PASSWORD_AUTH - ALLOW_REFRESH_TOKEN_AUTH GenerateSecret: true IdTokenValidity: 30 LogoutURLs: - https://www.example.com/logout - http://localhost:8080 PreventUserExistenceErrors: ENABLED ReadAttributes: - email - phone_number - oidc:profile - custom:department RefreshTokenValidity: 10 SupportedIdentityProviders: - Google - LoginWithAmazon - SignInWithApple - Facebook - MYSSO TokenValidityUnits: AccessToken: minutes IdToken: minutes RefreshToken: days UserPoolId: us-west-2_EXAMPLE WriteAttributes: - email - oidc:profile - custom:111