aws-elixir v0.1.0 AWS.Cognito.IdentityProvider

You can create a user pool in Amazon Cognito Identity 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 Identity, which is a new capability that is available as a beta.

Summary

Functions

Adds additional user attributes to the user pool schema

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

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 specified user as an administrator. Works on any user

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

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

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

Sets all the user settings for a specified user name. Works on any user

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

Changes the password for a specified user in a user pool

Allows a user to enter a code provided when they reset their password to update their password

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

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

Allows a user to delete one’s self

Deletes the attributes for a user

Deletes the specified Amazon Cognito user pool

Allows the developer to delete the user pool client

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 client

Retrieves the password for the specified client ID or username

Gets the user attributes and metadata for a user

Gets the user attribute verification code for the specified attribute name

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

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

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed

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

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

Updates the specified user pool with the specified attributes

Allows the developer to update the specified user pool client and password policy

Verifies the specified user attributes in the user pool

Functions

add_custom_attributes(client, input, options \\ [])

Adds additional user attributes to the user pool schema.

admin_confirm_sign_up(client, input, options \\ [])

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

admin_delete_user(client, input, options \\ [])

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

admin_delete_user_attributes(client, input, options \\ [])

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

admin_disable_user(client, input, options \\ [])

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

admin_enable_user(client, input, options \\ [])

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

admin_get_user(client, input, options \\ [])

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

admin_reset_user_password(client, input, options \\ [])

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

admin_set_user_settings(client, input, options \\ [])

Sets all the user settings for a specified user name. Works on any user.

admin_update_user_attributes(client, input, options \\ [])

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

change_password(client, input, options \\ [])

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

confirm_forgot_password(client, input, options \\ [])

Allows a user to enter a code provided when they reset their password to update their password.

confirm_sign_up(client, input, options \\ [])

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

create_user_pool(client, input, options \\ [])

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

create_user_pool_client(client, input, options \\ [])

Creates the user pool client.

delete_user(client, input, options \\ [])

Allows a user to delete one’s self.

delete_user_attributes(client, input, options \\ [])

Deletes the attributes for a user.

delete_user_pool(client, input, options \\ [])

Deletes the specified Amazon Cognito user pool.

delete_user_pool_client(client, input, options \\ [])

Allows the developer to delete the user pool client.

describe_user_pool(client, input, options \\ [])

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

describe_user_pool_client(client, input, options \\ [])

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

forgot_password(client, input, options \\ [])

Retrieves the password for the specified client ID or username.

get_user(client, input, options \\ [])

Gets the user attributes and metadata for a user.

get_user_attribute_verification_code(client, input, options \\ [])

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

list_user_pool_clients(client, input, options \\ [])

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

list_user_pools(client, input, options \\ [])

Lists the user pools associated with an AWS account.

list_users(client, input, options \\ [])

Lists the users in the Amazon Cognito user pool.

resend_confirmation_code(client, input, options \\ [])

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

set_user_settings(client, input, options \\ [])

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

sign_up(client, input, options \\ [])

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

update_user_attributes(client, input, options \\ [])

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

update_user_pool(client, input, options \\ [])

Updates the specified user pool with the specified attributes.

update_user_pool_client(client, input, options \\ [])

Allows the developer to update the specified user pool client and password policy.

verify_user_attribute(client, input, options \\ [])

Verifies the specified user attributes in the user pool.