aws_cognito_idp

Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito User Pools.

Summary

Functions

• add_custom_attributes(Client, Input)
  Adds additional user attributes to the user pool schema.
• add_custom_attributes(Client, Input, Options)
• admin_add_user_to_group(Client, Input)
  Adds the specified user to the specified group.
• admin_add_user_to_group(Client, Input, Options)
• admin_confirm_sign_up(Client, Input)
  Confirms user registration as an admin without using a confirmation code.
• admin_confirm_sign_up(Client, Input, Options)
• admin_create_user(Client, Input)
  Creates a new user in the specified user pool.
• admin_create_user(Client, Input, Options)
• admin_delete_user(Client, Input)
  Deletes a user as an administrator.
• admin_delete_user(Client, Input, Options)
• admin_delete_user_attributes(Client, Input)
  Deletes the user attributes in a user pool as an administrator.
• admin_delete_user_attributes(Client, Input, Options)
• admin_disable_provider_for_user(Client, Input)
  Disables the user from signing in with the specified external (SAML or social) identity provider.
• admin_disable_provider_for_user(Client, Input, Options)
• admin_disable_user(Client, Input)
  Disables the specified user.
• admin_disable_user(Client, Input, Options)
• admin_enable_user(Client, Input)
  Enables the specified user as an administrator.
• admin_enable_user(Client, Input, Options)
• admin_forget_device(Client, Input)
  Forgets the device, as an administrator.
• admin_forget_device(Client, Input, Options)
• admin_get_device(Client, Input)
  Gets the device, as an administrator.
• admin_get_device(Client, Input, Options)
• admin_get_user(Client, Input)
  Gets the specified user by user name in a user pool as an administrator.
• admin_get_user(Client, Input, Options)
• admin_initiate_auth(Client, Input)
  Initiates the authentication flow, as an administrator.
• admin_initiate_auth(Client, Input, Options)
• admin_link_provider_for_user(Client, Input)
  Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider.
• admin_link_provider_for_user(Client, Input, Options)
• admin_list_devices(Client, Input)
  Lists devices, as an administrator.
• admin_list_devices(Client, Input, Options)
• admin_list_groups_for_user(Client, Input)
  Lists the groups that the user belongs to.
• admin_list_groups_for_user(Client, Input, Options)
• admin_list_user_auth_events(Client, Input)
  Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
• admin_list_user_auth_events(Client, Input, Options)
• admin_remove_user_from_group(Client, Input)
  Removes the specified user from the specified group.
• admin_remove_user_from_group(Client, Input, Options)
• admin_reset_user_password(Client, Input)
  Resets the specified user's password in a user pool as an administrator.
• admin_reset_user_password(Client, Input, Options)
• admin_respond_to_auth_challenge(Client, Input)
  Responds to an authentication challenge, as an administrator.
• admin_respond_to_auth_challenge(Client, Input, Options)
• admin_set_user_m_f_a_preference(Client, Input)
  Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred.
• admin_set_user_m_f_a_preference(Client, Input, Options)
• admin_set_user_password(Client, Input)
  Sets the specified user's password in a user pool as an administrator.
• admin_set_user_password(Client, Input, Options)
• admin_set_user_settings(Client, Input)
  This action is no longer supported. You can use it to configure only SMS MFA.
• admin_set_user_settings(Client, Input, Options)
• admin_update_auth_event_feedback(Client, Input)
  Provides feedback for an authentication event as to whether it was from a valid user.
• admin_update_auth_event_feedback(Client, Input, Options)
• admin_update_device_status(Client, Input)
  Updates the device status as an administrator.
• admin_update_device_status(Client, Input, Options)
• admin_update_user_attributes(Client, Input)
  Updates the specified user's attributes, including developer attributes, as an administrator.
• admin_update_user_attributes(Client, Input, Options)
• admin_user_global_sign_out(Client, Input)
  Signs out users from all devices, as an administrator.
• admin_user_global_sign_out(Client, Input, Options)
• associate_software_token(Client, Input)
  Returns a unique generated shared secret key code for the user account.
• associate_software_token(Client, Input, Options)
• change_password(Client, Input)
  Changes the password for a specified user in a user pool.
