CfnUserPoolClientProps

class aws_cdk.aws_cognito.CfnUserPoolClientProps(*, user_pool_id, access_token_validity=None, allowed_o_auth_flows=None, allowed_o_auth_flows_user_pool_client=None, allowed_o_auth_scopes=None, analytics_configuration=None, callback_ur_ls=None, client_name=None, default_redirect_uri=None, enable_token_revocation=None, explicit_auth_flows=None, generate_secret=None, id_token_validity=None, logout_ur_ls=None, prevent_user_existence_errors=None, read_attributes=None, refresh_token_validity=None, supported_identity_providers=None, token_validity_units=None, write_attributes=None)

Bases: object

Properties for defining a CfnUserPoolClient.

Parameters
  • user_pool_id (str) – The user pool ID for the user pool where you want to create a user pool client.

  • access_token_validity (Union[int, float, None]) – The time limit, after which the access token is no longer valid and cannot be used.

  • allowed_o_auth_flows (Optional[Sequence[str]]) – 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.

  • allowed_o_auth_flows_user_pool_client (Union[bool, IResolvable, None]) – Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

  • allowed_o_auth_scopes (Optional[Sequence[str]]) – The allowed OAuth scopes. Possible values provided by OAuth are: phone , email , openid , and profile . Possible values provided by AWS are: aws.cognito.signin.user.admin . Custom scopes created in Resource Servers are also supported.

  • analytics_configuration (Union[IResolvable, AnalyticsConfigurationProperty, None]) – The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. .. epigraph:: In AWS Regions where isn’t available, User Pools only supports sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region.

  • callback_ur_ls (Optional[Sequence[str]]) – 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.

  • client_name (Optional[str]) – The client name for the user pool client you would like to create.

  • default_redirect_uri (Optional[str]) –

    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.

  • enable_token_revocation (Union[bool, IResolvable, None]) – 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.

  • explicit_auth_flows (Optional[Sequence[str]]) – The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords. - ALLOW_CUSTOM_AUTH : Enable AWS 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.

  • generate_secret (Union[bool, IResolvable, None]) – Boolean to specify whether you want to generate a secret for the user pool client being created.

  • id_token_validity (Union[int, float, None]) – The time limit, after which the ID token is no longer valid and cannot be used.

  • logout_ur_ls (Optional[Sequence[str]]) – A list of allowed logout URLs for the identity providers.

  • prevent_user_existence_errors (Optional[str]) – 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.

  • read_attributes (Optional[Sequence[str]]) – The read attributes.

  • refresh_token_validity (Union[int, float, None]) – The time limit, in days, after which the refresh token is no longer valid and can’t be used.

  • supported_identity_providers (Optional[Sequence[str]]) – A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO , Facebook , SignInWithApple , Google and LoginWithAmazon .

  • token_validity_units (Union[IResolvable, TokenValidityUnitsProperty, None]) – The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

  • write_attributes (Optional[Sequence[str]]) – The user pool attributes that the app client can write to. If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cognito as cognito

cfn_user_pool_client_props = cognito.CfnUserPoolClientProps(
    user_pool_id="userPoolId",

    # the properties below are optional
    access_token_validity=123,
    allowed_oAuth_flows=["allowedOAuthFlows"],
    allowed_oAuth_flows_user_pool_client=False,
    allowed_oAuth_scopes=["allowedOAuthScopes"],
    analytics_configuration=cognito.CfnUserPoolClient.AnalyticsConfigurationProperty(
        application_arn="applicationArn",
        application_id="applicationId",
        external_id="externalId",
        role_arn="roleArn",
        user_data_shared=False
    ),
    callback_ur_ls=["callbackUrLs"],
    client_name="clientName",
    default_redirect_uri="defaultRedirectUri",
    enable_token_revocation=False,
    explicit_auth_flows=["explicitAuthFlows"],
    generate_secret=False,
    id_token_validity=123,
    logout_ur_ls=["logoutUrLs"],
    prevent_user_existence_errors="preventUserExistenceErrors",
    read_attributes=["readAttributes"],
    refresh_token_validity=123,
    supported_identity_providers=["supportedIdentityProviders"],
    token_validity_units=cognito.CfnUserPoolClient.TokenValidityUnitsProperty(
        access_token="accessToken",
        id_token="idToken",
        refresh_token="refreshToken"
    ),
    write_attributes=["writeAttributes"]
)

Attributes

access_token_validity

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-accesstokenvalidity

Return type

Union[int, float, None]

allowed_o_auth_flows

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflows

Return type

Optional[List[str]]

allowed_o_auth_flows_user_pool_client

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthflowsuserpoolclient

Return type

Union[bool, IResolvable, None]

allowed_o_auth_scopes

The allowed OAuth scopes.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-allowedoauthscopes

Return type

Optional[List[str]]

analytics_configuration

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

In AWS Regions where isn’t available, User Pools only supports sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-analyticsconfiguration

Return type

Union[IResolvable, AnalyticsConfigurationProperty, None]

callback_ur_ls

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-callbackurls

Return type

Optional[List[str]]

client_name

The client name for the user pool client you would like to create.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-clientname

Return type

Optional[str]

default_redirect_uri

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-defaultredirecturi

Return type

Optional[str]

enable_token_revocation

//docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html>`_ .

If you don’t include this parameter, token revocation is automatically activated for the new user pool client.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-enabletokenrevocation

Type

Activates or deactivates token revocation. For more information about revoking tokens, see `RevokeToken <https

Return type

Union[bool, IResolvable, None]

explicit_auth_flows

The authentication flows that are supported by the user pool clients.

Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH : Enable AWS 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-explicitauthflows

Return type

Optional[List[str]]

generate_secret

Boolean to specify whether you want to generate a secret for the user pool client being created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-generatesecret

Return type

Union[bool, IResolvable, None]

id_token_validity

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-idtokenvalidity

Return type

Union[int, float, None]

logout_ur_ls

A list of allowed logout URLs for the identity providers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-logouturls

Return type

Optional[List[str]]

prevent_user_existence_errors

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-preventuserexistenceerrors

Return type

Optional[str]

read_attributes

The read attributes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-readattributes

Return type

Optional[List[str]]

refresh_token_validity

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-refreshtokenvalidity

Return type

Union[int, float, None]

supported_identity_providers

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

The following are supported: COGNITO , Facebook , SignInWithApple , Google and LoginWithAmazon .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-supportedidentityproviders

Return type

Optional[List[str]]

token_validity_units

The units in which the validity times are represented in.

Default for RefreshToken is days, and default for ID and access tokens are hours.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-tokenvalidityunits

Return type

Union[IResolvable, TokenValidityUnitsProperty, None]

user_pool_id

The user pool ID for the user pool where you want to create a user pool client.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-userpoolid

Return type

str

write_attributes

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-writeattributes

Return type

Optional[List[str]]