Amazon Cognito Identity Provider

Revokes all of the access tokens generated by the specified refresh token. After the token is revoked, you can not use the revoked token to access Cognito authenticated APIs.

See also: AWS API Documentation

Request Syntax

client.revoke_token(
    Token='string',
    ClientId='string',
    ClientSecret='string'
)

type Token

string

param Token

[REQUIRED]

The token that you want to revoke.

type ClientId

string

param ClientId

[REQUIRED]

The client ID for the token that you want to revoke.

type ClientSecret

string

param ClientSecret

The secret for the client ID. This is required only if the client ID has a secret.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

{'EnableTokenRevocation': 'boolean'}

{'UserPoolClient': {'EnableTokenRevocation': 'boolean'}}

Creates the user pool client.

When you create a new user pool client, token revocation is automatically enabled. For more information about revoking tokens, see RevokeToken .

See also: AWS API Documentation

Request Syntax

client.create_user_pool_client(
    UserPoolId='string',
    ClientName='string',
    GenerateSecret=True|False,
    RefreshTokenValidity=123,
    AccessTokenValidity=123,
    IdTokenValidity=123,
    TokenValidityUnits={
        'AccessToken': 'seconds'|'minutes'|'hours'|'days',
        'IdToken': 'seconds'|'minutes'|'hours'|'days',
        'RefreshToken': 'seconds'|'minutes'|'hours'|'days'
    },
    ReadAttributes=[
        'string',
    ],
    WriteAttributes=[
        'string',
    ],
    ExplicitAuthFlows=[
        'ADMIN_NO_SRP_AUTH'|'CUSTOM_AUTH_FLOW_ONLY'|'USER_PASSWORD_AUTH'|'ALLOW_ADMIN_USER_PASSWORD_AUTH'|'ALLOW_CUSTOM_AUTH'|'ALLOW_USER_PASSWORD_AUTH'|'ALLOW_USER_SRP_AUTH'|'ALLOW_REFRESH_TOKEN_AUTH',
    ],
    SupportedIdentityProviders=[
        'string',
    ],
    CallbackURLs=[
        'string',
    ],
    LogoutURLs=[
        'string',
    ],
    DefaultRedirectURI='string',
    AllowedOAuthFlows=[
        'code'|'implicit'|'client_credentials',
    ],
    AllowedOAuthScopes=[
        'string',
    ],
    AllowedOAuthFlowsUserPoolClient=True|False,
    AnalyticsConfiguration={
        'ApplicationId': 'string',
        'ApplicationArn': 'string',
        'RoleArn': 'string',
        'ExternalId': 'string',
        'UserDataShared': True|False
    },
    PreventUserExistenceErrors='LEGACY'|'ENABLED',
    EnableTokenRevocation=True|False
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

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

type ClientName

string

param ClientName

[REQUIRED]

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

type GenerateSecret

boolean

param GenerateSecret

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

type RefreshTokenValidity

integer

param RefreshTokenValidity

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

type AccessTokenValidity

integer

param AccessTokenValidity

The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.

type IdTokenValidity

integer

param IdTokenValidity

The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.

type TokenValidityUnits

dict

param TokenValidityUnits

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

• AccessToken (string) --

  A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.

• IdToken (string) --

  A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.

• RefreshToken (string) --

  A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.

type ReadAttributes

list

param ReadAttributes

The read attributes.

• (string) --

type WriteAttributes

list

param WriteAttributes

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 attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .

• (string) --

type ExplicitAuthFlows

list

param 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.

• (string) --

type SupportedIdentityProviders

list

param SupportedIdentityProviders

A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO , Facebook , Google and LoginWithAmazon .

• (string) --

type CallbackURLs

list

param 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.

• (string) --

type LogoutURLs

list

param LogoutURLs

A list of allowed logout URLs for the identity providers.

• (string) --

type DefaultRedirectURI

string

param 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.

type AllowedOAuthFlows

list

param 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.

• (string) --

type AllowedOAuthScopes

list

param AllowedOAuthScopes

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.

• (string) --

type AllowedOAuthFlowsUserPoolClient

boolean

param AllowedOAuthFlowsUserPoolClient

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

type AnalyticsConfiguration

dict

param AnalyticsConfiguration

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

Note

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

• ApplicationId (string) --

  The application ID for an Amazon Pinpoint application.

• ApplicationArn (string) --

  The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.

• RoleArn (string) --

  The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

• ExternalId (string) --

  The external ID.

• UserDataShared (boolean) --

  If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

type PreventUserExistenceErrors

string

param 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.

Note

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

type EnableTokenRevocation

boolean

param EnableTokenRevocation

Enables or disables token revocation. For more information about revoking tokens, see RevokeToken .

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

rtype

dict

returns

Response Syntax

{
    'UserPoolClient': {
        'UserPoolId': 'string',
        'ClientName': 'string',
        'ClientId': 'string',
        'ClientSecret': 'string',
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1),
        'RefreshTokenValidity': 123,
        'AccessTokenValidity': 123,
        'IdTokenValidity': 123,
        'TokenValidityUnits': {
            'AccessToken': 'seconds'|'minutes'|'hours'|'days',
            'IdToken': 'seconds'|'minutes'|'hours'|'days',
            'RefreshToken': 'seconds'|'minutes'|'hours'|'days'
        },
        'ReadAttributes': [
            'string',
        ],
        'WriteAttributes': [
            'string',
        ],
        'ExplicitAuthFlows': [
            'ADMIN_NO_SRP_AUTH'|'CUSTOM_AUTH_FLOW_ONLY'|'USER_PASSWORD_AUTH'|'ALLOW_ADMIN_USER_PASSWORD_AUTH'|'ALLOW_CUSTOM_AUTH'|'ALLOW_USER_PASSWORD_AUTH'|'ALLOW_USER_SRP_AUTH'|'ALLOW_REFRESH_TOKEN_AUTH',
        ],
        'SupportedIdentityProviders': [
            'string',
        ],
        'CallbackURLs': [
            'string',
        ],
        'LogoutURLs': [
            'string',
        ],
        'DefaultRedirectURI': 'string',
        'AllowedOAuthFlows': [
            'code'|'implicit'|'client_credentials',
        ],
        'AllowedOAuthScopes': [
            'string',
        ],
        'AllowedOAuthFlowsUserPoolClient': True|False,
        'AnalyticsConfiguration': {
            'ApplicationId': 'string',
            'ApplicationArn': 'string',
            'RoleArn': 'string',
            'ExternalId': 'string',
            'UserDataShared': True|False
        },
        'PreventUserExistenceErrors': 'LEGACY'|'ENABLED',
        'EnableTokenRevocation': True|False
    }
}