• change_password(Client, Input, Options)
• confirm_device(Client, Input)
  Confirms tracking of the device.
• confirm_device(Client, Input, Options)
• confirm_forgot_password(Client, Input)
  Allows a user to enter a confirmation code to reset a forgotten password.
• confirm_forgot_password(Client, Input, Options)
• confirm_sign_up(Client, Input)
  Confirms registration of a user and handles the existing alias from a previous user.
• confirm_sign_up(Client, Input, Options)
• create_group(Client, Input)
  Creates a new group in the specified user pool.
• create_group(Client, Input, Options)
• create_identity_provider(Client, Input)
  Creates an identity provider for a user pool.
• create_identity_provider(Client, Input, Options)
• create_resource_server(Client, Input)
  Creates a new OAuth2.0 resource server and defines custom scopes in it.
• create_resource_server(Client, Input, Options)
• create_user_import_job(Client, Input)
  Creates the user import job.
• create_user_import_job(Client, Input, Options)
• create_user_pool(Client, Input)
  Creates a new Amazon Cognito user pool and sets the password policy for the pool.
• create_user_pool(Client, Input, Options)
• create_user_pool_client(Client, Input)
  Creates the user pool client.
• create_user_pool_client(Client, Input, Options)
• create_user_pool_domain(Client, Input)
  Creates a new domain for a user pool.
• create_user_pool_domain(Client, Input, Options)
• delete_group(Client, Input)
  Deletes a group.
• delete_group(Client, Input, Options)
• delete_identity_provider(Client, Input)
  Deletes an identity provider for a user pool.
• delete_identity_provider(Client, Input, Options)
• delete_resource_server(Client, Input)
  Deletes a resource server.
• delete_resource_server(Client, Input, Options)
• delete_user(Client, Input)
  Allows a user to delete himself or herself.
• delete_user(Client, Input, Options)
• delete_user_attributes(Client, Input)
  Deletes the attributes for a user.
• delete_user_attributes(Client, Input, Options)
• delete_user_pool(Client, Input)
  Deletes the specified Amazon Cognito user pool.
• delete_user_pool(Client, Input, Options)
• delete_user_pool_client(Client, Input)
  Allows the developer to delete the user pool client.
• delete_user_pool_client(Client, Input, Options)
• delete_user_pool_domain(Client, Input)
  Deletes a domain for a user pool.
• delete_user_pool_domain(Client, Input, Options)
• describe_identity_provider(Client, Input)
  Gets information about a specific identity provider.
• describe_identity_provider(Client, Input, Options)
• describe_resource_server(Client, Input)
  Describes a resource server.
• describe_resource_server(Client, Input, Options)
• describe_risk_configuration(Client, Input)
  Describes the risk configuration.
• describe_risk_configuration(Client, Input, Options)
• describe_user_import_job(Client, Input)
  Describes the user import job.
• describe_user_import_job(Client, Input, Options)
• describe_user_pool(Client, Input)
  Returns the configuration information and metadata of the specified user pool.
• describe_user_pool(Client, Input, Options)
• describe_user_pool_client(Client, Input)
  Client method for returning the configuration information and metadata of the specified user pool app client.
• describe_user_pool_client(Client, Input, Options)
• describe_user_pool_domain(Client, Input)
  Gets information about a domain.
• describe_user_pool_domain(Client, Input, Options)
• forget_device(Client, Input)
  Forgets the specified device.
• forget_device(Client, Input, Options)
• forgot_password(Client, Input)
  Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.
• forgot_password(Client, Input, Options)
• get_csv_header(Client, Input)
  Gets the header information for the .csv file to be used as input for the user import job.
• get_csv_header(Client, Input, Options)
• get_device(Client, Input)
  Gets the device.
• get_device(Client, Input, Options)
• get_group(Client, Input)
  Gets a group.
• get_group(Client, Input, Options)
• get_identity_provider_by_identifier(Client, Input)
  Gets the specified identity provider.
• get_identity_provider_by_identifier(Client, Input, Options)
• get_signing_certificate(Client, Input)
  This method takes a user pool ID, and returns the signing certificate.
