aws-elixir v0.4.0 AWS.Cognito.IdentityProvider

Using the Amazon Cognito Your 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 Your User Pools.

For more information, see the Amazon Cognito Documentation.

Summary

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 and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary 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 specified user as an administrator. Works on any 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

Lists devices, as an administrator

Lists the groups that the user belongs to

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

Responds to an authentication challenge, as an administrator

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

Updates the device status as an administrator

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

Signs out users from all devices, as an administrator

Changes the password for a specified user in a user pool

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

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 group in the specified user pool

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

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

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

Forgets the specified device

Retrieves the password for the specified client ID or username

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

Gets the user attributes and metadata for a user

Gets the user attribute verification code for the specified attribute name

Signs out users from all devices

Initiates the authentication flow

Lists the groups associated with a user pool

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

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

Updates the specified group with the specified 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_add_user_to_group(client, input, options \\ [])

Adds the specified user to the specified group.

Requires developer credentials.

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

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

Requires developer credentials.

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

Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Requires developer credentials.

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

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

Requires developer credentials.

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

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

Requires developer credentials.

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

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

Requires developer credentials.

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

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

Requires developer credentials.

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

Forgets the device, as an administrator.

Requires developer credentials.

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

Gets the device, as an administrator.

Requires developer credentials.

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

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

Requires developer credentials.

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

Initiates the authentication flow, as an administrator.

Requires developer credentials.

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

Lists devices, as an administrator.

Requires developer credentials.

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

Lists the groups that the user belongs to.

Requires developer credentials.

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

Removes the specified user from the specified group.

Requires developer credentials.

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

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.

Requires developer credentials.

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

Responds to an authentication challenge, as an administrator.

Requires developer credentials.

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

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

Requires developer credentials.

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

Updates the device status as an administrator.

Requires developer credentials.

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

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

Requires developer credentials.

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

Signs out users from all devices, as an administrator.

Requires developer credentials.

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

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

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

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

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_group(client, input, options \\ [])

Creates a new group in the specified user pool.

Requires developer credentials.

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

Creates the user import job.

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_group(client, input, options \\ [])

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

Requires developer credentials.

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_import_job(client, input, options \\ [])

Describes the user import job.

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.

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

Forgets the specified device.

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

Retrieves the password for the specified client ID or username.

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

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

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

Gets the device.

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

Gets a group.

Requires developer credentials.

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.

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

Signs out users from all devices.

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

Initiates the authentication flow.

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

Lists the devices.

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

Lists the groups associated with a user pool.

Requires developer credentials.

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

Lists the user import jobs.

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.

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

Lists the users in the specified group.

Requires developer credentials.

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

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

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

Responds to the authentication challenge.

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.

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

Starts the user import.

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

Stops the user import job.

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

Updates the device status.

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

Updates the specified group with the specified attributes.

Requires developer credentials.

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.