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 the user import job
Creates a new Amazon Cognito user pool and sets the password policy for the pool
Creates the user pool client
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
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 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 device
Gets a group
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 devices
Lists the groups associated with a user pool
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
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
Starts the user import
Stops the user import job
Updates the device status
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
Adds additional user attributes to the user pool schema.
Adds the specified user to the specified group.
Requires developer credentials.
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
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.
Deletes a user as an administrator. Works on any user.
Requires developer credentials.
Deletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
Disables the specified user as an administrator. Works on any user.
Requires developer credentials.
Enables the specified user as an administrator. Works on any user.
Requires developer credentials.
Forgets the device, as an administrator.
Requires developer credentials.
Gets the device, as an administrator.
Requires developer credentials.
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
Initiates the authentication flow, as an administrator.
Requires developer credentials.
Lists devices, as an administrator.
Requires developer credentials.
Lists the groups that the user belongs to.
Requires developer credentials.
Removes the specified user from the specified group.
Requires developer credentials.
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.
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
Updates the device status as an administrator.
Requires developer credentials.
Updates the specified user’s attributes, including developer attributes, as an administrator. Works on any user.
Requires developer credentials.
Signs out users from all devices, as an administrator.
Requires developer credentials.
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.
Requires developer credentials.
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.
Requires developer credentials.
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 header information for the .csv file to be used as input for the user import job.
Gets the user attribute verification code for the specified attribute name.
Lists the groups associated with a user pool.
Requires developer credentials.
Lists the clients that have been created for the specified user pool.
Lists the users in the specified group.
Requires developer credentials.
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.
Updates the specified group with the specified attributes.
Requires developer credentials.
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.