Response Structure

• (dict) --

  Represents the response from the server to create a user pool client.

  • UserPoolClient (dict) --

    The user pool client that was just created.

    • UserPoolId (string) --

      The user pool ID for the user pool client.

    • ClientName (string) --

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

    • ClientId (string) --

      The ID of the client associated with the user pool.

    • ClientSecret (string) --

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

    • LastModifiedDate (datetime) --

      The date the user pool client was last modified.

    • CreationDate (datetime) --

      The date the user pool client was created.

    • RefreshTokenValidity (integer) --

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

    • AccessTokenValidity (integer) --

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

    • IdTokenValidity (integer) --

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

    • TokenValidityUnits (dict) --

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

      • AccessToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.

      • IdToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.

      • RefreshToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.

    • ReadAttributes (list) --

      The Read-only attributes.

      • (string) --

    • WriteAttributes (list) --

      The writeable attributes.

      • (string) --

    • ExplicitAuthFlows (list) --

      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.

      • (string) --

    • SupportedIdentityProviders (list) --

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

      • (string) --

    • CallbackURLs (list) --

      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.

      • (string) --

    • LogoutURLs (list) --

      A list of allowed logout URLs for the identity providers.

      • (string) --

    • DefaultRedirectURI (string) --

      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.

    • AllowedOAuthFlows (list) --

      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.

      • (string) --

    • AllowedOAuthScopes (list) --

      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.

      • (string) --

    • AllowedOAuthFlowsUserPoolClient (boolean) --

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

    • AnalyticsConfiguration (dict) --

      The Amazon Pinpoint analytics configuration for the user pool client.

      Note

      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.

      • ApplicationId (string) --

        The application ID for an Amazon Pinpoint application.

      • ApplicationArn (string) --

        The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.

      • RoleArn (string) --

        The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

      • ExternalId (string) --

        The external ID.

      • UserDataShared (boolean) --

        If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

    • PreventUserExistenceErrors (string) --

      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.

      Note

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

    • EnableTokenRevocation (boolean) --

      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 .

