Class: Aws::CognitoIdentityProvider::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CognitoIdentityProvider::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb
Overview
An API client for CognitoIdentityProvider. To construct a client, you need to configure a :region and :credentials.
client = Aws::CognitoIdentityProvider::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_custom_attributes(params = {}) ⇒ Struct
Adds additional user attributes to the user pool schema.
-
#add_user_pool_client_secret(params = {}) ⇒ Types::AddUserPoolClientSecretResponse
Creates a new client secret for an existing confidential user pool app client.
-
#admin_add_user_to_group(params = {}) ⇒ Struct
Adds a user to a group.
-
#admin_confirm_sign_up(params = {}) ⇒ Struct
Confirms user sign-up as an administrator.
-
#admin_create_user(params = {}) ⇒ Types::AdminCreateUserResponse
Creates a new user in the specified user pool.
-
#admin_delete_software_token(params = {}) ⇒ Struct
Deletes a user's registered time-based one-time password (TOTP) multi-factor authentication (MFA) factor, also known as a software token.
-
#admin_delete_user(params = {}) ⇒ Struct
Deletes a user profile in your user pool.
-
#admin_delete_user_attributes(params = {}) ⇒ Struct
Deletes attribute values from a user.
-
#admin_disable_provider_for_user(params = {}) ⇒ Struct
Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP).
-
#admin_disable_user(params = {}) ⇒ Struct
Deactivates a user profile and revokes all access tokens for the user.
-
#admin_enable_user(params = {}) ⇒ Struct
Activates sign-in for a user profile that previously had sign-in access disabled.
-
#admin_forget_device(params = {}) ⇒ Struct
Forgets, or deletes, a remembered device from a user's profile.
-
#admin_get_device(params = {}) ⇒ Types::AdminGetDeviceResponse
Given the device key, returns details for a user's device.
-
#admin_get_user(params = {}) ⇒ Types::AdminGetUserResponse
Given a username, returns details about a user profile in a user pool.
-
#admin_get_user_auth_factors(params = {}) ⇒ Types::AdminGetUserAuthFactorsResponse
Lists the authentication options for a user in a user pool.
-
#admin_initiate_auth(params = {}) ⇒ Types::AdminInitiateAuthResponse
Starts sign-in for applications with a server-side component, for example a traditional web application.
-
#admin_link_provider_for_user(params = {}) ⇒ Struct
Links an existing user account in a user pool, or
DestinationUser, to an identity from an external IdP, orSourceUser, based on a specified attribute name and value from the external IdP. -
#admin_list_devices(params = {}) ⇒ Types::AdminListDevicesResponse
Lists a user's registered devices.
-
#admin_list_groups_for_user(params = {}) ⇒ Types::AdminListGroupsForUserResponse
Lists the groups that a user belongs to.
-
#admin_list_user_auth_events(params = {}) ⇒ Types::AdminListUserAuthEventsResponse
Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection.
-
#admin_list_user_sessions(params = {}) ⇒ Types::AdminListUserSessionsResponse
Lists the active sessions for a specified user as an administrator.
-
#admin_remove_user_from_group(params = {}) ⇒ Struct
Given a username and a group name, removes them from the group.
-
#admin_reset_user_password(params = {}) ⇒ Struct
Begins the password reset process.
-
#admin_respond_to_auth_challenge(params = {}) ⇒ Types::AdminRespondToAuthChallengeResponse
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.
-
#admin_revoke_user_session(params = {}) ⇒ Struct
Revokes a specific user session as an administrator.
-
#admin_set_user_mfa_preference(params = {}) ⇒ Struct
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred.
-
#admin_set_user_password(params = {}) ⇒ Struct
Sets the specified user's password in a user pool.
-
#admin_set_user_settings(params = {}) ⇒ Struct
This action is no longer supported. You can use it to configure only SMS MFA.
-
#admin_update_auth_event_feedback(params = {}) ⇒ Struct
Provides the feedback for an authentication event generated by threat protection features.
-
#admin_update_device_status(params = {}) ⇒ Struct
Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication.
-
#admin_update_user_attributes(params = {}) ⇒ Struct
Updates the specified user's attributes.
-
#admin_user_global_sign_out(params = {}) ⇒ Struct
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.
-
#associate_software_token(params = {}) ⇒ Types::AssociateSoftwareTokenResponse
Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response.
-
#cancel_point_in_time_recovery(params = {}) ⇒ Types::CancelPointInTimeRecoveryResponse
Cancels a point-in-time recovery of a user pool before Amazon Cognito applies any changes.
-
#change_password(params = {}) ⇒ Struct
Changes the password for the currently signed-in user.
-
#complete_web_authn_registration(params = {}) ⇒ Struct
Completes registration of a passkey authenticator for the currently signed-in user.
-
#confirm_device(params = {}) ⇒ Types::ConfirmDeviceResponse
Confirms a device that a user wants to remember.
-
#confirm_forgot_password(params = {}) ⇒ Struct
This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.
-
#confirm_sign_up(params = {}) ⇒ Types::ConfirmSignUpResponse
Confirms the account of a new user.
-
#create_cimd_policy(params = {}) ⇒ Types::CreateCIMDPolicyResponse
Creates a Client ID Metadata Document (CIMD) policy for an app client.
-
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a new group in the specified user pool.
-
#create_identity_provider(params = {}) ⇒ Types::CreateIdentityProviderResponse
Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool.
-
#create_managed_login_branding(params = {}) ⇒ Types::CreateManagedLoginBrandingResponse
Creates a new set of branding settings for a user pool style and associates it with an app client.
-
#create_resource_server(params = {}) ⇒ Types::CreateResourceServerResponse
Creates a new OAuth2.0 resource server and defines custom scopes within it.
-
#create_terms(params = {}) ⇒ Types::CreateTermsResponse
Creates terms documents for the requested app client.
-
#create_user_import_job(params = {}) ⇒ Types::CreateUserImportJobResponse
Creates a user import job.
-
#create_user_pool(params = {}) ⇒ Types::CreateUserPoolResponse
Creates a new Amazon Cognito user pool.
-
#create_user_pool_client(params = {}) ⇒ Types::CreateUserPoolClientResponse
Creates an app client in a user pool.
-
#create_user_pool_domain(params = {}) ⇒ Types::CreateUserPoolDomainResponse
A user pool domain hosts managed login, an authorization server and web server for authentication in your application.
-
#create_user_pool_replica(params = {}) ⇒ Types::CreateUserPoolReplicaResponse
Creates a replica of an existing user pool in a specified Amazon Web Services Region.
-
#delete_cimd_policy(params = {}) ⇒ Struct
Deletes a Client ID Metadata Document (CIMD) policy.
-
#delete_group(params = {}) ⇒ Struct
Deletes a group from the specified user pool.
-
#delete_identity_provider(params = {}) ⇒ Struct
Deletes a user pool identity provider (IdP).
-
#delete_managed_login_branding(params = {}) ⇒ Struct
Deletes a managed login branding style.
-
#delete_resource_server(params = {}) ⇒ Struct
Deletes a resource server.
-
#delete_terms(params = {}) ⇒ Struct
Deletes the terms documents with the requested ID from your app client.
-
#delete_user(params = {}) ⇒ Struct
Deletes the profile of the currently signed-in user.
-
#delete_user_attributes(params = {}) ⇒ Struct
Deletes attributes from the currently signed-in user.
-
#delete_user_pool(params = {}) ⇒ Struct
Deletes a user pool.
-
#delete_user_pool_client(params = {}) ⇒ Struct
Deletes a user pool app client.
-
#delete_user_pool_client_secret(params = {}) ⇒ Struct
Deletes a specific client secret from a user pool app client.
-
#delete_user_pool_domain(params = {}) ⇒ Struct
Given a user pool ID and domain identifier, deletes a user pool domain.
-
#delete_user_pool_replica(params = {}) ⇒ Types::DeleteUserPoolReplicaResponse
Deletes a secondary replica user pool.
-
#delete_web_authn_credential(params = {}) ⇒ Struct
Deletes a registered passkey, or WebAuthn, authenticator for the currently signed-in user.
-
#describe_cimd_policy(params = {}) ⇒ Types::DescribeCIMDPolicyResponse
Returns the configuration of a Client ID Metadata Document (CIMD) policy.
-
#describe_identity_provider(params = {}) ⇒ Types::DescribeIdentityProviderResponse
Given a user pool ID and identity provider (IdP) name, returns details about the IdP.
-
#describe_managed_login_branding(params = {}) ⇒ Types::DescribeManagedLoginBrandingResponse
Given the ID of a managed login branding style, returns detailed information about the style.
-
#describe_managed_login_branding_by_client(params = {}) ⇒ Types::DescribeManagedLoginBrandingByClientResponse
Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.
-
#describe_point_in_time_recovery(params = {}) ⇒ Types::DescribePointInTimeRecoveryResponse
Returns details about a point-in-time recovery of a user pool, including its status and the point in time that it restores the user pool to.
-
#describe_resource_server(params = {}) ⇒ Types::DescribeResourceServerResponse
Describes a resource server.
-
#describe_risk_configuration(params = {}) ⇒ Types::DescribeRiskConfigurationResponse
Given an app client or user pool ID where threat protection is configured, describes the risk configuration.
-
#describe_terms(params = {}) ⇒ Types::DescribeTermsResponse
Returns details for the requested terms documents ID.
-
#describe_terms_by_client(params = {}) ⇒ Types::DescribeTermsByClientResponse
Returns details for the terms documents that are associated with an app client, identified by the app client ID, user pool ID, and terms name.
-
#describe_user_import_job(params = {}) ⇒ Types::DescribeUserImportJobResponse
Describes a user import job.
-
#describe_user_pool(params = {}) ⇒ Types::DescribeUserPoolResponse
Given a user pool ID, returns configuration information.
-
#describe_user_pool_client(params = {}) ⇒ Types::DescribeUserPoolClientResponse
Given an app client ID, returns configuration information.
-
#describe_user_pool_domain(params = {}) ⇒ Types::DescribeUserPoolDomainResponse
Given a user pool domain name, returns information about the domain configuration.
-
#forget_device(params = {}) ⇒ Struct
Given a device key, deletes a remembered device as the currently signed-in user.
-
#forgot_password(params = {}) ⇒ Types::ForgotPasswordResponse
Sends a password-reset confirmation code to the email address or phone number of the requested username.
-
#get_client_token(params = {}) ⇒ Types::GetClientTokenResponse
Issues an access token for machine-to-machine (M2M) authorization.
-
#get_csv_header(params = {}) ⇒ Types::GetCSVHeaderResponse
Given a user pool ID, generates a comma-separated value (CSV) list populated with available user attributes in the user pool.
-
#get_derived_token(params = {}) ⇒ Types::GetDerivedTokenResponse
Exchanges an existing token for a new token that is scoped and audience-bound for a specific downstream service, following the OAuth 2.0 Token Exchange grant type.
-
#get_device(params = {}) ⇒ Types::GetDeviceResponse
Given a device key, returns information about a remembered device for the current user.
-
#get_group(params = {}) ⇒ Types::GetGroupResponse
Given a user pool ID and a group name, returns information about the user group.
-
#get_identity_provider_by_identifier(params = {}) ⇒ Types::GetIdentityProviderByIdentifierResponse
Given the identifier of an identity provider (IdP), for example
examplecorp, returns information about the user pool configuration for that IdP. -
#get_log_delivery_configuration(params = {}) ⇒ Types::GetLogDeliveryConfigurationResponse
Given a user pool ID, returns the logging configuration.
-
#get_provisioned_limit(params = {}) ⇒ Types::GetProvisionedLimitResponse
Returns the current provisioned limit for a specific API category.
-
#get_signing_certificate(params = {}) ⇒ Types::GetSigningCertificateResponse
Given a user pool ID, returns the signing certificate for SAML 2.0 federation.
-
#get_tokens_from_refresh_token(params = {}) ⇒ Types::GetTokensFromRefreshTokenResponse
Given a refresh token, issues new ID, access, and optionally refresh tokens for the user who owns the submitted token.
-
#get_ui_customization(params = {}) ⇒ Types::GetUICustomizationResponse
Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any.
-
#get_user(params = {}) ⇒ Types::GetUserResponse
Gets user attributes and and MFA settings for the currently signed-in user.
-
#get_user_attribute_verification_code(params = {}) ⇒ Types::GetUserAttributeVerificationCodeResponse
Given an attribute name, sends a user attribute verification code for the specified attribute name to the currently signed-in user.
-
#get_user_auth_factors(params = {}) ⇒ Types::GetUserAuthFactorsResponse
Lists the authentication options for the currently signed-in user.
-
#get_user_pool_client_session_configuration(params = {}) ⇒ Types::GetUserPoolClientSessionConfigurationResponse
Retrieves the session configuration for a user pool app client.
-
#get_user_pool_mfa_config(params = {}) ⇒ Types::GetUserPoolMfaConfigResponse
Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA).
-
#get_user_pool_session_configuration(params = {}) ⇒ Types::GetUserPoolSessionConfigurationResponse
Retrieves the session tracking configuration for a user pool, including whether session tracking is enabled and the pool-wide maximum number of active token sessions for each user.
-
#global_sign_out(params = {}) ⇒ Struct
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user.
-
#initiate_auth(params = {}) ⇒ Types::InitiateAuthResponse
Declares an authentication flow and initiates sign-in for a user in the Amazon Cognito user directory.
-
#initiate_point_in_time_recovery(params = {}) ⇒ Types::InitiatePointInTimeRecoveryResponse
Initiates a point-in-time recovery of a user pool to a time in the past that you specify.
-
#list_cimd_policies(params = {}) ⇒ Types::ListCIMDPoliciesResponse
Lists the Client ID Metadata Document (CIMD) policies in a user pool.
-
#list_client_metadata_urls(params = {}) ⇒ Types::ListClientMetadataURLsResponse
Lists the client ID metadata document URLs that Amazon Cognito has received for a Client ID Metadata Document (CIMD) policy, with the cache state of each URL.
-
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
Lists the devices that Amazon Cognito has registered to the currently signed-in user.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Given a user pool ID, returns user pool groups and their details.
-
#list_identity_providers(params = {}) ⇒ Types::ListIdentityProvidersResponse
Given a user pool ID, returns information about configured identity providers (IdPs).
-
#list_point_in_time_recoveries(params = {}) ⇒ Types::ListPointInTimeRecoveriesResponse
Lists the point-in-time recoveries of a user pool, including the active recovery and past recoveries.
-
#list_resource_servers(params = {}) ⇒ Types::ListResourceServersResponse
Given a user pool ID, returns all resource servers and their details.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are assigned to an Amazon Cognito user pool.
-
#list_terms(params = {}) ⇒ Types::ListTermsResponse
Returns details about all terms documents for the requested user pool.
-
#list_user_import_jobs(params = {}) ⇒ Types::ListUserImportJobsResponse
Given a user pool ID, returns user import jobs and their details.
-
#list_user_pool_client_secrets(params = {}) ⇒ Types::ListUserPoolClientSecretsResponse
Lists all client secrets associated with a user pool app client.
-
#list_user_pool_clients(params = {}) ⇒ Types::ListUserPoolClientsResponse
Given a user pool ID, lists app clients.
-
#list_user_pool_replicas(params = {}) ⇒ Types::ListUserPoolReplicasResponse
Lists all replicas for a user pool, including both primary and secondary replicas.
-
#list_user_pools(params = {}) ⇒ Types::ListUserPoolsResponse
Lists user pools and their details in the current Amazon Web Services account.
-
#list_user_sessions(params = {}) ⇒ Types::ListUserSessionsResponse
Lists the active sessions for the currently signed-in user.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Given a user pool ID, returns a list of users and their basic details in a user pool.
-
#list_users_in_group(params = {}) ⇒ Types::ListUsersInGroupResponse
Given a user pool ID and a group name, returns a list of users in the group.
-
#list_web_authn_credentials(params = {}) ⇒ Types::ListWebAuthnCredentialsResponse
Generates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials.
-
#resend_confirmation_code(params = {}) ⇒ Types::ResendConfirmationCodeResponse
Resends the code that confirms a new account for a user who has signed up in your user pool.
-
#respond_to_auth_challenge(params = {}) ⇒ Types::RespondToAuthChallengeResponse
Some API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge.
-
#revoke_token(params = {}) ⇒ Struct
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token.
-
#revoke_user_session(params = {}) ⇒ Struct
Revokes a specific session for the currently signed-in user.
-
#set_log_delivery_configuration(params = {}) ⇒ Types::SetLogDeliveryConfigurationResponse
Sets up or modifies the logging configuration of a user pool.
-
#set_risk_configuration(params = {}) ⇒ Types::SetRiskConfigurationResponse
Configures threat protection for a user pool or app client.
-
#set_ui_customization(params = {}) ⇒ Types::SetUICustomizationResponse
Configures UI branding settings for domains with the hosted UI (classic) branding version.
-
#set_user_mfa_preference(params = {}) ⇒ Struct
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred.
-
#set_user_pool_client_session_configuration(params = {}) ⇒ Types::SetUserPoolClientSessionConfigurationResponse
Sets the session configuration for a user pool app client.
-
#set_user_pool_mfa_config(params = {}) ⇒ Types::SetUserPoolMfaConfigResponse
Sets user pool multi-factor authentication (MFA) and passkey configuration.
-
#set_user_pool_session_configuration(params = {}) ⇒ Types::SetUserPoolSessionConfigurationResponse
Enables or disables session tracking for a user pool, and sets the pool-wide maximum number of active token sessions that each user can have.
-
#set_user_settings(params = {}) ⇒ Struct
This action is no longer supported. You can use it to configure only SMS MFA.
-
#sign_up(params = {}) ⇒ Types::SignUpResponse
Registers a user with an app client and requests a user name, password, and user attributes in the user pool.
-
#start_point_in_time_recovery(params = {}) ⇒ Types::StartPointInTimeRecoveryResponse
Applies a point-in-time recovery to a user pool.
-
#start_user_import_job(params = {}) ⇒ Types::StartUserImportJobResponse
Instructs your user pool to start importing users from a CSV file that contains their usernames and attributes.
-
#start_web_authn_registration(params = {}) ⇒ Types::StartWebAuthnRegistrationResponse
Requests credential creation options from your user pool for the currently signed-in user.
-
#stop_user_import_job(params = {}) ⇒ Types::StopUserImportJobResponse
Instructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes.
-
#tag_resource(params = {}) ⇒ Struct
Assigns a set of tags to an Amazon Cognito user pool.
-
#untag_resource(params = {}) ⇒ Struct
Given tag IDs that you previously assigned to a user pool, removes them.
-
#update_auth_event_feedback(params = {}) ⇒ Struct
Provides the feedback for an authentication event generated by threat protection features.
-
#update_cimd_policy(params = {}) ⇒ Types::UpdateCIMDPolicyResponse
Updates the configuration of a Client ID Metadata Document (CIMD) policy.
-
#update_client_metadata_url_state(params = {}) ⇒ Struct
Changes the cache state of a client metadata document URL for a client ID metadata document (CIMD) policy.
-
#update_device_status(params = {}) ⇒ Struct
Updates the status of a the currently signed-in user's device so that it is marked as remembered or not remembered for the purpose of device authentication.
-
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Given the name of a user pool group, updates any of the properties for precedence, IAM role, or description.
-
#update_identity_provider(params = {}) ⇒ Types::UpdateIdentityProviderResponse
Modifies the configuration and trust relationship between a third-party identity provider (IdP) and a user pool.
-
#update_managed_login_branding(params = {}) ⇒ Types::UpdateManagedLoginBrandingResponse
Configures the branding settings for a user pool style.
-
#update_provisioned_limit(params = {}) ⇒ Types::UpdateProvisionedLimitResponse
Sets the provisioned limit for a specific API category.
-
#update_resource_server(params = {}) ⇒ Types::UpdateResourceServerResponse
Updates the name and scopes of a resource server.
-
#update_terms(params = {}) ⇒ Types::UpdateTermsResponse
Modifies existing terms documents for the requested app client.
-
#update_user_attributes(params = {}) ⇒ Types::UpdateUserAttributesResponse
Updates the currently signed-in user's attributes.
-
#update_user_pool(params = {}) ⇒ Struct
Updates the configuration of a user pool.
-
#update_user_pool_client(params = {}) ⇒ Types::UpdateUserPoolClientResponse
Given a user pool app client ID, updates the configuration.
-
#update_user_pool_domain(params = {}) ⇒ Types::UpdateUserPoolDomainResponse
A user pool domain hosts managed login, an authorization server and web server for authentication in your application.
-
#update_user_pool_replica(params = {}) ⇒ Types::UpdateUserPoolReplicaResponse
Updates replica-specific settings for a user pool replica.
-
#verify_software_token(params = {}) ⇒ Types::VerifySoftwareTokenResponse
Registers the current user's time-based one-time password (TOTP) authenticator with a code generated in their authenticator app from a private key that's supplied by your user pool.
-
#verify_user_attribute(params = {}) ⇒ Struct
Submits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#add_custom_attributes(params = {}) ⇒ Struct
Adds additional user attributes to the user pool schema. Custom
attributes can be mutable or immutable and have a custom: or dev:
prefix. For more information, see Custom attributes.
Learn more
588 589 590 591 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 588 def add_custom_attributes(params = {}, = {}) req = build_request(:add_custom_attributes, params) req.send_request() end |
#add_user_pool_client_secret(params = {}) ⇒ Types::AddUserPoolClientSecretResponse
Creates a new client secret for an existing confidential user pool app client. Supports up to 2 active secrets per app client for zero-downtime credential rotation workflows.
629 630 631 632 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 629 def add_user_pool_client_secret(params = {}, = {}) req = build_request(:add_user_pool_client_secret, params) req.send_request() end |
#admin_add_user_to_group(params = {}) ⇒ Struct
Adds a user to a group. A user who is in a group can present a
preferred-role claim to an identity pool, and populates a
cognito:groups claim to their access and identity tokens.
Learn more
684 685 686 687 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 684 def admin_add_user_to_group(params = {}, = {}) req = build_request(:admin_add_user_to_group, params) req.send_request() end |
#admin_confirm_sign_up(params = {}) ⇒ Struct
Confirms user sign-up as an administrator.
This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can configure your user pool to not send confirmation codes to new users and instead confirm them with this API operation on the back end.
Learn more
To configure your user pool to require administrative confirmation of
users, set AllowAdminCreateUserOnly to true in a CreateUserPool
or UpdateUserPool request.
781 782 783 784 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 781 def admin_confirm_sign_up(params = {}, = {}) req = build_request(:admin_confirm_sign_up, params) req.send_request() end |
#admin_create_user(params = {}) ⇒ Types::AdminCreateUserResponse
Creates a new user in the specified user pool.
If MessageAction isn't 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 create or update a user pool. 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 won't send any email.
In either case, if the user has a password, they will be in the
FORCE_CHANGE_PASSWORD state until they sign in and set their
password. Your invitation message template must have the {####}
password placeholder if your users have passwords. If your template
doesn't have this placeholder, Amazon Cognito doesn't deliver the
invitation message. In this case, you must update your message
template and resend the password with a new AdminCreateUser request
with a MessageAction value of RESEND.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Learn more
1119 1120 1121 1122 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1119 def admin_create_user(params = {}, = {}) req = build_request(:admin_create_user, params) req.send_request() end |
#admin_delete_software_token(params = {}) ⇒ Struct
Deletes a user's registered time-based one-time password (TOTP)
multi-factor authentication (MFA) factor, also known as a software
token. After this operation, the user can no longer sign in with TOTP
MFA, and can register a new TOTP factor with AssociateSoftwareToken.
Use this operation when a user loses access to their TOTP-generating
device, for example, a lost or reset phone, and needs to register a
new one.
Learn more
1174 1175 1176 1177 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1174 def admin_delete_software_token(params = {}, = {}) req = build_request(:admin_delete_software_token, params) req.send_request() end |
#admin_delete_user(params = {}) ⇒ Struct
Deletes a user profile in your user pool.
Learn more
1222 1223 1224 1225 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1222 def admin_delete_user(params = {}, = {}) req = build_request(:admin_delete_user, params) req.send_request() end |
#admin_delete_user_attributes(params = {}) ⇒ Struct
Deletes attribute values from a user. This operation doesn't affect tokens for existing user sessions. The next ID token that the user receives will no longer have the deleted attributes.
Learn more
1280 1281 1282 1283 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1280 def admin_delete_user_attributes(params = {}, = {}) req = build_request(:admin_delete_user_attributes, params) req.send_request() end |
#admin_disable_provider_for_user(params = {}) ⇒ Struct
Prevents the user from signing in with the specified external (SAML or
social) identity provider (IdP). If the user that you want to
deactivate is a Amazon Cognito user pools native username + password
user, they can't use their password to sign in. If the user to
deactivate is a linked external IdP user, any link between that user
and an existing user is removed. When the external user signs in
again, and the user is no longer attached to the previously linked
DestinationUser, the user must create a new user account.
The value of ProviderName must match the name of a user pool IdP.
To deactivate a local user, set ProviderName to Cognito and the
ProviderAttributeName to Cognito_Subject. The
ProviderAttributeValue must be user's local username.
The ProviderAttributeName must always be Cognito_Subject for
social IdPs. The ProviderAttributeValue must always be the exact
subject that was used when the user was originally linked as a source
user.
For de-linking a SAML identity, there are two scenarios. If the linked
identity has not yet been used to sign in, the ProviderAttributeName
and ProviderAttributeValue must be the same values that were used
for the SourceUser when the identities were originally linked using
AdminLinkProviderForUser call. This is also true if the linking was
done with ProviderAttributeName set to Cognito_Subject. If the
user has already signed in, the ProviderAttributeName must be
Cognito_Subject and ProviderAttributeValue must be the NameID
from their SAML assertion.
Learn more
1357 1358 1359 1360 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1357 def admin_disable_provider_for_user(params = {}, = {}) req = build_request(:admin_disable_provider_for_user, params) req.send_request() end |
#admin_disable_user(params = {}) ⇒ Struct
Deactivates a user profile and revokes all access tokens for the user.
A deactivated user can't sign in, but still appears in the responses
to ListUsers API requests.
Learn more
1407 1408 1409 1410 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1407 def admin_disable_user(params = {}, = {}) req = build_request(:admin_disable_user, params) req.send_request() end |
#admin_enable_user(params = {}) ⇒ Struct
Activates sign-in for a user profile that previously had sign-in access disabled.
Learn more
1457 1458 1459 1460 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1457 def admin_enable_user(params = {}, = {}) req = build_request(:admin_enable_user, params) req.send_request() end |
#admin_forget_device(params = {}) ⇒ Struct
Forgets, or deletes, a remembered device from a user's profile. After you forget the device, the user can no longer complete device authentication with that device and when applicable, must submit MFA codes again. For more information, see Working with devices.
Learn more
1513 1514 1515 1516 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1513 def admin_forget_device(params = {}, = {}) req = build_request(:admin_forget_device, params) req.send_request() end |
#admin_get_device(params = {}) ⇒ Types::AdminGetDeviceResponse
Given the device key, returns details for a user's device. For more information, see Working with devices.
Learn more
1579 1580 1581 1582 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1579 def admin_get_device(params = {}, = {}) req = build_request(:admin_get_device, params) req.send_request() end |
#admin_get_user(params = {}) ⇒ Types::AdminGetUserResponse
Given a username, returns details about a user profile in a user pool.
You can specify alias attributes in the Username request parameter.
This operation contributes to your monthly active user (MAU) count for the purpose of billing.
Learn more
1659 1660 1661 1662 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1659 def admin_get_user(params = {}, = {}) req = build_request(:admin_get_user, params) req.send_request() end |
#admin_get_user_auth_factors(params = {}) ⇒ Types::AdminGetUserAuthFactorsResponse
Lists the authentication options for a user in a user pool. Returns the following:
The user's multi-factor authentication (MFA) preferences.
The user's options for choice-based authentication with the
USER_AUTHflow.
Learn more
1728 1729 1730 1731 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1728 def admin_get_user_auth_factors(params = {}, = {}) req = build_request(:admin_get_user_auth_factors, params) req.send_request() end |
#admin_initiate_auth(params = {}) ⇒ Types::AdminInitiateAuthResponse
Starts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that you'd like to begin. The authentication flow that you specify must be supported in your app client configuration. For more information about authentication flows, see Authentication flows.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Learn more
2061 2062 2063 2064 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2061 def admin_initiate_auth(params = {}, = {}) req = build_request(:admin_initiate_auth, params) req.send_request() end |
#admin_link_provider_for_user(params = {}) ⇒ Struct
Links an existing user account in a user pool, or DestinationUser,
to an identity from an external IdP, or SourceUser, based on a
specified attribute name and value from the external IdP.
This operation connects a local user profile with a user identity who
hasn't yet signed in from their third-party IdP. When the user signs
in with their IdP, they get access-control configuration from the
local user profile. Linked local users can also sign in with SDK-based
API operations like InitiateAuth after they sign in at least once
through their IdP. For more information, see Linking federated
users.
Because this API allows a user with an external federated identity to sign in as a local user, it is critical that it only be used with external IdPs and linked attributes that you trust.
Learn more
2178 2179 2180 2181 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2178 def admin_link_provider_for_user(params = {}, = {}) req = build_request(:admin_link_provider_for_user, params) req.send_request() end |
#admin_list_devices(params = {}) ⇒ Types::AdminListDevicesResponse
Lists a user's registered devices. Remembered devices are used in authentication services where you offer a "Remember me" option for users who you want to permit to sign in without MFA from a trusted device. Users can bypass MFA while your application performs device SRP authentication on the back end. For more information, see Working with devices.
Learn more
2261 2262 2263 2264 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2261 def admin_list_devices(params = {}, = {}) req = build_request(:admin_list_devices, params) req.send_request() end |
#admin_list_groups_for_user(params = {}) ⇒ Types::AdminListGroupsForUserResponse
Lists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2344 2345 2346 2347 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2344 def admin_list_groups_for_user(params = {}, = {}) req = build_request(:admin_list_groups_for_user, params) req.send_request() end |
#admin_list_user_auth_events(params = {}) ⇒ Types::AdminListUserAuthEventsResponse
Requests a history of user activity and any risks detected as part of Amazon Cognito threat protection. For more information, see Viewing user event history.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2439 2440 2441 2442 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2439 def admin_list_user_auth_events(params = {}, = {}) req = build_request(:admin_list_user_auth_events, params) req.send_request() end |
#admin_list_user_sessions(params = {}) ⇒ Types::AdminListUserSessionsResponse
Lists the active sessions for a specified user as an administrator. The response includes both token sessions and SSO sessions. Only active sessions are returned; revoked and expired sessions aren't included. Amazon Cognito returns all of a user's sessions in a single page of up to 125 sessions. The results are eventually consistent, and new sessions are typically included within a few seconds.
2541 2542 2543 2544 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2541 def admin_list_user_sessions(params = {}, = {}) req = build_request(:admin_list_user_sessions, params) req.send_request() end |
#admin_remove_user_from_group(params = {}) ⇒ Struct
Given a username and a group name, removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
Learn more
2600 2601 2602 2603 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2600 def admin_remove_user_from_group(params = {}, = {}) req = build_request(:admin_remove_user_from_group, params) req.send_request() end |
#admin_reset_user_password(params = {}) ⇒ Struct
Begins the password reset process. Sets the requested user’s account
into a RESET_REQUIRED status, and sends them a password-reset code.
Your user pool also sends the user a notification with a reset code
and the information that their password has been reset. At sign-in,
your application or the managed login session receives a challenge to
complete the reset by confirming the code and setting a new password.
To use this API operation, your user pool must have self-service account recovery configured.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Learn more
2717 2718 2719 2720 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2717 def admin_reset_user_password(params = {}, = {}) req = build_request(:admin_reset_user_password, params) req.send_request() end |
#admin_respond_to_auth_challenge(params = {}) ⇒ Types::AdminRespondToAuthChallengeResponse
Some API operations in a user pool generate a challenge, like a prompt
for an MFA code, for device authentication that bypasses MFA, or for a
custom authentication challenge. An AdminRespondToAuthChallenge API
request provides the answer to that challenge, like a code or a secure
remote password (SRP). The parameters of a response to an
authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Learn more
3154 3155 3156 3157 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3154 def admin_respond_to_auth_challenge(params = {}, = {}) req = build_request(:admin_respond_to_auth_challenge, params) req.send_request() end |
#admin_revoke_user_session(params = {}) ⇒ Struct
Revokes a specific user session as an administrator. Amazon Cognito revokes all refresh and access tokens that are associated with the session and deletes the session record. You can revoke either a token session or an SSO session, and you can optionally cascade the revocation to linked sessions.
3221 3222 3223 3224 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3221 def admin_revoke_user_session(params = {}, = {}) req = build_request(:admin_revoke_user_session, params) req.send_request() end |
#admin_set_user_mfa_preference(params = {}) ⇒ Struct
Sets the user's multi-factor authentication (MFA) preference, including which MFA options are activated, 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 activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
Learn more
3323 3324 3325 3326 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3323 def admin_set_user_mfa_preference(params = {}, = {}) req = build_request(:admin_set_user_mfa_preference, params) req.send_request() end |
#admin_set_user_password(params = {}) ⇒ Struct
Sets the specified user's password in a user pool. This operation
administratively sets a temporary or permanent password for a user.
With this operation, you can bypass self-service password changes and
permit immediate sign-in with the password that you set. To do this,
set Permanent to true.
You can also set a new temporary password in this request, send it to
a user, and require them to choose a new password on their next
sign-in. To do this, set Permanent to false.
If the password is temporary, the user's Status becomes
FORCE_CHANGE_PASSWORD. When the user next tries to sign in, the
InitiateAuth or AdminInitiateAuth response includes the
NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in before
the temporary password expires, they can no longer sign in and you
must repeat this operation to set a temporary or permanent password
for them.
After the user sets a new password, or if you set a permanent
password, their status becomes Confirmed.
AdminSetUserPassword can set a password for the user profile that
Amazon Cognito creates for third-party federated users. When you set a
password, the federated user's status changes from
EXTERNAL_PROVIDER to CONFIRMED. A user in this state can sign in
as a federated user, and initiate authentication flows in the API like
a linked native user. They can also modify their password and
attributes in token-authenticated API requests like ChangePassword
and UpdateUserAttributes. As a best security practice and to keep
users in sync with your external IdP, don't set passwords on
federated user profiles. To set up a federated user for native sign-in
with a linked native user, refer to Linking federated users to an
existing user profile.
Learn more
3417 3418 3419 3420 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3417 def admin_set_user_password(params = {}, = {}) req = build_request(:admin_set_user_password, params) req.send_request() end |
#admin_set_user_settings(params = {}) ⇒ Struct
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA.
Learn more
3478 3479 3480 3481 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3478 def admin_set_user_settings(params = {}, = {}) req = build_request(:admin_set_user_settings, params) req.send_request() end |
#admin_update_auth_event_feedback(params = {}) ⇒ Struct
Provides the feedback for an authentication event generated by threat protection features. Your response indicates that you think that the event either was from a valid user or was an unwanted authentication attempt. This feedback improves the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. To activate this setting, your user pool must be on the Plus tier.
To train the threat-protection model to recognize trusted and untrusted sign-in characteristics, configure threat protection in audit-only mode and provide a mechanism for users or administrators to submit feedback. Your feedback can tell Amazon Cognito that a risk rating was assigned at a level you don't agree with.
Learn more
3553 3554 3555 3556 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3553 def admin_update_auth_event_feedback(params = {}, = {}) req = build_request(:admin_update_auth_event_feedback, params) req.send_request() end |
#admin_update_device_status(params = {}) ⇒ Struct
Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices.
Learn more
3620 3621 3622 3623 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3620 def admin_update_device_status(params = {}, = {}) req = build_request(:admin_update_device_status, params) req.send_request() end |
#admin_update_user_attributes(params = {}) ⇒ Struct
Updates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value.
For custom attributes, you must add a custom: prefix to the
attribute name, for example custom:department.
This operation can set a user's email address or phone number as
verified and permit immediate sign-in in user pools that require
verification of these attributes. To do this, set the email_verified
or phone_number_verified attribute to true.
Learn more
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
3767 3768 3769 3770 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3767 def admin_update_user_attributes(params = {}, = {}) req = build_request(:admin_update_user_attributes, params) req.send_request() end |
#admin_user_global_sign_out(params = {}) ⇒ Struct
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your user signs out of your app. This results in the following behavior.
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin.Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider.Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
Learn more
3846 3847 3848 3849 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3846 def admin_user_global_sign_out(params = {}, = {}) req = build_request(:admin_user_global_sign_out, params) req.send_request() end |
#associate_software_token(params = {}) ⇒ Types::AssociateSoftwareTokenResponse
Begins setup of time-based one-time password (TOTP) multi-factor
authentication (MFA) for a user, with a unique private key that Amazon
Cognito generates and returns in the API response. You can authorize
an AssociateSoftwareToken request with either the user's access
token, or a session string from a challenge response that you received
from Amazon Cognito.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
3908 3909 3910 3911 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3908 def associate_software_token(params = {}, = {}) req = build_request(:associate_software_token, params) req.send_request() end |
#cancel_point_in_time_recovery(params = {}) ⇒ Types::CancelPointInTimeRecoveryResponse
Cancels a point-in-time recovery of a user pool before Amazon Cognito
applies any changes. You can cancel a recovery when its status is
PREVIEW_GENERATING or PREVIEW_GENERATED. When you cancel a
recovery, Amazon Cognito discards the recovery preview, resumes write
operations in the user pool, and sets the status of the recovery to
PREVIEW_CANCELLED. Your user pool data doesn't change.
You can't cancel a recovery after you start it with a request.
Learn more
3975 3976 3977 3978 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3975 def cancel_point_in_time_recovery(params = {}, = {}) req = build_request(:cancel_point_in_time_recovery, params) req.send_request() end |
#change_password(params = {}) ⇒ Struct
Changes the password for the currently signed-in user.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
4025 4026 4027 4028 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4025 def change_password(params = {}, = {}) req = build_request(:change_password, params) req.send_request() end |
#complete_web_authn_registration(params = {}) ⇒ Struct
Completes registration of a passkey authenticator for the currently signed-in user.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
4068 4069 4070 4071 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4068 def complete_web_authn_registration(params = {}, = {}) req = build_request(:complete_web_authn_registration, params) req.send_request() end |
#confirm_device(params = {}) ⇒ Types::ConfirmDeviceResponse
Confirms a device that a user wants to remember. A remembered device is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
4136 4137 4138 4139 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4136 def confirm_device(params = {}, = {}) req = build_request(:confirm_device, params) req.send_request() end |
#confirm_forgot_password(params = {}) ⇒ Struct
This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.
4267 4268 4269 4270 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4267 def confirm_forgot_password(params = {}, = {}) req = build_request(:confirm_forgot_password, params) req.send_request() end |
#confirm_sign_up(params = {}) ⇒ Types::ConfirmSignUpResponse
Confirms the account of a new user. This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP.
4437 4438 4439 4440 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4437 def confirm_sign_up(params = {}, = {}) req = build_request(:confirm_sign_up, params) req.send_request() end |
#create_cimd_policy(params = {}) ⇒ Types::CreateCIMDPolicyResponse
Creates a Client ID Metadata Document (CIMD) policy for an app client. A CIMD policy lets OAuth clients identify themselves to your user pool with an HTTPS URL as their client ID. Amazon Cognito retrieves the client metadata document from that URL and accepts the client only when the URL matches one of the URL patterns in the policy.
Learn more
4517 4518 4519 4520 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4517 def create_cimd_policy(params = {}, = {}) req = build_request(:create_cimd_policy, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Creates a new group in the specified user pool. For more information about user pool groups, see Adding groups to a user pool.
Learn more
4610 4611 4612 4613 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4610 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_identity_provider(params = {}) ⇒ Types::CreateIdentityProviderResponse
Adds a configuration and trust relationship between a third-party identity provider (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in.
Learn more
4851 4852 4853 4854 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4851 def create_identity_provider(params = {}, = {}) req = build_request(:create_identity_provider, params) req.send_request() end |
#create_managed_login_branding(params = {}) ⇒ Types::CreateManagedLoginBrandingResponse
Creates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding editor.
Provides values for UI customization in a Settings JSON object and
image files in an Assets array. To send the JSON object Document
type parameter in Settings, you might need to update to the most
recent version of your Amazon Web Services SDK. To create a new style
with default settings, set UseCognitoProvidedValues to true and
don't provide values for any other options.
This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
Learn more
4979 4980 4981 4982 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4979 def create_managed_login_branding(params = {}, = {}) req = build_request(:create_managed_login_branding, params) req.send_request() end |
#create_resource_server(params = {}) ⇒ Types::CreateResourceServerResponse
Creates a new OAuth2.0 resource server and defines custom scopes within it. Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Learn more
5062 5063 5064 5065 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 5062 def create_resource_server(params = {}, = {}) req = build_request(:create_resource_server, params) req.send_request() end |
#create_terms(params = {}) ⇒ Types::CreateTermsResponse
Creates terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client.
You can provide URLs for terms documents in the languages that are
supported by managed login localization. Amazon Cognito directs
users to the terms documents for their current language, with fallback
to default if no document exists for the language.
Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests.
For more information, see Terms documents.
Learn more
5168 5169 5170 5171 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 5168 def create_terms(params = {}, = {}) req = build_request(:create_terms, params) req.send_request() end |
#create_user_import_job(params = {}) ⇒ Types::CreateUserImportJobResponse
Creates a user import job. You can import users into user pools from a comma-separated values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill.
Learn more
5246 5247 5248 5249 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 5246 def create_user_import_job(params = {}, = {}) req = build_request(:create_user_import_job, params) req.send_request() end |
#create_user_pool(params = {}) ⇒ Types::CreateUserPoolResponse
Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration options.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Learn more
6324 6325 6326 6327 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6324 def create_user_pool(params = {}, = {}) req = build_request(:create_user_pool, params) req.send_request() end |
#create_user_pool_client(params = {}) ⇒ Types::CreateUserPoolClientResponse
Creates an app client in a user pool. This operation sets basic and advanced configuration options.
Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Learn more
6976 6977 6978 6979 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6976 def create_user_pool_client(params = {}, = {}) req = build_request(:create_user_pool_client, params) req.send_request() end |
#create_user_pool_domain(params = {}) ⇒ Types::CreateUserPoolDomainResponse
A user pool domain hosts managed login, an authorization server and
web server for authentication in your application. This operation
creates a new user pool prefix domain or custom domain and sets the
managed login branding version. Set the branding version to 1 for
hosted UI (classic) or 2 for managed login. When you choose a custom
domain, you must provide an SSL certificate in the US East (N.
Virginia) Amazon Web Services Region in your request.
Your prefix domain might take up to one minute to take effect. Your custom domain is online within five minutes, but it can take up to one hour to distribute your SSL certificate.
For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
Learn more
7105 7106 7107 7108 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7105 def create_user_pool_domain(params = {}, = {}) req = build_request(:create_user_pool_domain, params) req.send_request() end |
#create_user_pool_replica(params = {}) ⇒ Types::CreateUserPoolReplicaResponse
Creates a replica of an existing user pool in a specified Amazon Web Services Region. The replica enables multi-region replication for high availability and disaster recovery. To create a replica, you must have permissions to create user pools in the target Region.
Learn more
7190 7191 7192 7193 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7190 def create_user_pool_replica(params = {}, = {}) req = build_request(:create_user_pool_replica, params) req.send_request() end |
#delete_cimd_policy(params = {}) ⇒ Struct
Deletes a Client ID Metadata Document (CIMD) policy.
Learn more
7234 7235 7236 7237 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7234 def delete_cimd_policy(params = {}, = {}) req = build_request(:delete_cimd_policy, params) req.send_request() end |
#delete_group(params = {}) ⇒ Struct
Deletes a group from the specified user pool. When you delete a group,
that group no longer contributes to users' cognito:preferred_group
or cognito:groups claims, and no longer influence access-control
decision that are based on group membership. For more information
about user pool groups, see Adding groups to a user pool.
Learn more
7283 7284 7285 7286 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7283 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_identity_provider(params = {}) ⇒ Struct
Deletes a user pool identity provider (IdP). After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information about user pool IdPs, see Third-party IdP sign-in.
Learn more
7332 7333 7334 7335 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7332 def delete_identity_provider(params = {}, = {}) req = build_request(:delete_identity_provider, params) req.send_request() end |
#delete_managed_login_branding(params = {}) ⇒ Struct
Deletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version.
Learn more
7381 7382 7383 7384 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7381 def delete_managed_login_branding(params = {}, = {}) req = build_request(:delete_managed_login_branding, params) req.send_request() end |
#delete_resource_server(params = {}) ⇒ Struct
Deletes a resource server. After you delete a resource server, users can no longer generate access tokens with scopes that are associate with that resource server.
Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Learn more
7432 7433 7434 7435 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7432 def delete_resource_server(params = {}, = {}) req = build_request(:delete_resource_server, params) req.send_request() end |
#delete_terms(params = {}) ⇒ Struct
Deletes the terms documents with the requested ID from your app client.
Learn more
7478 7479 7480 7481 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7478 def delete_terms(params = {}, = {}) req = build_request(:delete_terms, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes the profile of the currently signed-in user. A deleted user profile can no longer be used to sign in and can't be restored.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
7519 7520 7521 7522 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7519 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#delete_user_attributes(params = {}) ⇒ Struct
Deletes attributes from the currently signed-in user. For example,
your application can submit a request to this operation when a user
wants to remove their birthdate attribute value.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
7569 7570 7571 7572 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7569 def delete_user_attributes(params = {}, = {}) req = build_request(:delete_user_attributes, params) req.send_request() end |
#delete_user_pool(params = {}) ⇒ Struct
Deletes a user pool. After you delete a user pool, users can no longer sign in to any associated applications.
When you delete a user pool, it's no longer visible or operational in your Amazon Web Services account. Amazon Cognito retains deleted user pools in an inactive state for 14 days, then begins a cleanup process that fully removes them from Amazon Web Services systems. In case of accidental deletion, contact Amazon Web Services Support within 14 days for restoration assistance.
Amazon Cognito begins full deletion of all resources from deleted user pools after 14 days. In the case of large user pools, the cleanup process might take significant additional time before all user data is permanently deleted.
7604 7605 7606 7607 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7604 def delete_user_pool(params = {}, = {}) req = build_request(:delete_user_pool, params) req.send_request() end |
#delete_user_pool_client(params = {}) ⇒ Struct
Deletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.
7631 7632 7633 7634 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7631 def delete_user_pool_client(params = {}, = {}) req = build_request(:delete_user_pool_client, params) req.send_request() end |
#delete_user_pool_client_secret(params = {}) ⇒ Struct
Deletes a specific client secret from a user pool app client. You cannot delete the last remaining secret for an app client.
7662 7663 7664 7665 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7662 def delete_user_pool_client_secret(params = {}, = {}) req = build_request(:delete_user_pool_client_secret, params) req.send_request() end |
#delete_user_pool_domain(params = {}) ⇒ Struct
Given a user pool ID and domain identifier, deletes a user pool domain. After you delete a user pool domain, your managed login pages and authorization server are no longer available.
7692 7693 7694 7695 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7692 def delete_user_pool_domain(params = {}, = {}) req = build_request(:delete_user_pool_domain, params) req.send_request() end |
#delete_user_pool_replica(params = {}) ⇒ Types::DeleteUserPoolReplicaResponse
Deletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary Region.
Learn more
7767 7768 7769 7770 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7767 def delete_user_pool_replica(params = {}, = {}) req = build_request(:delete_user_pool_replica, params) req.send_request() end |
#delete_web_authn_credential(params = {}) ⇒ Struct
Deletes a registered passkey, or WebAuthn, authenticator for the currently signed-in user.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
7812 7813 7814 7815 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7812 def delete_web_authn_credential(params = {}, = {}) req = build_request(:delete_web_authn_credential, params) req.send_request() end |
#describe_cimd_policy(params = {}) ⇒ Types::DescribeCIMDPolicyResponse
Returns the configuration of a Client ID Metadata Document (CIMD) policy.
Learn more
7871 7872 7873 7874 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7871 def describe_cimd_policy(params = {}, = {}) req = build_request(:describe_cimd_policy, params) req.send_request() end |
#describe_identity_provider(params = {}) ⇒ Types::DescribeIdentityProviderResponse
Given a user pool ID and identity provider (IdP) name, returns details about the IdP.
7916 7917 7918 7919 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7916 def describe_identity_provider(params = {}, = {}) req = build_request(:describe_identity_provider, params) req.send_request() end |
#describe_managed_login_branding(params = {}) ⇒ Types::DescribeManagedLoginBrandingResponse
Given the ID of a managed login branding style, returns detailed information about the style.
7968 7969 7970 7971 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7968 def describe_managed_login_branding(params = {}, = {}) req = build_request(:describe_managed_login_branding, params) req.send_request() end |
#describe_managed_login_branding_by_client(params = {}) ⇒ Types::DescribeManagedLoginBrandingByClientResponse
Given the ID of a user pool app client, returns detailed information about the style assigned to the app client.
8020 8021 8022 8023 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8020 def describe_managed_login_branding_by_client(params = {}, = {}) req = build_request(:describe_managed_login_branding_by_client, params) req.send_request() end |
#describe_point_in_time_recovery(params = {}) ⇒ Types::DescribePointInTimeRecoveryResponse
Returns details about a point-in-time recovery of a user pool, including its status and the point in time that it restores the user pool to. After Amazon Cognito generates the recovery preview, the response also includes the number of entities that the recovery creates, updates, and deletes. Review the preview before you apply the recovery with a request or discard it with a request.
Learn more
8086 8087 8088 8089 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8086 def describe_point_in_time_recovery(params = {}, = {}) req = build_request(:describe_point_in_time_recovery, params) req.send_request() end |
#describe_resource_server(params = {}) ⇒ Types::DescribeResourceServerResponse
Describes a resource server. For more information about resource servers, see Access control with resource servers.
8136 8137 8138 8139 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8136 def describe_resource_server(params = {}, = {}) req = build_request(:describe_resource_server, params) req.send_request() end |
#describe_risk_configuration(params = {}) ⇒ Types::DescribeRiskConfigurationResponse
Given an app client or user pool ID where threat protection is configured, describes the risk configuration. This operation returns details about adaptive authentication, compromised credentials, and IP-address allow- and denylists. For more information about threat protection, see Threat protection.
8211 8212 8213 8214 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8211 def describe_risk_configuration(params = {}, = {}) req = build_request(:describe_risk_configuration, params) req.send_request() end |
#describe_terms(params = {}) ⇒ Types::DescribeTermsResponse
Returns details for the requested terms documents ID. For more information, see Terms documents.
Learn more
8273 8274 8275 8276 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8273 def describe_terms(params = {}, = {}) req = build_request(:describe_terms, params) req.send_request() end |
#describe_terms_by_client(params = {}) ⇒ Types::DescribeTermsByClientResponse
Returns details for the terms documents that are associated with an app client, identified by the app client ID, user pool ID, and terms name. For more information, see Terms documents.
To call DescribeTermsByClient, you must have the
cognito-idp:DescribeTermsByClient Identity and Access Management
(IAM) permission. An IAM policy that denies
cognito-idp:DescribeTerms also denies requests to
DescribeTermsByClient.
Learn more
8346 8347 8348 8349 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8346 def describe_terms_by_client(params = {}, = {}) req = build_request(:describe_terms_by_client, params) req.send_request() end |
#describe_user_import_job(params = {}) ⇒ Types::DescribeUserImportJobResponse
Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.
8396 8397 8398 8399 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8396 def describe_user_import_job(params = {}, = {}) req = build_request(:describe_user_import_job, params) req.send_request() end |
#describe_user_pool(params = {}) ⇒ Types::DescribeUserPoolResponse
Given a user pool ID, returns configuration information. This operation is useful when you want to inspect an existing user pool and programmatically replicate the configuration to another user pool.
Learn more
8556 8557 8558 8559 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8556 def describe_user_pool(params = {}, = {}) req = build_request(:describe_user_pool, params) req.send_request() end |
#describe_user_pool_client(params = {}) ⇒ Types::DescribeUserPoolClientResponse
Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients.
Learn more
8653 8654 8655 8656 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8653 def describe_user_pool_client(params = {}, = {}) req = build_request(:describe_user_pool_client, params) req.send_request() end |
#describe_user_pool_domain(params = {}) ⇒ Types::DescribeUserPoolDomainResponse
Given a user pool domain name, returns information about the domain configuration.
Learn more
8721 8722 8723 8724 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8721 def describe_user_pool_domain(params = {}, = {}) req = build_request(:describe_user_pool_domain, params) req.send_request() end |
#forget_device(params = {}) ⇒ Struct
Given a device key, deletes a remembered device as the currently signed-in user. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
8769 8770 8771 8772 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8769 def forget_device(params = {}, = {}) req = build_request(:forget_device, params) req.send_request() end |
#forgot_password(params = {}) ⇒ Types::ForgotPasswordResponse
Sends a password-reset confirmation code to the email address or phone
number of the requested username. The message delivery method is
determined by the user's available attributes and the
AccountRecoverySetting configuration of the user pool.
For the Username parameter, you can use the username or an email,
phone, or preferred username alias.
If neither a verified phone number nor a verified email exists, Amazon
Cognito responds with an InvalidParameterException error . If your
app client has a client secret and you don't provide a SECRET_HASH
parameter, this API returns NotAuthorizedException.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
8930 8931 8932 8933 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8930 def forgot_password(params = {}, = {}) req = build_request(:forgot_password, params) req.send_request() end |
#get_client_token(params = {}) ⇒ Types::GetClientTokenResponse
Issues an access token for machine-to-machine (M2M) authorization. Your app client provides its client ID and secret, and receives an access token that authorizes requests to your resource servers.
To use this operation, you must configure the app client with a client
secret and enable the ALLOW_CLIENT_TOKEN_AUTH authentication flow.
The ALLOW_CLIENT_TOKEN_AUTH flow is mutually exclusive with user
authentication flows. It must be the only authentication flow that you
configure for the app client. For more information, see Scopes, M2M,
and resource servers.
9114 9115 9116 9117 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9114 def get_client_token(params = {}, = {}) req = build_request(:get_client_token, params) req.send_request() end |
#get_csv_header(params = {}) ⇒ Types::GetCSVHeaderResponse
Given a user pool ID, generates a comma-separated value (CSV) list
populated with available user attributes in the user pool. This list
is the header for the CSV file that determines the users in a user
import job. Save the content of CSVHeader in the response as a
.csv file and populate it with the usernames and attributes of users
that you want to import. For more information about CSV user import,
see Importing users from a CSV file.
Learn more
8986 8987 8988 8989 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 8986 def get_csv_header(params = {}, = {}) req = build_request(:get_csv_header, params) req.send_request() end |
#get_derived_token(params = {}) ⇒ Types::GetDerivedTokenResponse
Exchanges an existing token for a new token that is scoped and
audience-bound for a specific downstream service, following the OAuth
2.0 Token Exchange grant type. For more information about the OAuth
2.0 Token Exchange grant type, see RFC 8693 - OAuth 2.0 Token
Exchange on the IETF website. Present a SubjectToken, the
credential that you already hold, to receive a new token appropriate
for calling a specific resource server or audience.
If you also present an ActorToken that identifies an intermediary
service, the issued token carries an act claim that identifies the
intermediary, and downstream services can distinguish a user acting
directly from an intermediary acting on the user's behalf. If you
don't present an ActorToken, the issued token appears as if the
user acted directly.
To use this operation, you must have IAM credentials, or you must
present the requesting app client's ClientId and, if the client has
a secret, ClientSecret, in the request.
The requesting app client must have
ALLOW_TOKEN_EXCHANGE_IMPERSONATION or
ALLOW_TOKEN_EXCHANGE_DELEGATION in its ExplicitAuthFlows
(depending on whether you include an ActorToken), or the request
fails.
9295 9296 9297 9298 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9295 def get_derived_token(params = {}, = {}) req = build_request(:get_derived_token, params) req.send_request() end |
#get_device(params = {}) ⇒ Types::GetDeviceResponse
Given a device key, returns information about a remembered device for the current user. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
9354 9355 9356 9357 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9354 def get_device(params = {}, = {}) req = build_request(:get_device, params) req.send_request() end |
#get_group(params = {}) ⇒ Types::GetGroupResponse
Given a user pool ID and a group name, returns information about the user group.
For more information about user pool groups, see Adding groups to a user pool.
Learn more
9416 9417 9418 9419 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9416 def get_group(params = {}, = {}) req = build_request(:get_group, params) req.send_request() end |
#get_identity_provider_by_identifier(params = {}) ⇒ Types::GetIdentityProviderByIdentifierResponse
Given the identifier of an identity provider (IdP), for example
examplecorp, returns information about the user pool configuration
for that IdP. For more information about IdPs, see Third-party IdP
sign-in.
9471 9472 9473 9474 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9471 def get_identity_provider_by_identifier(params = {}, = {}) req = build_request(:get_identity_provider_by_identifier, params) req.send_request() end |
#get_log_delivery_configuration(params = {}) ⇒ Types::GetLogDeliveryConfigurationResponse
Given a user pool ID, returns the logging configuration. User pools can export message-delivery error and threat-protection activity logs to external Amazon Web Services services. For more information, see Exporting user pool logs.
Learn more
9528 9529 9530 9531 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9528 def get_log_delivery_configuration(params = {}, = {}) req = build_request(:get_log_delivery_configuration, params) req.send_request() end |
#get_provisioned_limit(params = {}) ⇒ Types::GetProvisionedLimitResponse
Returns the current provisioned limit for a specific API category.
Learn more
9612 9613 9614 9615 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9612 def get_provisioned_limit(params = {}, = {}) req = build_request(:get_provisioned_limit, params) req.send_request() end |
#get_signing_certificate(params = {}) ⇒ Types::GetSigningCertificateResponse
Given a user pool ID, returns the signing certificate for SAML 2.0 federation.
Issued certificates are valid for 10 years from the date of issue.
Amazon Cognito issues and assigns a new signing certificate annually.
This renewal process returns a new value in the response to
GetSigningCertificate, but doesn't invalidate the original
certificate.
For more information, see Signing SAML requests.
Learn more
9669 9670 9671 9672 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9669 def get_signing_certificate(params = {}, = {}) req = build_request(:get_signing_certificate, params) req.send_request() end |
#get_tokens_from_refresh_token(params = {}) ⇒ Types::GetTokensFromRefreshTokenResponse
Given a refresh token, issues new ID, access, and optionally refresh tokens for the user who owns the submitted token. This operation issues a new refresh token and invalidates the original refresh token after an optional grace period when refresh token rotation is enabled. If refresh token rotation is disabled, issues new ID and access tokens only.
9777 9778 9779 9780 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9777 def get_tokens_from_refresh_token(params = {}, = {}) req = build_request(:get_tokens_from_refresh_token, params) req.send_request() end |
#get_ui_customization(params = {}) ⇒ Types::GetUICustomizationResponse
Given a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI (classic) branding.
9824 9825 9826 9827 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9824 def get_ui_customization(params = {}, = {}) req = build_request(:get_ui_customization, params) req.send_request() end |
#get_user(params = {}) ⇒ Types::GetUserResponse
Gets user attributes and and MFA settings for the currently signed-in user.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
9884 9885 9886 9887 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9884 def get_user(params = {}, = {}) req = build_request(:get_user, params) req.send_request() end |
#get_user_attribute_verification_code(params = {}) ⇒ Types::GetUserAttributeVerificationCodeResponse
Given an attribute name, sends a user attribute verification code for the specified attribute name to the currently signed-in user.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
9999 10000 10001 10002 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 9999 def get_user_attribute_verification_code(params = {}, = {}) req = build_request(:get_user_attribute_verification_code, params) req.send_request() end |
#get_user_auth_factors(params = {}) ⇒ Types::GetUserAuthFactorsResponse
Lists the authentication options for the currently signed-in user. Returns the following:
The user's multi-factor authentication (MFA) preferences.
The user's options for choice-based authentication with the
USER_AUTHflow.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
10059 10060 10061 10062 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10059 def get_user_auth_factors(params = {}, = {}) req = build_request(:get_user_auth_factors, params) req.send_request() end |
#get_user_pool_client_session_configuration(params = {}) ⇒ Types::GetUserPoolClientSessionConfigurationResponse
Retrieves the session configuration for a user pool app client. If you
have never called SetUserPoolClientSessionConfiguration for the app
client, this operation returns the default SSO session maximum
validity of 60 minutes.
10119 10120 10121 10122 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10119 def get_user_pool_client_session_configuration(params = {}, = {}) req = build_request(:get_user_pool_client_session_configuration, params) req.send_request() end |
#get_user_pool_mfa_config(params = {}) ⇒ Types::GetUserPoolMfaConfigResponse
Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the following:
The WebAuthn relying party (RP) ID and user-verification settings.
The required, optional, or disabled state of MFA for all user pool users.
The message templates for email and SMS MFA.
The enabled or disabled state of time-based one-time password (TOTP) MFA.
Learn more
10199 10200 10201 10202 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10199 def get_user_pool_mfa_config(params = {}, = {}) req = build_request(:get_user_pool_mfa_config, params) req.send_request() end |
#get_user_pool_session_configuration(params = {}) ⇒ Types::GetUserPoolSessionConfigurationResponse
Retrieves the session tracking configuration for a user pool,
including whether session tracking is enabled and the pool-wide
maximum number of active token sessions for each user. If you have
never called SetUserPoolSessionConfiguration for the user pool, this
operation returns the default values: UserSessionTracking as
DISABLED and a MaxPerUser value of 20.
10256 10257 10258 10259 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10256 def get_user_pool_session_configuration(params = {}, = {}) req = build_request(:get_user_pool_session_configuration, params) req.send_request() end |
#global_sign_out(params = {}) ⇒ Struct
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior.
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin.Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider.Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
10326 10327 10328 10329 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10326 def global_sign_out(params = {}, = {}) req = build_request(:global_sign_out, params) req.send_request() end |
#initiate_auth(params = {}) ⇒ Types::InitiateAuthResponse
Declares an authentication flow and initiates sign-in for a user in
the Amazon Cognito user directory. Amazon Cognito might respond with
an additional challenge or an AuthenticationResult that contains the
outcome of a successful authentication. You can't sign in a user with
a federated IdP with InitiateAuth. For more information, see
Authentication.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
10687 10688 10689 10690 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10687 def initiate_auth(params = {}, = {}) req = build_request(:initiate_auth, params) req.send_request() end |
#initiate_point_in_time_recovery(params = {}) ⇒ Types::InitiatePointInTimeRecoveryResponse
Initiates a point-in-time recovery of a user pool to a time in the
past that you specify. This operation is the first step of a recovery
and doesn't change your user pool data. Amazon Cognito pauses write
operations in the user pool and generates a recovery preview, which
might not be available immediately. The preview shows the number of
entities that the recovery creates, updates, and deletes. To check the
status of the recovery and review the preview, make a request. When
the status is PREVIEW_GENERATED, apply the recovery with a request
or discard it with a request. The time that it takes to generate the
recovery preview doesn't depend on the size of your user pool.
Point-in-time recovery is a disaster recovery feature. Use it to recover from accidental or unauthorized changes that affect your user data, for example the deletion or corruption of many users. Don't use point-in-time recovery to remove users that were created recently or to revert changes to individual users. To delete or update individual users, use operations like and .
While a recovery is in progress, Amazon Cognito blocks operations that write to the user pool, for example user sign-up, user creation, and attribute updates. Sign-in and read operations continue to work, with the following exceptions:
Users who must set a new password, set up MFA, or respond to a TOTP MFA challenge can't complete sign-in. Sign-in with the
NEW_PASSWORD_REQUIRED,MFA_SETUP, andSOFTWARE_TOKEN_MFAchallenges fails until the recovery ends.Federated users can sign in only if they have previously signed in to the user pool and their attributes from the external identity provider haven't changed.
You can't create or start user import jobs. Start your import jobs after the recovery ends.
If you don't start or cancel the recovery within 24 hours after you initiate it, the recovery preview expires. Amazon Cognito then resumes write operations and doesn't change your user pool data. The 24-hour period includes the time that Amazon Cognito takes to generate the recovery preview.
A point-in-time recovery restores user data, including user profiles and attributes, group memberships, passwords, MFA settings, and passkeys. It doesn't restore user pool configuration, for example app clients, the attribute schema, encryption settings, or multi-Region replication settings. Users who changed their password after the recovery point keep their current password.
The following requirements and limits apply to point-in-time recovery:
Your user pool must be on the Essentials or Plus feature plan. With the Essentials feature plan, you can recover your user pool to a point in time up to 1 day in the past. With the Plus feature plan, you can recover up to 14 days in the past. Your user pool must have been on the required feature plan at the recovery point. For example, to recover to a point in time 14 days ago, your user pool must have been on the Plus feature plan for the past 14 days.
The recovery point must be at least 15 minutes in the past and can't be earlier than the creation time of the user pool.
A user pool can have only one active recovery at a time.
An Amazon Web Services account can have up to five active recoveries at a time across all of its user pools. An organization in Amazon Web Services Organizations can have up to ten active recoveries at a time across all of its accounts.
You can complete one recovery of a user pool in a 24-hour period.
You can create up to three recovery previews of a user pool, ten recovery previews in an Amazon Web Services account, and 15 recovery previews in an organization in Amazon Web Services Organizations in a 24-hour period. You can create up to ten recovery previews of a user pool in a 30-day period.
You can't initiate a recovery while a user import job is in progress in your user pool. Wait for the import job to complete, or stop it with a request, and then initiate the recovery.
In a user pool with multi-Region replication, you can initiate a recovery only in the primary Amazon Web Services Region, and only after replication is complete.
If your user pool uses a customer managed key in KMS for encryption, the key must remain enabled and accessible to Amazon Cognito for the duration of the recovery.
Some user pools don't support point-in-time recovery, for example some older user pools and user pools that contain user data with characters or formats that point-in-time recovery doesn't support. If your user pool doesn't support it, Amazon Cognito returns an error when you initiate a recovery. To get help with this limitation, contact Amazon Web Services Support.
Learn more
10844 10845 10846 10847 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10844 def initiate_point_in_time_recovery(params = {}, = {}) req = build_request(:initiate_point_in_time_recovery, params) req.send_request() end |
#list_cimd_policies(params = {}) ⇒ Types::ListCIMDPoliciesResponse
Lists the Client ID Metadata Document (CIMD) policies in a user pool.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10914 10915 10916 10917 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10914 def list_cimd_policies(params = {}, = {}) req = build_request(:list_cimd_policies, params) req.send_request() end |
#list_client_metadata_urls(params = {}) ⇒ Types::ListClientMetadataURLsResponse
Lists the client ID metadata document URLs that Amazon Cognito has received for a Client ID Metadata Document (CIMD) policy, with the cache state of each URL.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10988 10989 10990 10991 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 10988 def (params = {}, = {}) req = build_request(:list_client_metadata_urls, params) req.send_request() end |
#list_devices(params = {}) ⇒ Types::ListDevicesResponse
Lists the devices that Amazon Cognito has registered to the currently signed-in user. For more information about device authentication, see Working with user devices in your user pool.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
11060 11061 11062 11063 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11060 def list_devices(params = {}, = {}) req = build_request(:list_devices, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Given a user pool ID, returns user pool groups and their details.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11131 11132 11133 11134 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11131 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_identity_providers(params = {}) ⇒ Types::ListIdentityProvidersResponse
Given a user pool ID, returns information about configured identity providers (IdPs). For more information about IdPs, see Third-party IdP sign-in.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11202 11203 11204 11205 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11202 def list_identity_providers(params = {}, = {}) req = build_request(:list_identity_providers, params) req.send_request() end |
#list_point_in_time_recoveries(params = {}) ⇒ Types::ListPointInTimeRecoveriesResponse
Lists the point-in-time recoveries of a user pool, including the active recovery and past recoveries. The response lists the most recent recoveries first and doesn't include recovery previews. To get the recovery preview of a recovery, make a request.
Learn more
11272 11273 11274 11275 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11272 def list_point_in_time_recoveries(params = {}, = {}) req = build_request(:list_point_in_time_recoveries, params) req.send_request() end |
#list_resource_servers(params = {}) ⇒ Types::ListResourceServersResponse
Given a user pool ID, returns all resource servers and their details. For more information about resource servers, see Access control with resource servers.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11346 11347 11348 11349 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11346 def list_resource_servers(params = {}, = {}) req = build_request(:list_resource_servers, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags that are assigned to an Amazon Cognito user pool. For more information, see Tagging resources.
11381 11382 11383 11384 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11381 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_terms(params = {}) ⇒ Types::ListTermsResponse
Returns details about all terms documents for the requested user pool.
Learn more
11448 11449 11450 11451 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11448 def list_terms(params = {}, = {}) req = build_request(:list_terms, params) req.send_request() end |
#list_user_import_jobs(params = {}) ⇒ Types::ListUserImportJobsResponse
Given a user pool ID, returns user import jobs and their details. Import jobs are retained in user pool configuration so that you can stage, stop, start, review, and delete them. For more information about user import, see Importing users from a CSV file.
Learn more
11528 11529 11530 11531 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11528 def list_user_import_jobs(params = {}, = {}) req = build_request(:list_user_import_jobs, params) req.send_request() end |
#list_user_pool_client_secrets(params = {}) ⇒ Types::ListUserPoolClientSecretsResponse
Lists all client secrets associated with a user pool app client. Returns metadata about the secrets. The response does not include pagination tokens as there are only 2 secrets at any given time and we return both with every ListUserPoolClientSecrets call. For security reasons, the response never reveals the actual secret value in ClientSecretValue.
11579 11580 11581 11582 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11579 def list_user_pool_client_secrets(params = {}, = {}) req = build_request(:list_user_pool_client_secrets, params) req.send_request() end |
#list_user_pool_clients(params = {}) ⇒ Types::ListUserPoolClientsResponse
Given a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more information, see App clients.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11670 11671 11672 11673 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11670 def list_user_pool_clients(params = {}, = {}) req = build_request(:list_user_pool_clients, params) req.send_request() end |
#list_user_pool_replicas(params = {}) ⇒ Types::ListUserPoolReplicasResponse
Lists all replicas for a user pool, including both primary and secondary replicas. We recommend using pagination to ensure that the operation returns quickly and successfully.
Learn more
11756 11757 11758 11759 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11756 def list_user_pool_replicas(params = {}, = {}) req = build_request(:list_user_pool_replicas, params) req.send_request() end |
#list_user_pools(params = {}) ⇒ Types::ListUserPoolsResponse
Lists user pools and their details in the current Amazon Web Services account.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11843 11844 11845 11846 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11843 def list_user_pools(params = {}, = {}) req = build_request(:list_user_pools, params) req.send_request() end |
#list_user_sessions(params = {}) ⇒ Types::ListUserSessionsResponse
Lists the active sessions for the currently signed-in user. Amazon
Cognito authorizes this operation with the user's access token and
returns all of the user's active sessions across every app client in
the user pool, including both token sessions and SSO sessions. The
IsCurrentSession field identifies the session that the calling
access token belongs to. The results are eventually consistent, and
new sessions are typically included within a few seconds.
11942 11943 11944 11945 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 11942 def list_user_sessions(params = {}, = {}) req = build_request(:list_user_sessions, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Given a user pool ID, returns a list of users and their basic details in a user pool.
This operation is eventually consistent. You might experience a delay
before results are up-to-date. To validate the existence or
configuration of an individual user, use AdminGetUser.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12184 12185 12186 12187 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 12184 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_users_in_group(params = {}) ⇒ Types::ListUsersInGroupResponse
Given a user pool ID and a group name, returns a list of users in the group. For more information about user pool groups, see Adding groups to a user pool.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12270 12271 12272 12273 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 12270 def list_users_in_group(params = {}, = {}) req = build_request(:list_users_in_group, params) req.send_request() end |
#list_web_authn_credentials(params = {}) ⇒ Types::ListWebAuthnCredentialsResponse
Generates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
12340 12341 12342 12343 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 12340 def list_web_authn_credentials(params = {}, = {}) req = build_request(:list_web_authn_credentials, params) req.send_request() end |
#resend_confirmation_code(params = {}) ⇒ Types::ResendConfirmationCodeResponse
Resends the code that confirms a new account for a user who has signed
up in your user pool. Amazon Cognito sends confirmation codes to the
user attribute in the AutoVerifiedAttributes property of your user
pool. When you prompt new users for the confirmation code, include a
"Resend code" option that generates a call to this API operation.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
12493 12494 12495 12496 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 12493 def resend_confirmation_code(params = {}, = {}) req = build_request(:resend_confirmation_code, params) req.send_request() end |
#respond_to_auth_challenge(params = {}) ⇒ Types::RespondToAuthChallengeResponse
Some API operations in a user pool generate a challenge, like a prompt
for an MFA code, for device authentication that bypasses MFA, or for a
custom authentication challenge. A RespondToAuthChallenge API
request provides the answer to that challenge, like a code or a secure
remote password (SRP). The parameters of a response to an
authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom authentication challenge Lambda triggers.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
12917 12918 12919 12920 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 12917 def respond_to_auth_challenge(params = {}, = {}) req = build_request(:respond_to_auth_challenge, params) req.send_request() end |
#revoke_token(params = {}) ⇒ Struct
Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.
12975 12976 12977 12978 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 12975 def revoke_token(params = {}, = {}) req = build_request(:revoke_token, params) req.send_request() end |
#revoke_user_session(params = {}) ⇒ Struct
Revokes a specific session for the currently signed-in user. Amazon Cognito authorizes this operation with the user's access token, revokes all refresh and access tokens that are associated with the session, and deletes the session record. You can't revoke the session that the calling access token belongs to.
13038 13039 13040 13041 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13038 def revoke_user_session(params = {}, = {}) req = build_request(:revoke_user_session, params) req.send_request() end |
#set_log_delivery_configuration(params = {}) ⇒ Types::SetLogDeliveryConfigurationResponse
Sets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see Exporting user pool logs.
13097 13098 13099 13100 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13097 def set_log_delivery_configuration(params = {}, = {}) req = build_request(:set_log_delivery_configuration, params) req.send_request() end |
#set_risk_configuration(params = {}) ⇒ Types::SetRiskConfigurationResponse
Configures threat protection for a user pool or app client. Sets configuration for the following.
Responses to risks with adaptive authentication
Responses to vulnerable passwords with compromised-credentials detection
Notifications to users who have had risky activity detected
IP-address denylist and allowlist
To set the risk configuration for the user pool to defaults, send this
request with only the UserPoolId parameter. To reset the threat
protection settings of an app client to be inherited from the user
pool, send UserPoolId and ClientId parameters only. To change
threat protection to audit-only or off, update the value of
UserPoolAddOns in an UpdateUserPool request. To activate this
setting, your user pool must be on the Plus tier.
In secondary regions for user pools with multi-region replication,
only the SourceARN and From attributes of NotifyConfiguration
can be modified to configure region-specific SES integration. All
other risk configuration settings must match the existing values to
maintain consistency across replicas.
13256 13257 13258 13259 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13256 def set_risk_configuration(params = {}, = {}) req = build_request(:set_risk_configuration, params) req.send_request() end |
#set_ui_customization(params = {}) ⇒ Types::SetUICustomizationResponse
Configures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with .
Set the default configuration for all clients with a ClientId of
ALL. When the ClientId value is an app client ID, the settings you
pass in this request apply to that app client and override the default
ALL configuration.
Learn more
13335 13336 13337 13338 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13335 def set_ui_customization(params = {}, = {}) req = build_request(:set_ui_customization, params) req.send_request() end |
#set_user_mfa_preference(params = {}) ⇒ Struct
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated 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 activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
13434 13435 13436 13437 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13434 def set_user_mfa_preference(params = {}, = {}) req = build_request(:set_user_mfa_preference, params) req.send_request() end |
#set_user_pool_client_session_configuration(params = {}) ⇒ Types::SetUserPoolClientSessionConfigurationResponse
Sets the session configuration for a user pool app client. The
configurable client-level setting is the maximum validity period for
silent reuse of an SSO session. This operation performs a full
replacement of the client-level session configuration; every request
parameter is required, and session tracking must be enabled for the
user pool. The user pool must be in the Essentials or Plus tier.
Otherwise, this operation returns a
FeatureUnavailableInTierException.
13506 13507 13508 13509 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13506 def set_user_pool_client_session_configuration(params = {}, = {}) req = build_request(:set_user_pool_client_session_configuration, params) req.send_request() end |
#set_user_pool_mfa_config(params = {}) ⇒ Types::SetUserPoolMfaConfigResponse
Sets user pool multi-factor authentication (MFA) and passkey configuration. For more information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
13653 13654 13655 13656 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13653 def set_user_pool_mfa_config(params = {}, = {}) req = build_request(:set_user_pool_mfa_config, params) req.send_request() end |
#set_user_pool_session_configuration(params = {}) ⇒ Types::SetUserPoolSessionConfigurationResponse
Enables or disables session tracking for a user pool, and sets the
pool-wide maximum number of active token sessions that each user can
have. This operation performs a full replacement of the pool-level
session configuration; every request parameter is required. The user
pool must be in the Essentials or Plus tier. Otherwise, this operation
returns a FeatureUnavailableInTierException.
13728 13729 13730 13731 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13728 def set_user_pool_session_configuration(params = {}, = {}) req = build_request(:set_user_pool_session_configuration, params) req.send_request() end |
#set_user_settings(params = {}) ⇒ Struct
This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token or email MFA.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
13780 13781 13782 13783 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13780 def set_user_settings(params = {}, = {}) req = build_request(:set_user_settings, params) req.send_request() end |
#sign_up(params = {}) ⇒ Types::SignUpResponse
Registers a user with an app client and requests a user name, password, and user attributes in the user pool.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
You might receive a LimitExceeded exception in response to this
request if you have exceeded a rate quota for email or SMS messages,
and if your user pool automatically verifies email addresses or phone
numbers. When you get this exception in the response, the user is
successfully created and is in an UNCONFIRMED state.
13990 13991 13992 13993 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 13990 def sign_up(params = {}, = {}) req = build_request(:sign_up, params) req.send_request() end |
#start_point_in_time_recovery(params = {}) ⇒ Types::StartPointInTimeRecoveryResponse
Applies a point-in-time recovery to a user pool. Before you start a
recovery, review the recovery preview in the response to a request.
You can start a recovery when its status is PREVIEW_GENERATED.
When you start a recovery, Amazon Cognito sets its status to
RESTORING and restores user data in the user pool to its state at
the recovery point. Write operations in the user pool remain paused
until the recovery is complete. Sign-in and read operations continue
to work. When the status of the recovery changes to
RESTORE_COMPLETED, Amazon Cognito resumes write operations.
You can't cancel a recovery after you start it.
Learn more
14061 14062 14063 14064 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14061 def start_point_in_time_recovery(params = {}, = {}) req = build_request(:start_point_in_time_recovery, params) req.send_request() end |
#start_user_import_job(params = {}) ⇒ Types::StartUserImportJobResponse
Instructs your user pool to start importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.
14113 14114 14115 14116 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14113 def start_user_import_job(params = {}, = {}) req = build_request(:start_user_import_job, params) req.send_request() end |
#start_web_authn_registration(params = {}) ⇒ Types::StartWebAuthnRegistrationResponse
Requests credential creation options from your user pool for the currently signed-in user. Returns information about the user pool, the user profile, and authentication requirements. Users must provide this information in their request to enroll your application with their passkey provider.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
14150 14151 14152 14153 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14150 def start_web_authn_registration(params = {}, = {}) req = build_request(:start_web_authn_registration, params) req.send_request() end |
#stop_user_import_job(params = {}) ⇒ Types::StopUserImportJobResponse
Instructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.
14202 14203 14204 14205 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14202 def stop_user_import_job(params = {}, = {}) req = build_request(:stop_user_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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 Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
14249 14250 14251 14252 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14249 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Given tag IDs that you previously assigned to a user pool, removes them.
14277 14278 14279 14280 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14277 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_auth_event_feedback(params = {}) ⇒ Struct
Provides the feedback for an authentication event generated by threat protection features. The user's response indicates that you think that the event either was from a valid user or was an unwanted authentication attempt. This feedback improves the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. To activate this setting, your user pool must be on the Plus tier.
This operation requires a FeedbackToken that Amazon Cognito
generates and adds to notification emails when users have potentially
suspicious authentication events. Users invoke this operation when
they select the link that corresponds to {one-click-link-valid} or
{one-click-link-invalid} in your notification template. Because
FeedbackToken is a required parameter, you can't make requests to
UpdateAuthEventFeedback without the contents of the notification
email message.
14356 14357 14358 14359 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14356 def update_auth_event_feedback(params = {}, = {}) req = build_request(:update_auth_event_feedback, params) req.send_request() end |
#update_cimd_policy(params = {}) ⇒ Types::UpdateCIMDPolicyResponse
Updates the configuration of a Client ID Metadata Document (CIMD) policy.
Learn more
14437 14438 14439 14440 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14437 def update_cimd_policy(params = {}, = {}) req = build_request(:update_cimd_policy, params) req.send_request() end |
#update_client_metadata_url_state(params = {}) ⇒ Struct
Changes the cache state of a client metadata document URL for a client ID metadata document (CIMD) policy. Refresh a URL to make Amazon Cognito retrieve the client metadata document again, or invalidate it to remove the cached document.
Learn more
14494 14495 14496 14497 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14494 def (params = {}, = {}) req = build_request(:update_client_metadata_url_state, params) req.send_request() end |
#update_device_status(params = {}) ⇒ Struct
Updates the status of a the currently signed-in user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
14552 14553 14554 14555 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14552 def update_device_status(params = {}, = {}) req = build_request(:update_device_status, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Given the name of a user pool group, updates any of the properties for precedence, IAM role, or description. For more information about user pool groups, see Adding groups to a user pool.
Learn more
14643 14644 14645 14646 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14643 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_identity_provider(params = {}) ⇒ Types::UpdateIdentityProviderResponse
Modifies the configuration and trust relationship between a third-party identity provider (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in.
Learn more
14873 14874 14875 14876 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14873 def update_identity_provider(params = {}, = {}) req = build_request(:update_identity_provider, params) req.send_request() end |
#update_managed_login_branding(params = {}) ⇒ Types::UpdateManagedLoginBrandingResponse
Configures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor.
Provides values for UI customization in a Settings JSON object and
image files in an Assets array.
This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request and preserves existing style settings that you don't specify. If your request is larger than 2MB, separate it into multiple requests, each with a size smaller than the limit.
Learn more
14997 14998 14999 15000 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 14997 def update_managed_login_branding(params = {}, = {}) req = build_request(:update_managed_login_branding, params) req.send_request() end |
#update_provisioned_limit(params = {}) ⇒ Types::UpdateProvisionedLimitResponse
Sets the provisioned limit for a specific API category. The value must be between the default limit and your account-level maximum limit in Service Quotas.
Managed login user pools don't support adjustments to the
UserAuthentication or UserFederation categories. To increase these
limits, submit a Service Quotas increase request.
Learn more
15092 15093 15094 15095 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 15092 def update_provisioned_limit(params = {}, = {}) req = build_request(:update_provisioned_limit, params) req.send_request() end |
#update_resource_server(params = {}) ⇒ Types::UpdateResourceServerResponse
Updates the name and scopes of a resource server. All other fields are read-only. For more information about resource servers, see Access control with resource servers.
If you don't provide a value for an attribute, it is set to the default value.
Learn more
15176 15177 15178 15179 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 15176 def update_resource_server(params = {}, = {}) req = build_request(:update_resource_server, params) req.send_request() end |
#update_terms(params = {}) ⇒ Types::UpdateTermsResponse
Modifies existing terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client.
You can provide URLs for terms documents in the languages that are
supported by managed login localization. Amazon Cognito directs
users to the terms documents for their current language, with fallback
to default if no document exists for the language.
Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests.
For more information, see Terms documents.
Learn more
15279 15280 15281 15282 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 15279 def update_terms(params = {}, = {}) req = build_request(:update_terms, params) req.send_request() end |
#update_user_attributes(params = {}) ⇒ Types::UpdateUserAttributesResponse
Updates the currently signed-in user's attributes. To delete an attribute from the user, submit the attribute in your API request with a blank value.
For custom attributes, you must add a custom: prefix to the
attribute name, for example custom:department.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
15413 15414 15415 15416 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 15413 def update_user_attributes(params = {}, = {}) req = build_request(:update_user_attributes, params) req.send_request() end |
#update_user_pool(params = {}) ⇒ Struct
Updates the configuration of a user pool. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your user pool, modified to include the changes that you want to make.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
In secondary regions for user pools with multi-region replication, regional configurations for email, SMS, Lambda functions, and tags can be updated. Both global and regional settings must be provided as inputs, with global settings required to match existing values to maintain consistency across replicas.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Learn more
15836 15837 15838 15839 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 15836 def update_user_pool(params = {}, = {}) req = build_request(:update_user_pool, params) req.send_request() end |
#update_user_pool_client(params = {}) ⇒ Types::UpdateUserPoolClientResponse
Given a user pool app client ID, updates the configuration. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your app client, modified to include the changes that you want to make.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style.
Learn more
16350 16351 16352 16353 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 16350 def update_user_pool_client(params = {}, = {}) req = build_request(:update_user_pool_client, params) req.send_request() end |
#update_user_pool_domain(params = {}) ⇒ Types::UpdateUserPoolDomainResponse
A user pool domain hosts managed login, an authorization server and
web server for authentication in your application. This operation
updates the branding version for user pool domains between 1 for
hosted UI (classic) and 2 for managed login. It also updates the SSL
certificate for user pool custom domains.
Changes to the domain branding version take up to one minute to take effect for a prefix domain and up to five minutes for a custom domain.
This operation doesn't change the name of your user pool domain. To
change your domain, delete it with DeleteUserPoolDomain and create a
new domain with CreateUserPoolDomain.
You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM certificates automatically renew and you user pool can continue to use the same ARN. But if you generate a new certificate for your custom domain name, replace the original configuration with the new ARN in this request.
ACM certificates for custom domains must be in the US East (N. Virginia) Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Configuring a user pool domain.
Learn more
16472 16473 16474 16475 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 16472 def update_user_pool_domain(params = {}, = {}) req = build_request(:update_user_pool_domain, params) req.send_request() end |
#update_user_pool_replica(params = {}) ⇒ Types::UpdateUserPoolReplicaResponse
Updates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both primary and secondary regions of the user pool.
Learn more
16553 16554 16555 16556 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 16553 def update_user_pool_replica(params = {}, = {}) req = build_request(:update_user_pool_replica, params) req.send_request() end |
#verify_software_token(params = {}) ⇒ Types::VerifySoftwareTokenResponse
Registers the current user's time-based one-time password (TOTP) authenticator with a code generated in their authenticator app from a private key that's supplied by your user pool. Marks the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
16614 16615 16616 16617 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 16614 def verify_software_token(params = {}, = {}) req = build_request(:verify_software_token, params) req.send_request() end |
#verify_user_attribute(params = {}) ⇒ Struct
Submits a verification code for a signed-in user who has added or
changed a value of an auto-verified attribute. When successful, the
user's attribute becomes verified and the attribute email_verified
or phone_number_verified becomes true.
If your user pool requires verification before Amazon Cognito updates the attribute value, this operation updates the affected attribute to its pending value.
Authorize this action with a signed-in user's access token. It must
include the scope aws.cognito.signin.user.admin.
16670 16671 16672 16673 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 16670 def verify_user_attribute(params = {}, = {}) req = build_request(:verify_user_attribute, params) req.send_request() end |