Documentation

Contains information about a user pool client.

See: newUserPoolClientType smart constructor.

Create a value of UserPoolClientType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:refreshTokenValidity:UserPoolClientType', userPoolClientType_refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.

$sel:clientId:UserPoolClientType', userPoolClientType_clientId - The ID of the client associated with the user pool.

$sel:explicitAuthFlows:UserPoolClientType', userPoolClientType_explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

• 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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
• ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
• ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.

$sel:clientSecret:UserPoolClientType', userPoolClientType_clientSecret - The client secret from the user pool request of the client type.

$sel:lastModifiedDate:UserPoolClientType', userPoolClientType_lastModifiedDate - The date the user pool client was last modified.

$sel:supportedIdentityProviders:UserPoolClientType', userPoolClientType_supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.

$sel:logoutURLs:UserPoolClientType', userPoolClientType_logoutURLs - A list of allowed logout URLs for the identity providers.

$sel:allowedOAuthFlowsUserPoolClient:UserPoolClientType', userPoolClientType_allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

$sel:userPoolId:UserPoolClientType', userPoolClientType_userPoolId - The user pool ID for the user pool client.

$sel:idTokenValidity:UserPoolClientType', userPoolClientType_idTokenValidity - The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.

$sel:tokenValidityUnits:UserPoolClientType', userPoolClientType_tokenValidityUnits - The time units used to specify the token validity times of their respective token.

$sel:defaultRedirectURI:UserPoolClientType', userPoolClientType_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.

$sel:enableTokenRevocation:UserPoolClientType', userPoolClientType_enableTokenRevocation - Indicates whether token revocation is enabled for the user pool client. When you create a new user pool client, token revocation is enabled by default. For more information about revoking tokens, see RevokeToken.

$sel:writeAttributes:UserPoolClientType', userPoolClientType_writeAttributes - The writeable attributes.

$sel:preventUserExistenceErrors:UserPoolClientType', userPoolClientType_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 to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

• ENABLED - This prevents user existence-related errors.
• LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

$sel:accessTokenValidity:UserPoolClientType', userPoolClientType_accessTokenValidity - The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.

$sel:creationDate:UserPoolClientType', userPoolClientType_creationDate - The date the user pool client was created.

$sel:readAttributes:UserPoolClientType', userPoolClientType_readAttributes - The Read-only attributes.

$sel:allowedOAuthScopes:UserPoolClientType', userPoolClientType_allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

$sel:allowedOAuthFlows:UserPoolClientType', userPoolClientType_allowedOAuthFlows - The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

$sel:analyticsConfiguration:UserPoolClientType', userPoolClientType_analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

$sel:clientName:UserPoolClientType', userPoolClientType_clientName - The client name from the user pool request of the client type.

$sel:callbackURLs:UserPoolClientType', userPoolClientType_callbackURLs - A list of allowed redirect (callback) URLs for the identity providers.

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.

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

The ID of the client associated with the user pool.

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

• 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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
• ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
• ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.

The client secret from the user pool request of the client type.

The date the user pool client was last modified.

A list of provider names for the identity providers that are supported on this client.

A list of allowed logout URLs for the identity providers.

Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

The user pool ID for the user pool client.

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.

The time units used to specify the token validity times of their respective token.

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.

Indicates whether token revocation is enabled for the user pool client. When you create a new user pool client, token revocation is enabled by default. For more information about revoking tokens, see RevokeToken.

The writeable attributes.

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 to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

• ENABLED - This prevents user existence-related errors.
• LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.

The date the user pool client was created.

The Read-only attributes.

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

The allowed OAuth flows.

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

The Amazon Pinpoint analytics configuration for the user pool client.

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

The client name from the user pool request of the client type.

A list of allowed redirect (callback) URLs for the identity providers.

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.