cognitoidentityprovider: Amazon Cognito Identity Provider

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R


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.

For more information, see the Amazon Cognito Documentation.





Optional configuration of credentials, endpoint, and/or region.


A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- cognitoidentityprovider(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      profile = "string"
    endpoint = "string",
    region = "string"


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


## Not run: 
svc <- cognitoidentityprovider()
  Foo = 123

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.