{'UserPoolClient': {'EnableTokenRevocation': 'boolean'}}

Client method for returning the configuration information and metadata of the specified user pool app client.

See also: AWS API Documentation

Request Syntax

client.describe_user_pool_client(
    UserPoolId='string',
    ClientId='string'
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

The user pool ID for the user pool you want to describe.

type ClientId

string

param ClientId

[REQUIRED]

The app client ID of the app associated with the user pool.

rtype

dict

returns

Response Syntax

{
    'UserPoolClient': {
        'UserPoolId': 'string',
        'ClientName': 'string',
        'ClientId': 'string',
        'ClientSecret': 'string',
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1),
        'RefreshTokenValidity': 123,
        'AccessTokenValidity': 123,
        'IdTokenValidity': 123,
        'TokenValidityUnits': {
            'AccessToken': 'seconds'|'minutes'|'hours'|'days',
            'IdToken': 'seconds'|'minutes'|'hours'|'days',
            'RefreshToken': 'seconds'|'minutes'|'hours'|'days'
        },
        'ReadAttributes': [
            'string',
        ],
        'WriteAttributes': [
            'string',
        ],
        'ExplicitAuthFlows': [
            'ADMIN_NO_SRP_AUTH'|'CUSTOM_AUTH_FLOW_ONLY'|'USER_PASSWORD_AUTH'|'ALLOW_ADMIN_USER_PASSWORD_AUTH'|'ALLOW_CUSTOM_AUTH'|'ALLOW_USER_PASSWORD_AUTH'|'ALLOW_USER_SRP_AUTH'|'ALLOW_REFRESH_TOKEN_AUTH',
        ],
        'SupportedIdentityProviders': [
            'string',
        ],
        'CallbackURLs': [
            'string',
        ],
        'LogoutURLs': [
            'string',
        ],
        'DefaultRedirectURI': 'string',
        'AllowedOAuthFlows': [
            'code'|'implicit'|'client_credentials',
        ],
        'AllowedOAuthScopes': [
            'string',
        ],
        'AllowedOAuthFlowsUserPoolClient': True|False,
        'AnalyticsConfiguration': {
            'ApplicationId': 'string',
            'ApplicationArn': 'string',
            'RoleArn': 'string',
            'ExternalId': 'string',
            'UserDataShared': True|False
        },
        'PreventUserExistenceErrors': 'LEGACY'|'ENABLED',
        'EnableTokenRevocation': True|False
    }
}

Response Structure

• (dict) --

  Represents the response from the server from a request to describe the user pool client.

  • UserPoolClient (dict) --

    The user pool client from a server response to describe the user pool client.

    • UserPoolId (string) --

      The user pool ID for the user pool client.

    • ClientName (string) --

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

    • ClientId (string) --

      The ID of the client associated with the user pool.

    • ClientSecret (string) --

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

    • LastModifiedDate (datetime) --

      The date the user pool client was last modified.

    • CreationDate (datetime) --

      The date the user pool client was created.

    • RefreshTokenValidity (integer) --

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

    • AccessTokenValidity (integer) --

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

    • IdTokenValidity (integer) --

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

    • TokenValidityUnits (dict) --

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

      • AccessToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.

      • IdToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.

      • RefreshToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.

    • ReadAttributes (list) --

      The Read-only attributes.

      • (string) --

    • WriteAttributes (list) --

      The writeable attributes.

      • (string) --

    • ExplicitAuthFlows (list) --

      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.

      • (string) --

    • SupportedIdentityProviders (list) --

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

      • (string) --

    • CallbackURLs (list) --

      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.

      • (string) --

    • LogoutURLs (list) --

      A list of allowed logout URLs for the identity providers.

      • (string) --

    • DefaultRedirectURI (string) --

      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.

    • AllowedOAuthFlows (list) --

      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.

      • (string) --

    • AllowedOAuthScopes (list) --

      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.

      • (string) --

    • AllowedOAuthFlowsUserPoolClient (boolean) --

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

    • AnalyticsConfiguration (dict) --

      The Amazon Pinpoint analytics configuration for the user pool client.

      Note

      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.

      • ApplicationId (string) --

        The application ID for an Amazon Pinpoint application.

      • ApplicationArn (string) --

        The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.

      • RoleArn (string) --

        The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

      • ExternalId (string) --

        The external ID.

      • UserDataShared (boolean) --

        If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

    • PreventUserExistenceErrors (string) --

      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.

      Note

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

    • EnableTokenRevocation (boolean) --

      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 .

