Skip to main content

user_pool_clients

Creates, updates, deletes, gets or lists a user_pool_clients resource.

Overview​

Nameuser_pool_clients
TypeResource
Idaws.cognito_idp.user_pool_clients

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
access_token_validityintegerThe access token time limit. 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.
allowed_o_auth_flowsarrayThe 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.
allowed_o_auth_flows_user_pool_clientbooleanSet 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 to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults to false. When false, only SDK-based API sign-in is permitted.
allowed_o_auth_scopesarrayThe OAuth 2.0 scopes that you want your app client to support. Can include standard OAuth scopes like phone, email, openid, and profile. Can also include the aws.cognito.signin.user.admin scope that authorizes user profile self-service operations and custom scopes from resource servers.
analytics_configurationobjectThe user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
auth_session_validityintegerAmazon 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.
callback_urlsarrayA 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 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.
client_idstringThe ID of the app client. (pattern: <code>[\w+]+</code>)
client_namestringThe name of the app client. (pattern: <code>[\w\s+=,.@-]+</code>)
client_secretstringThe app client secret. (pattern: <code>[\w+]+</code>)
creation_datestring (date-time)The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
default_redirect_uristringThe 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 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. (pattern: <code>[\p{L}\p{M}\p{S}\p{N}\p{P}]+</code>)
enable_propagate_additional_user_context_databooleanWhen EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito threat protection for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations. When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito threat protection with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge. 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.
enable_token_revocationbooleanIndicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default.
explicit_auth_flowsarrayThe 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. If you don't specify a value for ExplicitAuthFlows, your app client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH. The values for authentication flow options include the following. ALLOW_USER_AUTH: Enable selection-based sign-in with USER_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 other ExplicitAuthFlows permitting them. For example users can complete an SRP challenge through USER_AUTH without the flow USER_SRP_AUTH being active for the app client. This flow doesn't include CUSTOM_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 flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_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, 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.
id_token_validityintegerThe ID token time limit. 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.
last_modified_datestring (date-time)The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
logout_urlsarrayA list of allowed logout URLs for the IdPs.
prevent_user_existence_errorsstringWhen ENABLED, suppresses messages that might indicate a valid user exists when someone attempts sign-in. This parameters sets your preference for the 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 to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool. Defaults to LEGACY. (LEGACY, ENABLED)
read_attributesarrayThe 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. 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.
refresh_token_rotationobjectThe configuration of your app client for refresh token rotation. 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.
refresh_token_validityintegerThe refresh token time limit. 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.
supported_identity_providersarrayA list of provider names for the identity providers (IdPs) that are supported on this client. 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 Amazon Web Services SDK. The only way to prevent SDK-based authentication is to block access with a WAF rule.
token_validity_unitsobjectThe time units that, with IdTokenValidity, AccessTokenValidity, and RefreshTokenValidity, set and display the duration of ID, access, and refresh tokens for an app client. You can assign a separate token validity unit to each type of token.
user_pool_idstringThe ID of the user pool associated with the app client. (pattern: <code>[\w-]+_[0-9a-zA-Z]+</code>)
write_attributesarrayThe 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 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.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_user_pool_clientselectregionGiven an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
list_user_pool_clientsselectregionGiven a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more information, see App clients. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
create_user_pool_clientinsertregion, UserPoolId, ClientNameCreates an app client in a user pool. This operation sets basic and advanced configuration options. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
update_user_pool_clientupdateregion, UserPoolId, ClientIdGiven a user pool app client ID, updates the configuration. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your app client, modified to include the changes that you want to make. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
delete_user_pool_clientdeleteregionDeletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

SELECT
access_token_validity,
allowed_o_auth_flows,
allowed_o_auth_flows_user_pool_client,
allowed_o_auth_scopes,
analytics_configuration,
auth_session_validity,
callback_urls,
client_id,
client_name,
client_secret,
creation_date,
default_redirect_uri,
enable_propagate_additional_user_context_data,
enable_token_revocation,
explicit_auth_flows,
id_token_validity,
last_modified_date,
logout_urls,
prevent_user_existence_errors,
read_attributes,
refresh_token_rotation,
refresh_token_validity,
supported_identity_providers,
token_validity_units,
user_pool_id,
write_attributes
FROM aws.cognito_idp.user_pool_clients
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an app client in a user pool. This operation sets basic and advanced configuration options. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