• get_signing_certificate(Client, Input, Options)
• get_u_i_customization(Client, Input)
  Gets the UI Customization information for a particular app client's app UI, if there is something set.
• get_u_i_customization(Client, Input, Options)
• get_user(Client, Input)
  Gets the user attributes and metadata for a user.
• get_user(Client, Input, Options)
• get_user_attribute_verification_code(Client, Input)
  Gets the user attribute verification code for the specified attribute name.
• get_user_attribute_verification_code(Client, Input, Options)
• get_user_pool_mfa_config(Client, Input)
  Gets the user pool multi-factor authentication (MFA) configuration.
• get_user_pool_mfa_config(Client, Input, Options)
• global_sign_out(Client, Input)
  Signs out users from all devices.
• global_sign_out(Client, Input, Options)
• initiate_auth(Client, Input)
  Initiates the authentication flow.
• initiate_auth(Client, Input, Options)
• list_devices(Client, Input)
  Lists the devices.
• list_devices(Client, Input, Options)
• list_groups(Client, Input)
  Lists the groups associated with a user pool.
• list_groups(Client, Input, Options)
• list_identity_providers(Client, Input)
  Lists information about all identity providers for a user pool.
• list_identity_providers(Client, Input, Options)
• list_resource_servers(Client, Input)
  Lists the resource servers for a user pool.
• list_resource_servers(Client, Input, Options)
• list_tags_for_resource(Client, Input)
  Lists the tags that are assigned to an Amazon Cognito user pool.
• list_tags_for_resource(Client, Input, Options)
• list_user_import_jobs(Client, Input)
  Lists the user import jobs.
• list_user_import_jobs(Client, Input, Options)
• list_user_pool_clients(Client, Input)
  Lists the clients that have been created for the specified user pool.
• list_user_pool_clients(Client, Input, Options)
• list_user_pools(Client, Input)
  Lists the user pools associated with an AWS account.
• list_user_pools(Client, Input, Options)
• list_users(Client, Input)
  Lists the users in the Amazon Cognito user pool.
• list_users(Client, Input, Options)
• list_users_in_group(Client, Input)
  Lists the users in the specified group.
• list_users_in_group(Client, Input, Options)
• resend_confirmation_code(Client, Input)
  Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
• resend_confirmation_code(Client, Input, Options)
• respond_to_auth_challenge(Client, Input)
  Responds to the authentication challenge.
• respond_to_auth_challenge(Client, Input, Options)
• set_risk_configuration(Client, Input)
  Configures actions on detected risks.
• set_risk_configuration(Client, Input, Options)
• set_u_i_customization(Client, Input)
  Sets the UI customization information for a user pool's built-in app UI.
• set_u_i_customization(Client, Input, Options)
• set_user_m_f_a_preference(Client, Input)
  Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred.
• set_user_m_f_a_preference(Client, Input, Options)
• set_user_pool_mfa_config(Client, Input)
  Set the user pool multi-factor authentication (MFA) configuration.
• set_user_pool_mfa_config(Client, Input, Options)
• set_user_settings(Client, Input)
  This action is no longer supported. You can use it to configure only SMS MFA.
• set_user_settings(Client, Input, Options)
• sign_up(Client, Input)
  Registers the user in the specified user pool and creates a user name, password, and user attributes.
• sign_up(Client, Input, Options)
• start_user_import_job(Client, Input)
  Starts the user import.
• start_user_import_job(Client, Input, Options)
• stop_user_import_job(Client, Input)
  Stops the user import job.
• stop_user_import_job(Client, Input, Options)
• tag_resource(Client, Input)
  Assigns a set of tags to an Amazon Cognito user pool.
• tag_resource(Client, Input, Options)
• untag_resource(Client, Input)
  Removes the specified tags from an Amazon Cognito user pool.
• untag_resource(Client, Input, Options)
• update_auth_event_feedback(Client, Input)
  Provides the feedback for an authentication event whether it was from a valid user or not.
• update_auth_event_feedback(Client, Input, Options)
• update_device_status(Client, Input)
  Updates the device status.
• update_device_status(Client, Input, Options)
• update_group(Client, Input)
  Updates the specified group with the specified attributes.