{'EnableTokenRevocation': 'boolean'}

{'UserPoolClient': {'EnableTokenRevocation': 'boolean'}}

Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient .

You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken .

See also: AWS API Documentation

Request Syntax

client.update_user_pool_client(
    UserPoolId='string',
    ClientId='string',
    ClientName='string',
    RefreshTokenValidity=123,
    AccessTokenValidity=123,
    IdTokenValidity=123,
    TokenValidityUnits={
        'AccessToken': 'seconds'|'minutes'|'hours'|'days',
        'IdToken': 'seconds'|'minutes'|'hours'|'days',
        'RefreshToken': 'seconds'|'minutes'|'hours'|'days'
    },
    ReadAttributes=[
        'string',
    ],
    WriteAttributes=[
        'string',
    ],
    ExplicitAuthFlows=[
        'ADMIN_NO_SRP_AUTH'|'CUSTOM_AUTH_FLOW_ONLY'|'USER_PASSWORD_AUTH'|'ALLOW_ADMIN_USER_PASSWORD_AUTH'|'ALLOW_CUSTOM_AUTH'|'ALLOW_USER_PASSWORD_AUTH'|'ALLOW_USER_SRP_AUTH'|'ALLOW_REFRESH_TOKEN_AUTH',
    ],
    SupportedIdentityProviders=[
        'string',
    ],
    CallbackURLs=[
        'string',
    ],
    LogoutURLs=[
        'string',
    ],
    DefaultRedirectURI='string',
    AllowedOAuthFlows=[
        'code'|'implicit'|'client_credentials',
    ],
    AllowedOAuthScopes=[
        'string',
    ],
    AllowedOAuthFlowsUserPoolClient=True|False,
    AnalyticsConfiguration={
        'ApplicationId': 'string',
        'ApplicationArn': 'string',
        'RoleArn': 'string',
        'ExternalId': 'string',
        'UserDataShared': True|False
    },
    PreventUserExistenceErrors='LEGACY'|'ENABLED',
    EnableTokenRevocation=True|False
)

type UserPoolId

string

param UserPoolId

[REQUIRED]

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

type ClientId

string

param ClientId

[REQUIRED]

The ID of the client associated with the user pool.

type ClientName

string

param ClientName

The client name from the update user pool client request.

type RefreshTokenValidity

integer

param RefreshTokenValidity

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

type AccessTokenValidity

integer

param AccessTokenValidity

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

type IdTokenValidity

integer

param IdTokenValidity

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

type TokenValidityUnits

dict

param TokenValidityUnits

The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.

• AccessToken (string) --

  A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.

• IdToken (string) --

  A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.

• RefreshToken (string) --

  A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.

type ReadAttributes

list

param ReadAttributes

The read-only attributes of the user pool.

• (string) --

type WriteAttributes

list

param WriteAttributes

The writeable attributes of the user pool.

• (string) --

type ExplicitAuthFlows

list

param 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.

• (string) --

type SupportedIdentityProviders

list

param SupportedIdentityProviders

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

• (string) --

type CallbackURLs

list

param 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.

• (string) --

type LogoutURLs

list

param LogoutURLs

A list of allowed logout URLs for the identity providers.

• (string) --

type DefaultRedirectURI

string

param 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.

type AllowedOAuthFlows

list

param 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.

• (string) --

type AllowedOAuthScopes

list

param AllowedOAuthScopes

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.

• (string) --

type AllowedOAuthFlowsUserPoolClient

boolean

param AllowedOAuthFlowsUserPoolClient

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

type AnalyticsConfiguration

dict

param AnalyticsConfiguration

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

Note

In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.

• ApplicationId (string) --

  The application ID for an Amazon Pinpoint application.

• ApplicationArn (string) --

  The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.

• RoleArn (string) --

  The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

• ExternalId (string) --

  The external ID.

• UserDataShared (boolean) --

  If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

type PreventUserExistenceErrors

string

param 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.

Note

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

type EnableTokenRevocation

boolean

param EnableTokenRevocation

Enables or disables token revocation. For more information about revoking tokens, see RevokeToken .

rtype

dict

returns

Response Syntax

