CfnUserPoolClientProps Struct
Properties for defining a CfnUserPoolClient.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cfnUserPoolClientProps: cognito.CfnUserPoolClientProps = {
userPoolId: 'userPoolId',
// the properties below are optional
accessTokenValidity: 123,
allowedOAuthFlows: ['allowedOAuthFlows'],
allowedOAuthFlowsUserPoolClient: false,
allowedOAuthScopes: ['allowedOAuthScopes'],
analyticsConfiguration: {
applicationArn: 'applicationArn',
applicationId: 'applicationId',
externalId: 'externalId',
roleArn: 'roleArn',
userDataShared: false,
},
authSessionValidity: 123,
callbackUrLs: ['callbackUrLs'],
clientName: 'clientName',
defaultRedirectUri: 'defaultRedirectUri',
enablePropagateAdditionalUserContextData: false,
enableTokenRevocation: false,
explicitAuthFlows: ['explicitAuthFlows'],
generateSecret: false,
idTokenValidity: 123,
logoutUrLs: ['logoutUrLs'],
preventUserExistenceErrors: 'preventUserExistenceErrors',
readAttributes: ['readAttributes'],
refreshTokenRotation: {
feature: 'feature',
retryGracePeriodSeconds: 123,
},
refreshTokenValidity: 123,
supportedIdentityProviders: ['supportedIdentityProviders'],
tokenValidityUnits: {
accessToken: 'accessToken',
idToken: 'idToken',
refreshToken: 'refreshToken',
},
writeAttributes: ['writeAttributes'],
};
Properties
accessTokenValiditynumberaccess_token_validityint | floataccessTokenValidityNumberAccessTokenValiditydoubleAccessTokenValidity*float64#notes
After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours , 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.
allowedOAuthFlowsstring[]allowed_o_auth_flowstyping.List[str]allowedOAuthFlowsList<String>AllowedOAuthFlowsstring[]AllowedOAuthFlows*[]*string#notes
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/tokenendpoint. - implicit - Issue the access token, and the ID token when scopes like
openidandprofileare requested, directly to your user. - client_credentials - Issue the access token from the
/oauth2/tokenendpoint directly to a non-person user, authorized by a combination of the client ID and client secret.
allowedOAuthFlowsUserPoolClientboolean | IResolvableallowed_o_auth_flows_user_pool_clienttyping.Union[bool, IResolvable]allowedOAuthFlowsUserPoolClientBooleanAllowedOAuthFlowsUserPoolClientboolAllowedOAuthFlowsUserPoolClientinterface{}#notes
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 to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the AWS CLI or SDKs, it defaults to false . When false , only SDK-based API sign-in is permitted.
allowedOAuthScopesstring[]allowed_o_auth_scopestyping.List[str]allowedOAuthScopesList<String>AllowedOAuthScopesstring[]AllowedOAuthScopes*[]*string#notes
Scopes govern access control to user pool self-service API operations, user data from the userInfo endpoint, and third-party APIs. Scope values include phone , email , openid , and profile . The aws.cognito.signin.user.admin scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.
analyticsConfigurationIResolvable | CfnUserPoolClient.AnalyticsConfigurationPropertyanalytics_configurationtyping.Union[IResolvable, AnalyticsConfigurationProperty]analyticsConfigurationIResolvableAnalyticsConfigurationIResolvableAnalyticsConfigurationinterface{}#notes
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 .
authSessionValiditynumberauth_session_validityint | floatauthSessionValidityNumberAuthSessionValiditydoubleAuthSessionValidity*float64#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.
callbackUrLsstring[]callback_ur_lstyping.List[str]callbackUrLsList<String>CallbackUrLsstring[]CallbackUrLs*[]*string#notes
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_urivalues that aren't in the list ofCallbackURLsthat you provide in this parameter. - Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for callback URLs to http://localhost , http://127.0.0.1 and http://[::1] . These callback URLs are for testing purposes only. You can specify custom TCP ports for your callback URLs.
App callback URLs such as myapp://example are also supported.
defaultRedirectUristringdefault_redirect_uristrdefaultRedirectUriStringDefaultRedirectUristringDefaultRedirectUri*string#In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.
enablePropagateAdditionalUserContextDataboolean | IResolvableenable_propagate_additional_user_context_datatyping.Union[bool, IResolvable]enablePropagateAdditionalUserContextDataBooleanEnablePropagateAdditionalUserContextDataboolEnablePropagateAdditionalUserContextDatainterface{}#notes
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 activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
enableTokenRevocationboolean | IResolvableenable_token_revocationtyping.Union[bool, IResolvable]enableTokenRevocationBooleanEnableTokenRevocationboolEnableTokenRevocationinterface{}#If you don't include this parameter, token revocation is automatically activated for the new user pool client.
explicitAuthFlowsstring[]explicit_auth_flowstyping.List[str]explicitAuthFlowsList<String>ExplicitAuthFlowsstring[]ExplicitAuthFlows*[]*string#notes
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 otherExplicitAuthFlowspermitting them. For example users can complete an SRP challenge throughUSER_AUTHwithout the flowUSER_SRP_AUTHbeing 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_AUTHsetting. 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 , or USER_PASSWORD_AUTH . You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_ , like ALLOW_USER_SRP_AUTH .
generateSecretboolean | IResolvablegenerate_secrettyping.Union[bool, IResolvable]generateSecretBooleanGenerateSecretboolGenerateSecretinterface{}#notes
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 .
idTokenValiditynumberid_token_validityint | floatidTokenValidityNumberIdTokenValiditydoubleIdTokenValidity*float64#notes
After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours , 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.
logoutUrLsstring[]logout_ur_lstyping.List[str]logoutUrLsList<String>LogoutUrLsstring[]LogoutUrLs*[]*string#notes
When you pass logout_uri and client_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 of logout_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 .
preventUserExistenceErrorsstringprevent_user_existence_errorsstrpreventUserExistenceErrorsStringPreventUserExistenceErrorsstringPreventUserExistenceErrors*string#notes
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 to LEGACY , those APIs return a UserNotFoundException 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.
readAttributesstring[]read_attributestyping.List[str]readAttributesList<String>ReadAttributesstring[]ReadAttributes*[]*string#notes
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 of email_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 populates ReadAttributes in the API response if you have specified your own custom set of read attributes.
refreshTokenRotationIResolvable | CfnUserPoolClient.RefreshTokenRotationPropertyrefresh_token_rotationtyping.Union[IResolvable, RefreshTokenRotationProperty]refreshTokenRotationIResolvableRefreshTokenRotationIResolvableRefreshTokenRotationinterface{}#When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.
refreshTokenValiditynumberrefresh_token_validityint | floatrefreshTokenValidityNumberRefreshTokenValiditydoubleRefreshTokenValidity*float64#notes
After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds , minutes , hours , or days , set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days , 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 set RefreshTokenValidity 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.
supportedIdentityProvidersstring[]supported_identity_providerstyping.List[str]supportedIdentityProvidersList<String>SupportedIdentityProvidersstring[]SupportedIdentityProviders*[]*string#notes
The following are supported: COGNITO , Facebook , Google , SignInWithApple , and LoginWithAmazon . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP .
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 .
tokenValidityUnitsIResolvable | CfnUserPoolClient.TokenValidityUnitsPropertytoken_validity_unitstyping.Union[IResolvable, TokenValidityUnitsProperty]tokenValidityUnitsIResolvableTokenValidityUnitsIResolvableTokenValidityUnitsinterface{}#The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
userPoolIdstring | IUserPoolRefuser_pool_idtyping.Union[str, IUserPoolRef]userPoolIdStringUserPoolIdstringUserPoolIdinterface{}required#writeAttributesstring[]write_attributestyping.List[str]writeAttributesList<String>WriteAttributesstring[]WriteAttributes*[]*string#notes
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 populates WriteAttributes 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 .