INSERT INTO aws.cognito_idp.user_pool_clients (
UserPoolId,
ClientName,
GenerateSecret,
ClientSecret,
RefreshTokenValidity,
AccessTokenValidity,
IdTokenValidity,
TokenValidityUnits,
ReadAttributes,
WriteAttributes,
ExplicitAuthFlows,
SupportedIdentityProviders,
CallbackURLs,
LogoutURLs,
DefaultRedirectURI,
AllowedOAuthFlows,
AllowedOAuthScopes,
AllowedOAuthFlowsUserPoolClient,
AnalyticsConfiguration,
PreventUserExistenceErrors,
EnableTokenRevocation,
EnablePropagateAdditionalUserContextData,
AuthSessionValidity,
RefreshTokenRotation,
region
)
SELECT 
'{{ UserPoolId }}' /* required */,
'{{ ClientName }}' /* required */,
{{ GenerateSecret }},
'{{ ClientSecret }}',
{{ RefreshTokenValidity }},
{{ AccessTokenValidity }},
{{ IdTokenValidity }},
'{{ TokenValidityUnits }}',
'{{ ReadAttributes }}',
'{{ WriteAttributes }}',
'{{ ExplicitAuthFlows }}',
'{{ SupportedIdentityProviders }}',
'{{ CallbackURLs }}',
'{{ LogoutURLs }}',
'{{ DefaultRedirectURI }}',
'{{ AllowedOAuthFlows }}',
'{{ AllowedOAuthScopes }}',
{{ AllowedOAuthFlowsUserPoolClient }},
'{{ AnalyticsConfiguration }}',
'{{ PreventUserExistenceErrors }}',
{{ EnableTokenRevocation }},
{{ EnablePropagateAdditionalUserContextData }},
{{ AuthSessionValidity }},
'{{ RefreshTokenRotation }}',
'{{ region }}'
RETURNING
user_pool_client
;

UPDATE examples​

Given a user pool app client ID, updates the configuration. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your app client, modified to include the changes that you want to make. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

UPDATE aws.cognito_idp.user_pool_clients
SET 
UserPoolId = '{{ UserPoolId }}',
ClientId = '{{ ClientId }}',
ClientName = '{{ ClientName }}',
RefreshTokenValidity = {{ RefreshTokenValidity }},
AccessTokenValidity = {{ AccessTokenValidity }},
IdTokenValidity = {{ IdTokenValidity }},
TokenValidityUnits = '{{ TokenValidityUnits }}',
ReadAttributes = '{{ ReadAttributes }}',
WriteAttributes = '{{ WriteAttributes }}',
ExplicitAuthFlows = '{{ ExplicitAuthFlows }}',
SupportedIdentityProviders = '{{ SupportedIdentityProviders }}',
CallbackURLs = '{{ CallbackURLs }}',
LogoutURLs = '{{ LogoutURLs }}',
DefaultRedirectURI = '{{ DefaultRedirectURI }}',
AllowedOAuthFlows = '{{ AllowedOAuthFlows }}',
AllowedOAuthScopes = '{{ AllowedOAuthScopes }}',
AllowedOAuthFlowsUserPoolClient = {{ AllowedOAuthFlowsUserPoolClient }},
AnalyticsConfiguration = '{{ AnalyticsConfiguration }}',
PreventUserExistenceErrors = '{{ PreventUserExistenceErrors }}',
EnableTokenRevocation = {{ EnableTokenRevocation }},
EnablePropagateAdditionalUserContextData = {{ EnablePropagateAdditionalUserContextData }},
AuthSessionValidity = {{ AuthSessionValidity }},
RefreshTokenRotation = '{{ RefreshTokenRotation }}'
WHERE 
region = '{{ region }}' --required
AND UserPoolId = '{{ UserPoolId }}' --required
AND ClientId = '{{ ClientId }}' --required
RETURNING
user_pool_client;

DELETE examples​

Deletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.

DELETE FROM aws.cognito_idp.user_pool_clients
WHERE region = '{{ region }}' --required
;
Last updated on