• update_group(Client, Input, Options)
• update_identity_provider(Client, Input)
  Updates identity provider information for a user pool.
• update_identity_provider(Client, Input, Options)
• update_resource_server(Client, Input)
  Updates the name and scopes of resource server.
• update_resource_server(Client, Input, Options)
• update_user_attributes(Client, Input)
  Allows a user to update a specific attribute (one at a time).
• update_user_attributes(Client, Input, Options)
• update_user_pool(Client, Input)
  Updates the specified user pool with the specified attributes.
• update_user_pool(Client, Input, Options)
• update_user_pool_client(Client, Input)
  Updates the specified user pool app client with the specified attributes.
• update_user_pool_client(Client, Input, Options)
• update_user_pool_domain(Client, Input)
  Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
• update_user_pool_domain(Client, Input, Options)
• verify_software_token(Client, Input)
  Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful.
• verify_software_token(Client, Input, Options)
• verify_user_attribute(Client, Input)
  Verifies the specified user attributes in the user pool.
• verify_user_attribute(Client, Input, Options)

Functions

Adds additional user attributes to the user pool schema.

Adds the specified user to the specified group.

Confirms user registration as an admin without using a confirmation code. Works on any user.

Creates a new user in the specified user pool.

If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).

This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

Deletes a user as an administrator. Works on any user.

Deletes the user attributes in a user pool as an administrator. Works on any user.

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

Disables the specified user.

Enables the specified user as an administrator. Works on any user.

Forgets the device, as an administrator.

Gets the device, as an administrator.

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Initiates the authentication flow, as an administrator.

Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. See also .

Lists devices, as an administrator.

Lists the groups that the user belongs to.

Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.

Removes the specified user from the specified group.

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Responds to an authentication challenge, as an administrator.

Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.

Sets the specified user's password in a user pool as an administrator. Works on any user.

The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.

Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Updates the device status as an administrator.

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

Changes the password for a specified user in a user pool.

Confirms tracking of the device. This API call is the call that begins device tracking.

Allows a user to enter a confirmation code to reset a forgotten password.

Confirms registration of a user and handles the existing alias from a previous user.

Creates a new group in the specified user pool.

Creates an identity provider for a user pool.

Creates a new OAuth2.0 resource server and defines custom scopes in it.

Creates the user import job.

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Creates the user pool client.

Creates a new domain for a user pool.

Deletes a group. Currently only groups with no members can be deleted.

Deletes an identity provider for a user pool.

Deletes a resource server.

Allows a user to delete himself or herself.

Deletes the attributes for a user.

Deletes the specified Amazon Cognito user pool.

Allows the developer to delete the user pool client.

Deletes a domain for a user pool.

Gets information about a specific identity provider.

Describes a resource server.

Describes the risk configuration.

Describes the user import job.

Returns the configuration information and metadata of the specified user pool.

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

Gets information about a domain.

Forgets the specified device.

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

Gets the header information for the .csv file to be used as input for the user import job.

Gets the device.

Gets a group.

Gets the specified identity provider.

This method takes a user pool ID, and returns the signing certificate.

Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.

Gets the user attributes and metadata for a user.

Gets the user attribute verification code for the specified attribute name.

Gets the user pool multi-factor authentication (MFA) configuration.

Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.

Initiates the authentication flow.

Lists the devices.

Lists the groups associated with a user pool.

Lists information about all identity providers for a user pool.

Lists the resource servers for a user pool.

Lists the tags that are assigned to an Amazon Cognito user pool.

A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Lists the user import jobs.

Lists the clients that have been created for the specified user pool.

Lists the user pools associated with an AWS account.

Lists the users in the Amazon Cognito user pool.

Lists the users in the specified group.

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

Responds to the authentication challenge.

Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

Sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.

Set the user pool multi-factor authentication (MFA) configuration.

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.

Registers the user in the specified user pool and creates a user name, password, and user attributes.

Starts the user import.

Stops the user import job.

Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account

Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

Updates the device status.

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

Updates identity provider information for a user pool.

Updates the name and scopes of resource server. All other fields are read-only.

Allows a user to update a specific attribute (one at a time).

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

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

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.

Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.

However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.

When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

Verifies the specified user attributes in the user pool.