{
    'UserPoolClient': {
        'UserPoolId': 'string',
        'ClientName': 'string',
        'ClientId': 'string',
        'ClientSecret': 'string',
        'LastModifiedDate': datetime(2015, 1, 1),
        'CreationDate': datetime(2015, 1, 1),
        'RefreshTokenValidity': 123,
        'AccessTokenValidity': 123,
        'IdTokenValidity': 123,
        'TokenValidityUnits': {
            'AccessToken': 'seconds'|'minutes'|'hours'|'days',
            'IdToken': 'seconds'|'minutes'|'hours'|'days',
            'RefreshToken': 'seconds'|'minutes'|'hours'|'days'
        },
        'ReadAttributes': [
            'string',
        ],
        'WriteAttributes': [
            'string',
        ],
        'ExplicitAuthFlows': [
            'ADMIN_NO_SRP_AUTH'|'CUSTOM_AUTH_FLOW_ONLY'|'USER_PASSWORD_AUTH'|'ALLOW_ADMIN_USER_PASSWORD_AUTH'|'ALLOW_CUSTOM_AUTH'|'ALLOW_USER_PASSWORD_AUTH'|'ALLOW_USER_SRP_AUTH'|'ALLOW_REFRESH_TOKEN_AUTH',
        ],
        'SupportedIdentityProviders': [
            'string',
        ],
        'CallbackURLs': [
            'string',
        ],
        'LogoutURLs': [
            'string',
        ],
        'DefaultRedirectURI': 'string',
        'AllowedOAuthFlows': [
            'code'|'implicit'|'client_credentials',
        ],
        'AllowedOAuthScopes': [
            'string',
        ],
        'AllowedOAuthFlowsUserPoolClient': True|False,
        'AnalyticsConfiguration': {
            'ApplicationId': 'string',
            'ApplicationArn': 'string',
            'RoleArn': 'string',
            'ExternalId': 'string',
            'UserDataShared': True|False
        },
        'PreventUserExistenceErrors': 'LEGACY'|'ENABLED',
        'EnableTokenRevocation': True|False
    }
}

Response Structure

• (dict) --

  Represents the response from the server to the request to update the user pool client.

  • UserPoolClient (dict) --

    The user pool client value from the response from the server when an update user pool client request is made.

    • UserPoolId (string) --

      The user pool ID for the user pool client.

    • ClientName (string) --

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

    • ClientId (string) --

      The ID of the client associated with the user pool.

    • ClientSecret (string) --

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

    • LastModifiedDate (datetime) --

      The date the user pool client was last modified.

    • CreationDate (datetime) --

      The date the user pool client was created.

    • RefreshTokenValidity (integer) --

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

    • AccessTokenValidity (integer) --

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

    • IdTokenValidity (integer) --

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

    • TokenValidityUnits (dict) --

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

      • AccessToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in AccessTokenValidity, defaults to hours.

      • IdToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in IdTokenValidity, defaults to hours.

      • RefreshToken (string) --

        A time unit in “seconds”, “minutes”, “hours” or “days” for the value in RefreshTokenValidity, defaults to days.

    • ReadAttributes (list) --

      The Read-only attributes.

      • (string) --

    • WriteAttributes (list) --

      The writeable attributes.

      • (string) --

    • ExplicitAuthFlows (list) --

      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.

      • (string) --

    • SupportedIdentityProviders (list) --

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

      • (string) --

    • CallbackURLs (list) --

      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.

      • (string) --

    • LogoutURLs (list) --

      A list of allowed logout URLs for the identity providers.

      • (string) --

    • DefaultRedirectURI (string) --

      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.

    • AllowedOAuthFlows (list) --

      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.

      • (string) --

    • AllowedOAuthScopes (list) --

      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.

      • (string) --

    • AllowedOAuthFlowsUserPoolClient (boolean) --

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

    • AnalyticsConfiguration (dict) --

      The Amazon Pinpoint analytics configuration for the user pool client.

      Note

      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.

      • ApplicationId (string) --

        The application ID for an Amazon Pinpoint application.

      • ApplicationArn (string) --

        The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project for Pinpoint integration with the chosen User Pool Client. Amazon Cognito publishes events to the pinpoint project declared by the app ARN.

      • RoleArn (string) --

        The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

      • ExternalId (string) --

        The external ID.

      • UserDataShared (boolean) --

        If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

    • PreventUserExistenceErrors (string) --

      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.

      Note

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

    • EnableTokenRevocation (boolean) --

      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 .