RubyDoc.info: Class: Aws::CognitoIdentityProvider::Client – Documentation for aws-sdk-cognitoidentityprovider (1.129.0)

#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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-custom-attributes [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.add_custom_attributes({
  user_pool_id: "UserPoolIdType", # required
  custom_attributes: [ # required
    {
      name: "CustomAttributeNameType",
      attribute_data_type: "String", # accepts String, Number, DateTime, Boolean
      developer_only_attribute: false,
      mutable: false,
      required: false,
      number_attribute_constraints: {
        min_value: "StringType",
        max_value: "StringType",
      },
      string_attribute_constraints: {
        min_length: "StringType",
        max_length: "StringType",
      },
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to add custom attributes.
:custom_attributes (required, Array<Types::SchemaAttributeType>) —
An array of custom attribute names and other properties. Sets the following characteristics:

AttributeDataType

: The expected data type. Can be a string, a number, a date and time,
```
or a boolean.
```
Mutable

: If true, you can grant app clients write access to the attribute
```
value. If false, the attribute value can only be set up on sign-up
or administrator creation of users.
```
Name

: The attribute name. For an attribute like ‘custom:myAttribute`,
```
enter `myAttribute` for this field.
```
Required

: When true, users who sign up or are created must set a value for the
```
attribute.
```
NumberAttributeConstraints

: The minimum and maximum length of accepted values for a
```
`Number`-type attribute.
```
StringAttributeConstraints

: The minimum and maximum length of accepted values for a
```
`String`-type attribute.
```
DeveloperOnlyAttribute

: This legacy option creates an attribute with a ‘dev:` prefix. You
```
can only set the value of a developer-only attribute with
administrative IAM credentials.
```

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 582

def add_custom_attributes(params = {}, options = {})
  req = build_request(:add_custom_attributes, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_add_user_to_group({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  group_name: "GroupNameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the group that you want to add the user to.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:group_name (required, String) —

The name of the group that you want to add your user to.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 637

def admin_add_user_to_group(params = {}, options = {})
  req = build_request(:admin_add_user_to_group, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

To configure your user pool to require administrative confirmation of users, set ‘AllowAdminCreateUserOnly` to `true` in a `CreateUserPool` or `UpdateUserPool` request.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#signing-up-users-in-your-app-and-confirming-them-as-admin [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_confirm_sign_up({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to confirm a user’s sign-up request.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the Lambda function that is specified for the *post confirmation* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the ‘clientMetadata` attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 735

def admin_confirm_sign_up(params = {}, options = {})
  req = build_request(:admin_confirm_sign_up, params)
  req.send_request(options)
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`.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][3]

Using the Amazon Cognito user pools API and user pool endpoints][4

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Example: An AdminCreateUser request for for a test user named John.


# This request submits a value for all possible parameters for AdminCreateUser.

resp = client.admin_create_user({
  desired_delivery_mediums: [
    "SMS", 
  ], 
  message_action: "SUPPRESS", 
  temporary_password: "This-is-my-test-99!", 
  user_attributes: [
    {
      name: "name", 
      value: "John", 
    }, 
    {
      name: "phone_number", 
      value: "+12065551212", 
    }, 
    {
      name: "email", 
      value: "[email protected]", 
    }, 
  ], 
  user_pool_id: "us-east-1_EXAMPLE", 
  username: "testuser", 
})

resp.to_h outputs the following:
{
  user: {
    attributes: [
      {
        name: "sub", 
        value: "d16b4aa8-8633-4abd-93b3-5062a8e1b5f8", 
      }, 
      {
        name: "name", 
        value: "John", 
      }, 
      {
        name: "phone_number", 
        value: "+12065551212", 
      }, 
      {
        name: "email", 
        value: "[email protected]", 
      }, 
    ], 
    enabled: true, 
    user_create_date: Time.parse(1689980857.949), 
    user_last_modified_date: Time.parse(1689980857.949), 
    user_status: "FORCE_CHANGE_PASSWORD", 
    username: "testuser", 
  }, 
}

Request syntax with placeholder values


resp = client.admin_create_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attributes: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  validation_data: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  temporary_password: "PasswordType",
  force_alias_creation: false,
  message_action: "RESEND", # accepts RESEND, SUPPRESS
  desired_delivery_mediums: ["SMS"], # accepts SMS, EMAIL
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.user.username #=> String
resp.user.attributes #=> Array
resp.user.attributes[0].name #=> String
resp.user.attributes[0].value #=> String
resp.user.user_create_date #=> Time
resp.user.user_last_modified_date #=> Time
resp.user.enabled #=> Boolean
resp.user.user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD", "EXTERNAL_PROVIDER"
resp.user.mfa_options #=> Array
resp.user.mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.user.mfa_options[0].attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to create a user.
:username (required, String) —
The value that you want to set as the username sign-in attribute. The following conditions apply to the username parameter.
- The username can’t be a duplicate of another username in the same user pool.
- You can’t change the value of a username after you create it.
- You can only provide a value if usernames are a valid sign-in attribute for your user pool. If your user pool only supports phone numbers or email addresses as sign-in attributes, Amazon Cognito automatically generates a username value. For more information, see [Customizing sign-in attributes].
[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases
:user_attributes (Array<Types::AttributeType>) —
An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than ‘Username`. However, any attributes that you specify as required (when creating a user pool or in the Attributes tab of the console) either you should supply (in your call to `AdminCreateUser`) or the user should supply (when they sign up in response to your welcome message).

For custom attributes, you must prepend the ‘custom:` prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user’s email address or phone number. You can do this in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

You must also provide an email address or phone number when you expect the user to do passwordless sign-in with an email or SMS OTP. These attributes must be provided when passwordless options are the only available, or when you don’t submit a ‘TemporaryPassword`.

In your ‘AdminCreateUser` request, you can set the `email_verified` and `phone_number_verified` attributes to `true`. The following conditions apply:

email

: The email address where you want the user to receive their
```
confirmation code and username. You must provide a value for `email`
when you want to set `email_verified` to `true`, or if you set
`EMAIL` in the `DesiredDeliveryMediums` parameter.
```
phone_number

: The phone number where you want the user to receive their
```
confirmation code and username. You must provide a value for
`phone_number` when you want to set `phone_number_verified` to
`true`, or if you set `SMS` in the `DesiredDeliveryMediums`
parameter.
```
:validation_data (Array<Types::AttributeType>) —

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don’t need to retain.

Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

For more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html
:temporary_password (String) —

The user’s temporary password. This password must conform to the password policy that you specified when you created the user pool.

The exception to the requirement for a password is when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page, along with a new password to be used in all future sign-ins.

If you don’t specify a value, Amazon Cognito generates one for you unless you have passwordless options active for your user pool.

The temporary password can only be used until the user account expiration limit that you set for your user pool. To reset the account after that time limit, you must call ‘AdminCreateUser` again and specify `RESEND` for the `MessageAction` parameter.
:force_alias_creation (Boolean) —

This parameter is used only if the ‘phone_number_verified` or `email_verified` attribute is set to `True`. Otherwise, it is ignored.

If this parameter is set to ‘True` and the phone number or email address specified in the `UserAttributes` parameter already exists as an alias with a different user, this request migrates the alias from the previous user to the newly-created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to ‘False`, the API throws an `AliasExistsException` error if the alias already exists. The default value is `False`.
:message_action (String) —

Set to ‘RESEND` to resend the invitation message to a user that already exists, and to reset the temporary-password duration with a new temporary password. Set to `SUPPRESS` to suppress sending the message. You can specify only one value.
:desired_delivery_mediums (Array<String>) —

Specify ‘EMAIL` if email will be used to send the welcome message. Specify `SMS` if the phone number will be used. The default value is `SMS`. You can specify more than one value.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the *pre sign-up* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘ClientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::AdminCreateUserResponse) —
Returns a response object which responds to the following methods:
- #user => Types::UserType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1074

def admin_create_user(params = {}, options = {})
  req = build_request(:admin_create_user, params)
  req.send_request(options)
end

#admin_delete_user(params = {}) ⇒ `Struct`

Deletes a user profile in your user pool.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_delete_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to delete the user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1122

def admin_delete_user(params = {}, options = {})
  req = build_request(:admin_delete_user, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_delete_user_attributes({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attribute_names: ["AttributeNameType"], # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to delete user attributes.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:user_attribute_names (required, Array<String>) —

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the ‘custom:` prefix to the attribute name.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1180

def admin_delete_user_attributes(params = {}, options = {})
  req = build_request(:admin_delete_user_attributes, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_disable_provider_for_user({
  user_pool_id: "StringType", # required
  user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to delete the user’s linked identities.
:user (required, Types::ProviderUserIdentifierType) —

The user profile that you want to delete a linked identity from.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1257

def admin_disable_provider_for_user(params = {}, options = {})
  req = build_request(:admin_disable_provider_for_user, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_disable_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to disable the user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1307

def admin_disable_user(params = {}, options = {})
  req = build_request(:admin_disable_user, params)
  req.send_request(options)
end

#admin_enable_user(params = {}) ⇒ `Struct`

Activates sign-in for a user profile that previously had sign-in access disabled.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_enable_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to activate sign-in for the user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1357

def admin_enable_user(params = {}, options = {})
  req = build_request(:admin_enable_user, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_forget_device({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  device_key: "DeviceKeyType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where the device owner is a user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:device_key (required, String) —

The key ID of the device that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1413

def admin_forget_device(params = {}, options = {})
  req = build_request(:admin_forget_device, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_get_device({
  device_key: "DeviceKeyType", # required
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Response structure


resp.device.device_key #=> String
resp.device.device_attributes #=> Array
resp.device.device_attributes[0].name #=> String
resp.device.device_attributes[0].value #=> String
resp.device.device_create_date #=> Time
resp.device.device_last_modified_date #=> Time
resp.device.device_last_authenticated_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:device_key (required, String) —

The key of the device that you want to delete.
:user_pool_id (required, String) —

The ID of the user pool where the device owner is a user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

(Types::AdminGetDeviceResponse) —
Returns a response object which responds to the following methods:
- #device => Types::DeviceType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1479

def admin_get_device(params = {}, options = {})
  req = build_request(:admin_get_device, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_get_user({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Response structure


resp.username #=> String
resp.user_attributes #=> Array
resp.user_attributes[0].name #=> String
resp.user_attributes[0].value #=> String
resp.user_create_date #=> Time
resp.user_last_modified_date #=> Time
resp.enabled #=> Boolean
resp.user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD", "EXTERNAL_PROVIDER"
resp.mfa_options #=> Array
resp.mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.mfa_options[0].attribute_name #=> String
resp.preferred_mfa_setting #=> String
resp.user_mfa_setting_list #=> Array
resp.user_mfa_setting_list[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to get information about the user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

(Types::AdminGetUserResponse) —
Returns a response object which responds to the following methods:
- #username => String
- #user_attributes => Array<Types::AttributeType>
- #user_create_date => Time
- #user_last_modified_date => Time
- #enabled => Boolean
- #user_status => String
- #mfa_options => Array<Types::MFAOptionType>
- #preferred_mfa_setting => String
- #user_mfa_setting_list => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1559

def admin_get_user(params = {}, options = {})
  req = build_request(:admin_get_user, params)
  req.send_request(options)
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].

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][4]

Using the Amazon Cognito user pools API and user pool endpoints][5

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_initiate_auth({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH, USER_AUTH
  auth_parameters: {
    "StringType" => "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  context_data: {
    ip_address: "StringType", # required
    server_name: "StringType", # required
    server_path: "StringType", # required
    http_headers: [ # required
      {
        header_name: "StringType",
        header_value: "StringType",
      },
    ],
    encoded_data: "StringType",
  },
  session: "SessionType",
})

Response structure


resp.challenge_name #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String
resp.available_challenges #=> Array
resp.available_challenges[0] #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where the user wants to sign in.
:client_id (required, String) —

The ID of the app client where the user wants to sign in.
:auth_flow (required, String) —
The authentication flow that you want to initiate. Each ‘AuthFlow` has linked `AuthParameters` that you must submit. The following are some example flows.

USER_AUTH

: The entry point for [choice-based authentication] with passwords,
```
one-time passwords, and WebAuthn authenticators. Request a preferred
authentication type or review available authentication types. From
the offered authentication types, select one in a challenge response
and then authenticate with that method in an additional challenge
response. To activate this setting, your user pool must be in the [
Essentials tier][2] or higher.
```
USER_SRP_AUTH

: Username-password authentication with the Secure Remote Password
```
(SRP) protocol. For more information, see [Use SRP password
verification in custom authentication flow][3].
```
REFRESH_TOKEN_AUTH and REFRESH_TOKEN

: Receive new ID and access tokens when you pass a ‘REFRESH_TOKEN`
```
parameter with a valid refresh token as the value. For more
information, see [Using the refresh token][4].
```
CUSTOM_AUTH

: Custom authentication with Lambda triggers. For more information,
```
see [Custom authentication challenge Lambda triggers][5].
```
ADMIN_USER_PASSWORD_AUTH

: Server-side username-password authentication with the password sent
```
directly in the request. For more information about client-side and
server-side authentication, see [SDK authorization models][6].
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Using-SRP-password-verification-in-custom-authentication-flow [4]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html [6]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html
:auth_parameters (Hash<String,String>) —
The authentication parameters. These are inputs corresponding to the ‘AuthFlow` that you’re invoking.

The following are some authentication flows and their parameters. Add a ‘SECRET_HASH` parameter if your app client has a client secret. Add `DEVICE_KEY` if you want to bypass multi-factor authentication with a remembered device.

USER_AUTH : * ‘USERNAME` (required)
```
* `PREFERRED_CHALLENGE`. If you don't provide a value for
  `PREFERRED_CHALLENGE`, Amazon Cognito responds with the
  `AvailableChallenges` parameter that specifies the available
  sign-in methods.
```
USER_SRP_AUTH : * ‘USERNAME` (required)
```
* `SRP_A` (required)
```
ADMIN_USER_PASSWORD_AUTH : * ‘USERNAME` (required)
```
* `PASSWORD` (required)
```
REFRESH_TOKEN_AUTH/REFRESH_TOKEN : * ‘REFRESH_TOKEN`(required)
```
^
```
CUSTOM_AUTH : * ‘USERNAME` (required)
```
* `ChallengeName: SRP_A` (when preceding custom authentication with
  SRP authentication)

* `SRP_A: (An SRP_A value)` (when preceding custom authentication
  with SRP authentication)
```
For more information about ‘SECRET_HASH`, see [Computing secret hash values]. For information about `DEVICE_KEY`, see [Working with user devices in your user pool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash [2]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
- Pre signup
- Pre authentication
- User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a ‘validationData` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in Lambda, you can process the `validationData` value to enhance your workflow for your specific needs.

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn’t provide the ClientMetadata value as input:
- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Custom email sender
- Custom SMS sender
For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:context_data (Types::ContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:session (String) —

The optional session ID from a ‘ConfirmSignUp` API request. You can sign in a user directly from the sign-up process with an `AuthFlow` of `USER_AUTH` and `AuthParameters` of `EMAIL_OTP` or `SMS_OTP`, depending on how your user pool sent the confirmation-code message.

Returns:

(Types::AdminInitiateAuthResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType
- #available_challenges => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1863

def admin_initiate_auth(params = {}, options = {})
  req = build_request(:admin_initiate_auth, params)
  req.send_request(options)
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].

<note markdown=“1”> The maximum number of federated identities linked to a user is five.

</note>

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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_link_provider_for_user({
  user_pool_id: "StringType", # required
  destination_user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
  source_user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to link a federated identity.
:destination_user (required, Types::ProviderUserIdentifierType) —

The existing user in the user pool that you want to assign to the external IdP user account. This user can be a local (Username + Password) Amazon Cognito user pools user or a federated user (for example, a SAML or Facebook user). If the user doesn’t exist, Amazon Cognito generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP attribute) signs in.

For a native username + password user, the ‘ProviderAttributeValue` for the `DestinationUser` should be the username in the user pool. For a federated user, it should be the provider-specific `user_id`.

The ‘ProviderAttributeName` of the `DestinationUser` is ignored.

The ‘ProviderName` should be set to `Cognito` for users in Cognito user pools.

All attributes in the DestinationUser profile must be mutable. If you have assigned the user any immutable custom attributes, the operation won’t succeed.
:source_user (required, Types::ProviderUserIdentifierType) —
An external IdP account for a user who doesn’t exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

If the ‘SourceUser` is using a federated social IdP, such as Facebook, Google, or Login with Amazon, you must set the `ProviderAttributeName` to `Cognito_Subject`. For social IdPs, the `ProviderName` will be `Facebook`, `Google`, or `LoginWithAmazon`, and Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for `id`, `sub`, and `user_id`, respectively. The `ProviderAttributeValue` for the user must be the same value as the `id`, `sub`, or `user_id` value found in the social IdP token.

For OIDC, the ‘ProviderAttributeName` can be any mapped value from a claim in the ID token, or that your app retrieves from the `userInfo` endpoint. For SAML, the `ProviderAttributeName` can be any mapped value from a claim in the SAML assertion.

The following additional considerations apply to ‘SourceUser` for OIDC and SAML providers.
- You must map the claim to a user pool attribute in your IdP configuration, and set the user pool attribute name as the value of ‘ProviderAttributeName` in your `AdminLinkProviderForUser` request. For example, `email`.
- When you set ‘ProviderAttributeName` to `Cognito_Subject`, Amazon Cognito will automatically parse the default unique identifier found in the subject from the IdP token.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 1984

def admin_link_provider_for_user(params = {}, options = {})
  req = build_request(:admin_link_provider_for_user, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_list_devices({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
})

Response structure


resp.devices #=> Array
resp.devices[0].device_key #=> String
resp.devices[0].device_attributes #=> Array
resp.devices[0].device_attributes[0].name #=> String
resp.devices[0].device_attributes[0].value #=> String
resp.devices[0].device_create_date #=> Time
resp.devices[0].device_last_modified_date #=> Time
resp.devices[0].device_last_authenticated_date #=> Time
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where the device owner is a user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:limit (Integer) —

The maximum number of devices that you want Amazon Cognito to return in the response.
:pagination_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::AdminListDevicesResponse) —
Returns a response object which responds to the following methods:
- #devices => Array<Types::DeviceType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2067

def admin_list_devices(params = {}, options = {})
  req = build_request(:admin_list_devices, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.admin_list_groups_for_user({
  username: "UsernameType", # required
  user_pool_id: "UserPoolIdType", # required
  limit: 1,
  next_token: "PaginationKey",
})

Response structure


resp.groups #=> Array
resp.groups[0].group_name #=> String
resp.groups[0].user_pool_id #=> String
resp.groups[0].description #=> String
resp.groups[0].role_arn #=> String
resp.groups[0].precedence #=> Integer
resp.groups[0].last_modified_date #=> Time
resp.groups[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:user_pool_id (required, String) —

The ID of the user pool where you want to view a user’s groups.
:limit (Integer) —

The maximum number of groups that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::AdminListGroupsForUserResponse) —
Returns a response object which responds to the following methods:
- #groups => Array<Types::GroupType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2150

def admin_list_groups_for_user(params = {}, options = {})
  req = build_request(:admin_list_groups_for_user, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-event-user-history [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.admin_list_user_auth_events({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  max_results: 1,
  next_token: "PaginationKey",
})

Response structure


resp.auth_events #=> Array
resp.auth_events[0].event_id #=> String
resp.auth_events[0].event_type #=> String, one of "SignIn", "SignUp", "ForgotPassword", "PasswordChange", "ResendCode"
resp.auth_events[0].creation_date #=> Time
resp.auth_events[0].event_response #=> String, one of "Pass", "Fail", "InProgress"
resp.auth_events[0].event_risk.risk_decision #=> String, one of "NoRisk", "AccountTakeover", "Block"
resp.auth_events[0].event_risk.risk_level #=> String, one of "Low", "Medium", "High"
resp.auth_events[0].event_risk.compromised_credentials_detected #=> Boolean
resp.auth_events[0].challenge_responses #=> Array
resp.auth_events[0].challenge_responses[0].challenge_name #=> String, one of "Password", "Mfa"
resp.auth_events[0].challenge_responses[0].challenge_response #=> String, one of "Success", "Failure"
resp.auth_events[0].event_context_data.ip_address #=> String
resp.auth_events[0].event_context_data.device_name #=> String
resp.auth_events[0].event_context_data.timezone #=> String
resp.auth_events[0].event_context_data.city #=> String
resp.auth_events[0].event_context_data.country #=> String
resp.auth_events[0].event_feedback.feedback_value #=> String, one of "Valid", "Invalid"
resp.auth_events[0].event_feedback.provider #=> String
resp.auth_events[0].event_feedback.feedback_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The Id of the user pool that contains the user profile with the logged events.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:max_results (Integer) —

The maximum number of authentication events to return. Returns 60 events if you set ‘MaxResults` to 0, or if you don’t include a ‘MaxResults` parameter.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::AdminListUserAuthEventsResponse) —
Returns a response object which responds to the following methods:
- #auth_events => Array<Types::AuthEventType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2245

def admin_list_user_auth_events(params = {}, options = {})
  req = build_request(:admin_list_user_auth_events, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_remove_user_from_group({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  group_name: "GroupNameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the group and the user that you want to remove.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:group_name (required, String) —

The name of the group that you want to remove the user from, for example ‘MyTestGroup`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2304

def admin_remove_user_from_group(params = {}, options = {})
  req = build_request(:admin_remove_user_from_group, params)
  req.send_request(options)
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.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][3]

Using the Amazon Cognito user pools API and user pool endpoints][4

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_reset_user_password({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to reset the user’s password.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. The ‘AdminResetUserPassword` API operation invokes the function that is assigned to the *custom message* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a `clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2422

def admin_reset_user_password(params = {}, options = {})
  req = build_request(:admin_reset_user_password, params)
  req.send_request(options)
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].

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][4]

Using the Amazon Cognito user pools API and user pool endpoints][5

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_respond_to_auth_challenge({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  challenge_name: "SMS_MFA", # required, accepts SMS_MFA, EMAIL_OTP, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, SELECT_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED, SMS_OTP, PASSWORD, WEB_AUTHN, PASSWORD_SRP
  challenge_responses: {
    "StringType" => "StringType",
  },
  session: "SessionType",
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  context_data: {
    ip_address: "StringType", # required
    server_name: "StringType", # required
    server_path: "StringType", # required
    http_headers: [ # required
      {
        header_name: "StringType",
        header_value: "StringType",
      },
    ],
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.challenge_name #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to respond to an authentication challenge.
:client_id (required, String) —

The ID of the app client where you initiated sign-in.
:challenge_name (required, String) —
The name of the challenge that you are responding to.

Possible challenges include the following:

<note markdown=“1”> All of the following challenges require ‘USERNAME` and, when the app client has a client secret, `SECRET_HASH` in the parameters. Include a `DEVICE_KEY` for device authentication.
```
</note>
```
- ‘WEB_AUTHN`: Respond to the challenge with the results of a successful authentication with a WebAuthn authenticator, or passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators include biometric devices and security keys.
- ‘PASSWORD`: Respond with the user’s password as ‘PASSWORD`.
- ‘PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
- ‘SELECT_CHALLENGE`: Respond with a challenge selection as `ANSWER`. It must be one of the challenge types in the `AvailableChallenges` response parameter. Add the parameters of the selected challenge, for example `USERNAME` and `SMS_OTP`.
- ‘SMS_MFA`: Respond with the code that your user pool delivered in an SMS message, as `SMS_MFA_CODE`
- ‘EMAIL_MFA`: Respond with the code that your user pool delivered in an email message, as `EMAIL_MFA_CODE`
- ‘EMAIL_OTP`: Respond with the code that your user pool delivered in an email message, as `EMAIL_OTP_CODE` .
- ‘SMS_OTP`: Respond with the code that your user pool delivered in an SMS message, as `SMS_OTP_CODE`.
- ‘PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP`.
- ‘CUSTOM_CHALLENGE`: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. The parameters of the challenge are determined by your Lambda function and issued in the `ChallengeParameters` of a challenge response.
- ‘DEVICE_SRP_AUTH`: Respond with the initial parameters of device SRP authentication. For more information, see [Signing in with a device].
- ‘DEVICE_PASSWORD_VERIFIER`: Respond with `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP` after client-side SRP calculations. For more information, see [Signing in with a device].
- ‘NEW_PASSWORD_REQUIRED`: For users who are required to change their passwords after successful first login. Respond to this challenge with `NEW_PASSWORD` and any required attributes that Amazon Cognito returned in the `requiredAttributes` parameter. You can also set values for attributes that aren’t required by your user pool and that your app client can write.
  
  Amazon Cognito only returns this challenge for users who have temporary passwords. When you create passwordless users, you must provide values for all required attributes.
  
  <note markdown=“1”> In a ‘NEW_PASSWORD_REQUIRED` challenge response, you can’t modify a required attribute that already has a value. In ‘AdminRespondToAuthChallenge` or `RespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `AdminUpdateUserAttributes` or `UpdateUserAttributes` API operation to modify the value of any additional attributes.
```
</note>
```
- ‘MFA_SETUP`: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters `MFAS_CAN_SETUP` value.
  
  To set up time-based one-time password (TOTP) MFA, use the session returned in this challenge from ‘InitiateAuth` or `AdminInitiateAuth` as an input to `AssociateSoftwareToken`. Then, use the session returned by `VerifySoftwareToken` as an input to `RespondToAuthChallenge` or `AdminRespondToAuthChallenge` with challenge name `MFA_SETUP` to complete sign-in.
  
  To set up SMS or email MFA, collect a ‘phone_number` or `email` attribute for the user. Then restart the authentication flow with an `InitiateAuth` or `AdminInitiateAuth` request.
[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device

:challenge_responses (Hash<String,String>) —

The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret. Include a ‘DEVICE_KEY` for device authentication.

SELECT_CHALLENGE

: ‘“ChallengeName”: “SELECT_CHALLENGE”, “ChallengeResponses”:

"USERNAME": "[username]", "ANSWER": "[Challenge name]"`

Available challenges are `PASSWORD`, `PASSWORD_SRP`, `EMAIL_OTP`,
`SMS_OTP`, and `WEB_AUTHN`.

Complete authentication in the `SELECT_CHALLENGE` response for
`PASSWORD`, `PASSWORD_SRP`, and `WEB_AUTHN`:

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "WEB_AUTHN", "USERNAME": "[username]", "CREDENTIAL":
  "[AuthenticationResponseJSON]"}`

  See [ AuthenticationResponseJSON][1].

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "PASSWORD", "USERNAME": "[username]", "PASSWORD":
  "[password]"}`

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "PASSWORD_SRP", "USERNAME": "[username]", "SRP_A":
  "[SRP_A]"}`

For `SMS_OTP` and `EMAIL_OTP`, respond with the username and answer.
Your user pool will send a code for the user to submit in the next
challenge response.

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "SMS_OTP", "USERNAME": "[username]"}`

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}`

WEB_AUTHN

: ‘“ChallengeName”: “WEB_AUTHN”, “ChallengeResponses”: { “USERNAME”:

"[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"}`

See [ AuthenticationResponseJSON][1].

PASSWORD

: ‘“ChallengeName”: “PASSWORD”, “ChallengeResponses”: { “USERNAME”:

"[username]", "PASSWORD": "[password]"}`

PASSWORD_SRP

: ‘“ChallengeName”: “PASSWORD_SRP”, “ChallengeResponses”: {

"USERNAME": "[username]", "SRP_A": "[SRP_A]"}`

SMS_OTP

: ‘“ChallengeName”: “SMS_OTP”, “ChallengeResponses”: {“SMS_OTP_CODE”:

"[code]", "USERNAME": "[username]"}`

EMAIL_OTP

: ‘“ChallengeName”: “EMAIL_OTP”, “ChallengeResponses”:

{"EMAIL_OTP_CODE": "[code]", "USERNAME": "[username]"}`

SMS_MFA

: ‘“ChallengeName”: “SMS_MFA”, “ChallengeResponses”: {“SMS_MFA_CODE”:

"[code]", "USERNAME": "[username]"}`

PASSWORD_VERIFIER

: This challenge response is part of the SRP flow. Amazon Cognito

requires that your application respond to this challenge within a
few seconds. When the response time exceeds this period, your user
pool returns a `NotAuthorizedException` error.

`"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
"PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
[timestamp], "USERNAME": "[username]"}`

CUSTOM_CHALLENGE

: ‘“ChallengeName”: “CUSTOM_CHALLENGE”, “ChallengeResponses”:

{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`

NEW_PASSWORD_REQUIRED

: ‘“ChallengeName”: “NEW_PASSWORD_REQUIRED”, “ChallengeResponses”:

{"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}`

To set any required attributes that `InitiateAuth` returned in an
`requiredAttributes` parameter, add
`"userAttributes.[attribute_name]": "[attribute_value]"`. This
parameter can also set values for writable attributes that aren't
required by your user pool.

<note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a
required attribute that already has a value. In
`AdminRespondToAuthChallenge` or `RespondToAuthChallenge`, set a
value for any keys that Amazon Cognito returned in the
`requiredAttributes` parameter, then use the
`AdminUpdateUserAttributes` or `UpdateUserAttributes` API operation
to modify the value of any additional attributes.

 </note>

SOFTWARE_TOKEN_MFA

: ‘“ChallengeName”: “SOFTWARE_TOKEN_MFA”, “ChallengeResponses”:

{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
[authenticator_code]}`

DEVICE_SRP_AUTH

: ‘“ChallengeName”: “DEVICE_SRP_AUTH”, “ChallengeResponses”:

{"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
"[srp_a]"}`

DEVICE_PASSWORD_VERIFIER

: ‘“ChallengeName”: “DEVICE_PASSWORD_VERIFIER”, “ChallengeResponses”:

{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
"[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK":
"[secret_block]", "TIMESTAMP": [timestamp], "USERNAME":
"[username]"}`

MFA_SETUP

: ‘“ChallengeName”: “MFA_SETUP”, “ChallengeResponses”: {“USERNAME”:

"[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"`

SELECT_MFA_TYPE

: ‘“ChallengeName”: “SELECT_MFA_TYPE”, “ChallengeResponses”:

{"USERNAME": "[username]", "ANSWER":
"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"}`

For more information about ‘SECRET_HASH`, see [Computing secret hash values]. For information about `DEVICE_KEY`, see [Working with user devices in your user pool].

[1]: www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson [2]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash [3]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html

:session (String) —

The session identifier that maintains the state of authentication requests and challenge responses. If an ‘AdminInitiateAuth` or `AdminRespondToAuthChallenge` API request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the next `AdminRespondToAuthChallenge` request.
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:context_data (Types::ContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
- Pre sign-up
- custom message
- Post authentication
- User migration
- Pre token generation
- Define auth challenge
- Create auth challenge
- Verify auth challenge response
When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::AdminRespondToAuthChallengeResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2876

def admin_respond_to_auth_challenge(params = {}, options = {})
  req = build_request(:admin_respond_to_auth_challenge, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_set_user_mfa_preference({
  sms_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  software_token_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  email_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  username: "UsernameType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sms_mfa_settings (Types::SMSMfaSettingsType) —

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.
:software_token_mfa_settings (Types::SoftwareTokenMfaSettingsType) —

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. This operation can set TOTP as a user’s preferred MFA method before they register a TOTP authenticator.
:email_mfa_settings (Types::EmailMfaSettingsType) —

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the [ Essentials tier] or higher.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:user_pool_id (required, String) —

The ID of the user pool where you want to set a user’s MFA preferences.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 2964

def admin_set_user_mfa_preference(params = {}, options = {})
  req = build_request(:admin_set_user_mfa_preference, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_set_user_password({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  password: "PasswordType", # required
  permanent: false,
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to set the user’s password.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:password (required, String) —

The new temporary or permanent password that you want to set for the user. You can’t remove the password for a user who already has a password so that they can only sign in with passwordless methods. In this scenario, you must create a new user without a password.
:permanent (Boolean) —

Set to ‘true` to set a password that the user can immediately sign in with. Set to `false` to set a temporary password that the user must change on their next sign-in.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3058

def admin_set_user_password(params = {}, options = {})
  req = build_request(:admin_set_user_password, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_set_user_settings({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the user whose options you’re setting.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:mfa_options (required, Array<Types::MFAOptionType>) —

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3119

def admin_set_user_settings(params = {}, options = {})
  req = build_request(:admin_set_user_settings, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_update_auth_event_feedback({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  event_id: "EventIdType", # required
  feedback_value: "Valid", # required, accepts Valid, Invalid
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to submit authentication-event feedback.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:event_id (required, String) —

The ID of the threat protection authentication event that you want to update.
:feedback_value (required, String) —

Your feedback to the authentication event. When you provide a ‘FeedbackValue` value of `valid`, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a `FeedbackValue` value of `invalid`, you tell Amazon Cognito that you don’t trust a user session, or you don’t believe that Amazon Cognito evaluated a high-enough risk level.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3194

def admin_update_auth_event_feedback(params = {}, options = {})
  req = build_request(:admin_update_auth_event_feedback, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.admin_update_device_status({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  device_key: "DeviceKeyType", # required
  device_remembered_status: "remembered", # accepts remembered, not_remembered
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to change a user’s device status.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:device_key (required, String) —

The unique identifier, or device key, of the device that you want to update the status for.
:device_remembered_status (String) —

To enable device authentication with the specified device, set to ‘remembered`.To disable, set to `not_remembered`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3261

def admin_update_device_status(params = {}, options = {})
  req = build_request(:admin_update_device_status, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [3]: console.aws.amazon.com/pinpoint/home/ [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.admin_update_user_attributes({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attributes: [ # required
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to update user attributes.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:user_attributes (required, Array<Types::AttributeType>) —

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the ‘custom:` prefix to the attribute name.

If your user pool requires verification before Amazon Cognito updates an attribute value that you specify in this request, Amazon Cognito doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.

To skip the verification message and update the value of an attribute that requires verification in the same API request, include the ‘email_verified` or `phone_number_verified` attribute, with a value of `true`. If you set the `email_verified` or `phone_number_verified` value for an `email` or `phone_number` attribute that requires verification to `true`, Amazon Cognito doesn’t send a verification message to your user.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the *custom message* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3410

def admin_update_user_attributes(params = {}, options = {})
  req = build_request(:admin_update_user_attributes, params)
  req.send_request(options)
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 revoked` error when your app attempts to authorize a user pools API request with a revoked access token that contains the scope `aws.cognito.signin.user.admin`.
Amazon Cognito no longer accepts a signed-out user’s ID token in a

GetId ][2

request to an identity pool with ‘ServerSideTokenCheck`

enabled 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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][6]

Using the Amazon Cognito user pools API and user pool endpoints][1

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html [3]: docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html [6]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html

Examples:

Request syntax with placeholder values


resp = client.admin_user_global_sign_out({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to sign out a user.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3489

def admin_user_global_sign_out(params = {}, options = {})
  req = build_request(:admin_user_global_sign_out, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

Authorize this action with a signed-in user’s access token. It must include the scope ‘aws.cognito.signin.user.admin`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.associate_software_token({
  access_token: "TokenModelType",
  session: "SessionType",
})

Response structure


resp.secret_code #=> String
resp.session #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

You can provide either an access token or a session ID in the request.
:session (String) —

The session identifier that maintains the state of authentication requests and challenge responses. In ‘AssociateSoftwareToken`, this is the session ID from a successful sign-in. You can provide either an access token or a session ID in the request.

Returns:

(Types::AssociateSoftwareTokenResponse) —
Returns a response object which responds to the following methods:
- #secret_code => String
- #session => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3551

def associate_software_token(params = {}, options = {})
  req = build_request(:associate_software_token, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 13501

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::CognitoIdentityProvider')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
  context[:gem_version] = '1.129.0'
  Seahorse::Client::Request.new(handlers, context)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.change_password({
  previous_password: "PasswordType",
  proposed_password: "PasswordType", # required
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:previous_password (String) —

The user’s previous password. Required if the user has a password. If the user has no password and only signs in with passwordless authentication options, you can omit this parameter.
:proposed_password (required, String) —

A new password that you prompted the user to enter in your application.
:access_token (required, String) —

A valid access token that Amazon Cognito issued to the user whose password you want to change.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3601

def change_password(params = {}, options = {})
  req = build_request(:change_password, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.complete_web_authn_registration({
  access_token: "TokenModelType", # required
  credential: { # required
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:credential (required, Hash, Array, String, Numeric, Boolean) —

A [RegistrationResponseJSON] public-key credential response from the user’s passkey provider.

Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

[1]: www.w3.org/TR/WebAuthn-3/#dictdef-registrationresponsejson

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3644

def complete_web_authn_registration(params = {}, options = {})
  req = build_request(:complete_web_authn_registration, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.confirm_device({
  access_token: "TokenModelType", # required
  device_key: "DeviceKeyType", # required
  device_secret_verifier_config: {
    password_verifier: "StringType",
    salt: "StringType",
  },
  device_name: "DeviceNameType",
})

Response structure


resp.user_confirmation_necessary #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:device_key (required, String) —

The unique identifier, or device key, of the device that you want to update the status for.
:device_secret_verifier_config (Types::DeviceSecretVerifierConfigType) —

The configuration of the device secret verifier.
:device_name (String) —

A friendly name for the device, for example ‘MyMobilePhone`.

Returns:

(Types::ConfirmDeviceResponse) —
Returns a response object which responds to the following methods:
- #user_confirmation_necessary => Boolean

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3712

def confirm_device(params = {}, options = {})
  req = build_request(:confirm_device, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.confirm_forgot_password({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  password: "PasswordType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the app client where the user wants to reset their password. This parameter is an identifier of the client application that users are resetting their password from, but this operation resets users’ irrespective of the app clients they sign in to.
:secret_hash (String) —

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:confirmation_code (required, String) —

The confirmation code that your user pool delivered when your user requested to reset their password.
:password (required, String) —

The new password that your user wants to set.
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the *post confirmation* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 3845

def confirm_forgot_password(params = {}, options = {})
  req = build_request(:confirm_forgot_password, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.confirm_sign_up({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  force_alias_creation: false,
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  session: "SessionType",
})

Response structure


resp.session #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the app client associated with the user pool.
:secret_hash (String) —

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:confirmation_code (required, String) —

The confirmation code that your user pool sent in response to the ‘SignUp` request.
:force_alias_creation (Boolean) —

When ‘true`, forces user confirmation despite any existing aliases. Defaults to `false`. A value of `true` migrates the alias from an existing user to the new user if an existing user already has the phone number or email address as an alias.

Say, for example, that an existing user has an ‘email` attribute of `[email protected]` and email is an alias in your user pool. If the new user also has an email of `[email protected]` and your `ConfirmSignUp` response sets `ForceAliasCreation` to `true`, the new user can sign in with a username of `[email protected]` and the existing user can no longer do so.

If ‘false` and an attribute belongs to an existing alias, this request returns an AliasExistsException error.

For more information about sign-in aliases, see [Customizing sign-in attributes].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the *post confirmation* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
:session (String) —

The optional session ID from a ‘SignUp` API request. You can sign in a user directly from the sign-up process with the `USER_AUTH` authentication flow.

Returns:

(Types::ConfirmSignUpResponse) —
Returns a response object which responds to the following methods:
- #session => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4016

def confirm_sign_up(params = {}, options = {})
  req = build_request(:confirm_sign_up, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
  description: "DescriptionType",
  role_arn: "ArnType",
  precedence: 1,
})

Response structure


resp.group.group_name #=> String
resp.group.user_pool_id #=> String
resp.group.description #=> String
resp.group.role_arn #=> String
resp.group.precedence #=> Integer
resp.group.last_modified_date #=> Time
resp.group.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

A name for the group. This name must be unique in your user pool.
:user_pool_id (required, String) —

The ID of the user pool where you want to create a user group.
:description (String) —

A description of the group that you’re creating.
:role_arn (String) —

The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a ‘cognito:preferred_role` claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a `cognito:groups` claim that list all the groups that a user is a member of.
:precedence (Integer) —

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower ‘Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user’s tokens for the ‘cognito:roles` and `cognito:preferred_role` claims.

Two groups can have the same ‘Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn’t set in users’ tokens.

The default ‘Precedence` value is null. The maximum `Precedence` value is `2^31-1`.

Returns:

(Types::CreateGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::GroupType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4109

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameTypeV2", # required
  provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
  provider_details: { # required
    "StringType" => "StringType",
  },
  attribute_mapping: {
    "AttributeMappingKeyType" => "StringType",
  },
  idp_identifiers: ["IdpIdentifierType"],
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The Id of the user pool where you want to create an IdP.
:provider_name (required, String) —

The name that you want to assign to the IdP. You can pass the identity provider name in the ‘identity_provider` query parameter of requests to the [Authorize endpoint] to silently redirect to sign-in with the associated IdP.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html
:provider_type (required, String) —

The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With Amazon, Sign In With Apple, Google, and Facebook IdPs.

:provider_details (required, Hash<String,String>) —

The scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP ‘authorize_scopes` values must match the values listed here.

OpenID Connect (OIDC)

: Amazon Cognito accepts the following elements when it can’t

discover endpoint URLs from `oidc_issuer`: `attributes_url`,
`authorize_url`, `jwks_uri`, `token_url`.

Create or update request: `"ProviderDetails": {
"attributes_request_method": "GET", "attributes_url":
"https://auth.example.com/userInfo", "authorize_scopes": "openid
profile email", "authorize_url":
"https://auth.example.com/authorize", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret",
"jwks_uri": "https://auth.example.com/.well-known/jwks.json",
"oidc_issuer": "https://auth.example.com", "token_url":
"https://example.com/token" }`

Describe response: `"ProviderDetails": {
"attributes_request_method": "GET", "attributes_url":
"https://auth.example.com/userInfo",
"attributes_url_add_attributes": "false", "authorize_scopes":
"openid profile email", "authorize_url":
"https://auth.example.com/authorize", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret",
"jwks_uri": "https://auth.example.com/.well-known/jwks.json",
"oidc_issuer": "https://auth.example.com", "token_url":
"https://example.com/token" }`

SAML

: Create or update request with Metadata URL: ‘“ProviderDetails”: {

"IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
"true", "MetadataURL": "https://auth.example.com/sso/saml/metadata",
"RequestSigningAlgorithm": "rsa-sha256" }`

Create or update request with Metadata file: `"ProviderDetails": {
"IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
"true", "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
"rsa-sha256" }`

The value of `MetadataFile` must be the plaintext metadata document
with all quote (") characters escaped by backslashes.

Describe response: `"ProviderDetails": { "IDPInit": "true",
"IDPSignout": "true", "EncryptedResponses" : "true",
"ActiveEncryptionCertificate": "[certificate]", "MetadataURL":
"https://auth.example.com/sso/saml/metadata",
"RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI":
"https://auth.example.com/slo/saml", "SSORedirectBindingURI":
"https://auth.example.com/sso/saml" }`

LoginWithAmazon

: Create or update request: ‘“ProviderDetails”: { “authorize_scopes”:

"profile postal_code", "client_id":
"amzn1.application-oa2-client.1example23456789", "client_secret":
"provider-app-client-secret"`

Describe response: `"ProviderDetails": { "attributes_url":
"https://api.amazon.com/user/profile",
"attributes_url_add_attributes": "false", "authorize_scopes":
"profile postal_code", "authorize_url":
"https://www.amazon.com/ap/oa", "client_id":
"amzn1.application-oa2-client.1example23456789", "client_secret":
"provider-app-client-secret", "token_request_method": "POST",
"token_url": "https://api.amazon.com/auth/o2/token" }`

Google

: Create or update request: ‘“ProviderDetails”: { “authorize_scopes”:

"email profile openid", "client_id":
"1example23456789.apps.googleusercontent.com", "client_secret":
"provider-app-client-secret" }`

Describe response: `"ProviderDetails": { "attributes_url":
"https://people.googleapis.com/v1/people/me?personFields=",
"attributes_url_add_attributes": "true", "authorize_scopes": "email
profile openid", "authorize_url":
"https://accounts.google.com/o/oauth2/v2/auth", "client_id":
"1example23456789.apps.googleusercontent.com", "client_secret":
"provider-app-client-secret", "oidc_issuer":
"https://accounts.google.com", "token_request_method": "POST",
"token_url": "https://www.googleapis.com/oauth2/v4/token" }`

SignInWithApple

: Create or update request: ‘“ProviderDetails”: { “authorize_scopes”:

"email name", "client_id": "com.example.cognito", "private_key":
"1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" }`

Describe response: `"ProviderDetails": {
"attributes_url_add_attributes": "false", "authorize_scopes": "email
name", "authorize_url": "https://appleid.apple.com/auth/authorize",
"client_id": "com.example.cognito", "key_id": "1EXAMPLE",
"oidc_issuer": "https://appleid.apple.com", "team_id": "2EXAMPLE",
"token_request_method": "POST", "token_url":
"https://appleid.apple.com/auth/token" }`

Facebook

: Create or update request: ‘“ProviderDetails”: { “api_version”:

"v17.0", "authorize_scopes": "public_profile, email", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret" }`

Describe response: `"ProviderDetails": { "api_version": "v17.0",
"attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
"attributes_url_add_attributes": "true", "authorize_scopes":
"public_profile, email", "authorize_url":
"https://www.facebook.com/v17.0/dialog/oauth", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret",
"token_request_method": "GET", "token_url":
"https://graph.facebook.com/v17.0/oauth/access_token" }`

:attribute_mapping (Hash<String,String>) —

A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value.
:idp_identifiers (Array<String>) —

An array of IdP identifiers, for example ‘“IdPIdentifiers”: [ “MyIdP”, “MyIdP2” ]`. Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint] to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html

Returns:

(Types::CreateIdentityProviderResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4330

def create_identity_provider(params = {}, options = {})
  req = build_request(:create_identity_provider, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_managed_login_branding({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  use_cognito_provided_values: false,
  settings: {
  },
  assets: [
    {
      category: "FAVICON_ICO", # required, accepts FAVICON_ICO, FAVICON_SVG, EMAIL_GRAPHIC, SMS_GRAPHIC, AUTH_APP_GRAPHIC, PASSWORD_GRAPHIC, PASSKEY_GRAPHIC, PAGE_HEADER_LOGO, PAGE_HEADER_BACKGROUND, PAGE_FOOTER_LOGO, PAGE_FOOTER_BACKGROUND, PAGE_BACKGROUND, FORM_BACKGROUND, FORM_LOGO, IDP_BUTTON_ICON
      color_mode: "LIGHT", # required, accepts LIGHT, DARK, DYNAMIC
      extension: "ICO", # required, accepts ICO, JPEG, PNG, SVG, WEBP
      bytes: "data",
      resource_id: "ResourceIdType",
    },
  ],
})

Response structure


resp.managed_login_branding.managed_login_branding_id #=> String
resp.managed_login_branding.user_pool_id #=> String
resp.managed_login_branding.use_cognito_provided_values #=> Boolean
resp.managed_login_branding.assets #=> Array
resp.managed_login_branding.assets[0].category #=> String, one of "FAVICON_ICO", "FAVICON_SVG", "EMAIL_GRAPHIC", "SMS_GRAPHIC", "AUTH_APP_GRAPHIC", "PASSWORD_GRAPHIC", "PASSKEY_GRAPHIC", "PAGE_HEADER_LOGO", "PAGE_HEADER_BACKGROUND", "PAGE_FOOTER_LOGO", "PAGE_FOOTER_BACKGROUND", "PAGE_BACKGROUND", "FORM_BACKGROUND", "FORM_LOGO", "IDP_BUTTON_ICON"
resp.managed_login_branding.assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp.managed_login_branding.assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp.managed_login_branding.assets[0].bytes #=> String
resp.managed_login_branding.assets[0].resource_id #=> String
resp.managed_login_branding.creation_date #=> Time
resp.managed_login_branding.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to create a new branding style.
:client_id (required, String) —

The app client that you want to create the branding style for. Each style is linked to an app client until you delete it.
:use_cognito_provided_values (Boolean) —

When true, applies the default branding style options. These default options are managed by Amazon Cognito. You can modify them later in the branding editor.

When you specify ‘true` for this option, you must also omit values for `Settings` and `Assets` in the request.
:settings (Hash, Array, String, Numeric, Boolean) —
A JSON file, encoded as a ‘Document` type, with the the settings that you want to apply to your style.

The following components are not currently implemented and reserved for future use:
- ‘signUp`
- ‘instructions`
- ‘sessionTimerDisplay`
- ‘languageSelector` (for localization, see [Managed login localization)]
Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization
:assets (Array<Types::AssetType>) —

An array of image files that you want to apply to functions like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

Returns:

(Types::CreateManagedLoginBrandingResponse) —
Returns a response object which responds to the following methods:
- #managed_login_branding => Types::ManagedLoginBrandingType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4458

def create_managed_login_branding(params = {}, options = {})
  req = build_request(:create_managed_login_branding, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
  name: "ResourceServerNameType", # required
  scopes: [
    {
      scope_name: "ResourceServerScopeNameType", # required
      scope_description: "ResourceServerScopeDescriptionType", # required
    },
  ],
})

Response structure


resp.resource_server.user_pool_id #=> String
resp.resource_server.identifier #=> String
resp.resource_server.name #=> String
resp.resource_server.scopes #=> Array
resp.resource_server.scopes[0].scope_name #=> String
resp.resource_server.scopes[0].scope_description #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to create a resource server.
:identifier (required, String) —

A unique resource server identifier for the resource server. The identifier can be an API friendly name like ‘solar-system-data`. You can also set an API URL like `solar-system-data-api.example.com` as your identifier.

Amazon Cognito represents scopes in the access token in the format ‘$resource-server-identifier/$scope`. Longer scope-identifier strings increase the size of your access tokens.
:name (required, String) —

A friendly name for the resource server.
:scopes (Array<Types::ResourceServerScopeType>) —

A list of custom scopes. Each scope is a key-value map with the keys ‘ScopeName` and `ScopeDescription`. The name of a custom scope is a combination of `ScopeName` and the resource server `Name` in this request, for example `MyResourceServerName/MyScopeName`.

Returns:

(Types::CreateResourceServerResponse) —
Returns a response object which responds to the following methods:
- #resource_server => Types::ResourceServerType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4540

def create_resource_server(params = {}, options = {})
  req = build_request(:create_resource_server, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][3]

Using the Amazon Cognito user pools API and user pool endpoints][4

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_terms({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  terms_name: "TermsNameType", # required
  terms_source: "LINK", # required, accepts LINK
  enforcement: "NONE", # required, accepts NONE
  links: {
    "LanguageIdType" => "LinkUrlType",
  },
})

Response structure


resp.terms.terms_id #=> String
resp.terms.user_pool_id #=> String
resp.terms.client_id #=> String
resp.terms.terms_name #=> String
resp.terms.terms_source #=> String, one of "LINK"
resp.terms.enforcement #=> String, one of "NONE"
resp.terms.links #=> Hash
resp.terms.links["LanguageIdType"] #=> String
resp.terms.creation_date #=> Time
resp.terms.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to create terms documents.
:client_id (required, String) —

The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.
:terms_name (required, String) —

A friendly name for the document that you want to create in the current request. Must begin with ‘terms-of-use` or `privacy-policy` as identification of the document type. Provide URLs for both `terms-of-use` and `privacy-policy` in separate requests.
:terms_source (required, String) —

This parameter is reserved for future use and currently accepts only one value.
:enforcement (required, String) —

This parameter is reserved for future use and currently accepts only one value.
:links (Hash<String,String>) —

A map of URLs to languages. For each localized language that will view the requested ‘TermsName`, assign a URL. A selection of `cognito:default` displays for all languages that don’t have a language-specific URL.

For example, ‘“cognito:default”: “terms.example.com”, “cognito:spanish”: “terms.example.com/es”`.

Returns:

(Types::CreateTermsResponse) —
Returns a response object which responds to the following methods:
- #terms => Types::TermsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4646

def create_terms(params = {}, options = {})
  req = build_request(:create_terms, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_user_import_job({
  job_name: "UserImportJobNameType", # required
  user_pool_id: "UserPoolIdType", # required
  cloud_watch_logs_role_arn: "ArnType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:job_name (required, String) —

A friendly name for the user import job.
:user_pool_id (required, String) —

The ID of the user pool that you want to import users into.
:cloud_watch_logs_role_arn (required, String) —

You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role.

Returns:

(Types::CreateUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 4716

def create_user_import_job(params = {}, options = {})
  req = build_request(:create_user_import_job, params)
  req.send_request(options)
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.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][3]

Using the Amazon Cognito user pools API and user pool endpoints][4

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Example: Example user pool with email and username sign-in


# The following example creates a user pool with all configurable properties set to an example value. The resulting user
# pool allows sign-in with username or email address, has optional MFA, and has a Lambda function assigned to each
# possible trigger.

resp = client.create_user_pool({
  account_recovery_setting: {
    recovery_mechanisms: [
      {
        name: "verified_email", 
        priority: 1, 
      }, 
    ], 
  }, 
  admin_create_user_config: {
    allow_admin_create_user_only: false, 
    invite_message_template: {
      email_message: "Your username is {username} and temporary password is {####}.", 
      email_subject: "Your sign-in information", 
      sms_message: "Your username is {username} and temporary password is {####}.", 
    }, 
  }, 
  alias_attributes: [
    "email", 
  ], 
  auto_verified_attributes: [
    "email", 
  ], 
  deletion_protection: "ACTIVE", 
  device_configuration: {
    challenge_required_on_new_device: true, 
    device_only_remembered_on_user_prompt: true, 
  }, 
  email_configuration: {
    configuration_set: "my-test-ses-configuration-set", 
    email_sending_account: "DEVELOPER", 
    from: "[email protected]", 
    reply_to_email_address: "[email protected]", 
    source_arn: "arn:aws:ses:us-east-1:123456789012:identity/[email protected]", 
  }, 
  email_verification_message: "Your verification code is {####}.", 
  email_verification_subject: "Verify your email address", 
  lambda_config: {
    custom_email_sender: {
      lambda_arn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      lambda_version: "V1_0", 
    }, 
    custom_message: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    custom_sms_sender: {
      lambda_arn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      lambda_version: "V1_0", 
    }, 
    define_auth_challenge: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    kms_key_id: "arn:aws:kms:us-east-1:123456789012:key/a6c4f8e2-0c45-47db-925f-87854bc9e357", 
    post_authentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    post_confirmation: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    pre_authentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    pre_sign_up: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    pre_token_generation: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    user_migration: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    verify_auth_challenge_response: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
  }, 
  mfa_configuration: "OPTIONAL", 
  policies: {
    password_policy: {
      minimum_length: 6, 
      require_lowercase: true, 
      require_numbers: true, 
      require_symbols: true, 
      require_uppercase: true, 
      temporary_password_validity_days: 7, 
    }, 
  }, 
  pool_name: "my-test-user-pool", 
  schema: [
    {
      attribute_data_type: "Number", 
      developer_only_attribute: true, 
      mutable: true, 
      name: "mydev", 
      number_attribute_constraints: {
        max_value: "99", 
        min_value: "1", 
      }, 
      required: false, 
      string_attribute_constraints: {
        max_length: "99", 
        min_length: "1", 
      }, 
    }, 
  ], 
  sms_authentication_message: "Your verification code is {####}.", 
  sms_configuration: {
    external_id: "my-role-external-id", 
    sns_caller_arn: "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role", 
  }, 
  sms_verification_message: "Your verification code is {####}.", 
  user_attribute_update_settings: {
    attributes_require_verification_before_update: [
      "email", 
    ], 
  }, 
  user_pool_add_ons: {
    advanced_security_mode: "OFF", 
  }, 
  user_pool_tags: {
    "my-test-tag-key" => "my-test-tag-key", 
  }, 
  username_configuration: {
    case_sensitive: true, 
  }, 
  verification_message_template: {
    default_email_option: "CONFIRM_WITH_CODE", 
    email_message: "Your confirmation code is {####}", 
    email_message_by_link: "Choose this link to {##verify your email##}", 
    email_subject: "Here is your confirmation code", 
    email_subject_by_link: "Here is your confirmation link", 
    sms_message: "Your confirmation code is {####}", 
  }, 
})

resp.to_h outputs the following:
{
  user_pool: {
    account_recovery_setting: {
      recovery_mechanisms: [
        {
          name: "verified_email", 
          priority: 1, 
        }, 
      ], 
    }, 
    admin_create_user_config: {
      allow_admin_create_user_only: false, 
      invite_message_template: {
        email_message: "Your username is {username} and temporary password is {####}.", 
        email_subject: "Your sign-in information", 
        sms_message: "Your username is {username} and temporary password is {####}.", 
      }, 
      unused_account_validity_days: 7, 
    }, 
    alias_attributes: [
      "email", 
    ], 
    arn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_EXAMPLE", 
    auto_verified_attributes: [
      "email", 
    ], 
    creation_date: Time.parse(1689721665.239), 
    deletion_protection: "ACTIVE", 
    device_configuration: {
      challenge_required_on_new_device: true, 
      device_only_remembered_on_user_prompt: true, 
    }, 
    email_configuration: {
      configuration_set: "my-test-ses-configuration-set", 
      email_sending_account: "DEVELOPER", 
      from: "[email protected]", 
      reply_to_email_address: "[email protected]", 
      source_arn: "arn:aws:ses:us-east-1:123456789012:identity/[email protected]", 
    }, 
    email_verification_message: "Your verification code is {####}.", 
    email_verification_subject: "Verify your email address", 
    estimated_number_of_users: 0, 
    id: "us-east-1_EXAMPLE", 
    lambda_config: {
      custom_email_sender: {
        lambda_arn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
        lambda_version: "V1_0", 
      }, 
      custom_message: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      custom_sms_sender: {
        lambda_arn: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
        lambda_version: "V1_0", 
      }, 
      define_auth_challenge: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      kms_key_id: "arn:aws:kms:us-east-1:767671399759:key/4d43904c-8edf-4bb4-9fca-fb1a80e41cbe", 
      post_authentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      post_confirmation: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      pre_authentication: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      pre_sign_up: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      pre_token_generation: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      user_migration: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
      verify_auth_challenge_response: "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    }, 
    last_modified_date: Time.parse(1689721665.239), 
    mfa_configuration: "OPTIONAL", 
    name: "my-test-user-pool", 
    policies: {
      password_policy: {
        minimum_length: 6, 
        require_lowercase: true, 
        require_numbers: true, 
        require_symbols: true, 
        require_uppercase: true, 
        temporary_password_validity_days: 7, 
      }, 
    }, 
    schema_attributes: [
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: false, 
        name: "sub", 
        required: true, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "1", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "name", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "given_name", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "family_name", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "middle_name", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "nickname", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "preferred_username", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "profile", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "picture", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "website", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "email", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "Boolean", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "email_verified", 
        required: false, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "gender", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "birthdate", 
        required: false, 
        string_attribute_constraints: {
          max_length: "10", 
          min_length: "10", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "zoneinfo", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "locale", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "phone_number", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "Boolean", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "phone_number_verifie", 
        required: false, 
      }, 
      {
        attribute_data_type: "String", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "address", 
        required: false, 
        string_attribute_constraints: {
          max_length: "2048", 
          min_length: "0", 
        }, 
      }, 
      {
        attribute_data_type: "Number", 
        developer_only_attribute: false, 
        mutable: true, 
        name: "updated_at", 
        number_attribute_constraints: {
          min_value: "0", 
        }, 
        required: false, 
      }, 
      {
        attribute_data_type: "Number", 
        developer_only_attribute: true, 
        mutable: true, 
        name: "dev:custom:mydev", 
        number_attribute_constraints: {
          max_value: "99", 
          min_value: "1", 
        }, 
        required: false, 
      }, 
    ], 
    sms_authentication_message: "Your verification code is {####}.", 
    sms_configuration: {
      external_id: "my-role-external-id", 
      sns_caller_arn: "arn:aws:iam::123456789012:role/service-role/test-cognito-SMS-Role", 
      sns_region: "us-east-1", 
    }, 
    sms_verification_message: "Your verification code is {####}.", 
    user_attribute_update_settings: {
      attributes_require_verification_before_update: [
        "email", 
      ], 
    }, 
    user_pool_add_ons: {
      advanced_security_mode: "OFF", 
    }, 
    user_pool_tags: {
      "my-test-tag-key" => "my-test-tag-value", 
    }, 
    username_configuration: {
      case_sensitive: true, 
    }, 
    verification_message_template: {
      default_email_option: "CONFIRM_WITH_CODE", 
      email_message: "Your confirmation code is {####}", 
      email_message_by_link: "Choose this link to {##verify your email##}", 
      email_subject: "Here is your confirmation code", 
      email_subject_by_link: "Here is your confirmation link", 
      sms_message: "Your confirmation code is {####}", 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.create_user_pool({
  pool_name: "UserPoolNameType", # required
  policies: {
    password_policy: {
      minimum_length: 1,
      require_uppercase: false,
      require_lowercase: false,
      require_numbers: false,
      require_symbols: false,
      password_history_size: 1,
      temporary_password_validity_days: 1,
    },
    sign_in_policy: {
      allowed_first_auth_factors: ["PASSWORD"], # accepts PASSWORD, EMAIL_OTP, SMS_OTP, WEB_AUTHN
    },
  },
  deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
  lambda_config: {
    pre_sign_up: "ArnType",
    custom_message: "ArnType",
    post_confirmation: "ArnType",
    pre_authentication: "ArnType",
    post_authentication: "ArnType",
    define_auth_challenge: "ArnType",
    create_auth_challenge: "ArnType",
    verify_auth_challenge_response: "ArnType",
    pre_token_generation: "ArnType",
    user_migration: "ArnType",
    pre_token_generation_config: {
      lambda_version: "V1_0", # required, accepts V1_0, V2_0, V3_0
      lambda_arn: "ArnType", # required
    },
    custom_sms_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    custom_email_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    kms_key_id: "ArnType",
  },
  auto_verified_attributes: ["phone_number"], # accepts phone_number, email
  alias_attributes: ["phone_number"], # accepts phone_number, email, preferred_username
  username_attributes: ["phone_number"], # accepts phone_number, email
  sms_verification_message: "SmsVerificationMessageType",
  email_verification_message: "EmailVerificationMessageType",
  email_verification_subject: "EmailVerificationSubjectType",
  verification_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
    email_message_by_link: "EmailVerificationMessageByLinkType",
    email_subject_by_link: "EmailVerificationSubjectByLinkType",
    default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
  },
  sms_authentication_message: "SmsVerificationMessageType",
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  user_attribute_update_settings: {
    attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
  },
  device_configuration: {
    challenge_required_on_new_device: false,
    device_only_remembered_on_user_prompt: false,
  },
  email_configuration: {
    source_arn: "ArnType",
    reply_to_email_address: "EmailAddressType",
    email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
    from: "StringType",
    configuration_set: "SESConfigurationSet",
  },
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
    sns_region: "RegionCodeType",
  },
  user_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
  admin_create_user_config: {
    allow_admin_create_user_only: false,
    unused_account_validity_days: 1,
    invite_message_template: {
      sms_message: "SmsInviteMessageType",
      email_message: "EmailInviteMessageType",
      email_subject: "EmailVerificationSubjectType",
    },
  },
  schema: [
    {
      name: "CustomAttributeNameType",
      attribute_data_type: "String", # accepts String, Number, DateTime, Boolean
      developer_only_attribute: false,
      mutable: false,
      required: false,
      number_attribute_constraints: {
        min_value: "StringType",
        max_value: "StringType",
      },
      string_attribute_constraints: {
        min_length: "StringType",
        max_length: "StringType",
      },
    },
  ],
  user_pool_add_ons: {
    advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
    advanced_security_additional_flows: {
      custom_auth_mode: "AUDIT", # accepts AUDIT, ENFORCED
    },
  },
  username_configuration: {
    case_sensitive: false, # required
  },
  account_recovery_setting: {
    recovery_mechanisms: [
      {
        priority: 1, # required
        name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
      },
    ],
  },
  user_pool_tier: "LITE", # accepts LITE, ESSENTIALS, PLUS
})

Response structure


resp.user_pool.id #=> String
resp.user_pool.name #=> String
resp.user_pool.policies.password_policy.minimum_length #=> Integer
resp.user_pool.policies.password_policy.require_uppercase #=> Boolean
resp.user_pool.policies.password_policy.require_lowercase #=> Boolean
resp.user_pool.policies.password_policy.require_numbers #=> Boolean
resp.user_pool.policies.password_policy.require_symbols #=> Boolean
resp.user_pool.policies.password_policy.password_history_size #=> Integer
resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors #=> Array
resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN"
resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
resp.user_pool.lambda_config.pre_sign_up #=> String
resp.user_pool.lambda_config.custom_message #=> String
resp.user_pool.lambda_config.post_confirmation #=> String
resp.user_pool.lambda_config.pre_authentication #=> String
resp.user_pool.lambda_config.post_authentication #=> String
resp.user_pool.lambda_config.define_auth_challenge #=> String
resp.user_pool.lambda_config.create_auth_challenge #=> String
resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
resp.user_pool.lambda_config.pre_token_generation #=> String
resp.user_pool.lambda_config.user_migration #=> String
resp.user_pool.lambda_config.pre_token_generation_config.lambda_version #=> String, one of "V1_0", "V2_0", "V3_0"
resp.user_pool.lambda_config.pre_token_generation_config.lambda_arn #=> String
resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
resp.user_pool.lambda_config.kms_key_id #=> String
resp.user_pool.status #=> String, one of "Enabled", "Disabled"
resp.user_pool.last_modified_date #=> Time
resp.user_pool.creation_date #=> Time
resp.user_pool.schema_attributes #=> Array
resp.user_pool.schema_attributes[0].name #=> String
resp.user_pool.schema_attributes[0].attribute_data_type #=> String, one of "String", "Number", "DateTime", "Boolean"
resp.user_pool.schema_attributes[0].developer_only_attribute #=> Boolean
resp.user_pool.schema_attributes[0].mutable #=> Boolean
resp.user_pool.schema_attributes[0].required #=> Boolean
resp.user_pool.schema_attributes[0].number_attribute_constraints.min_value #=> String
resp.user_pool.schema_attributes[0].number_attribute_constraints.max_value #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.min_length #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.max_length #=> String
resp.user_pool.auto_verified_attributes #=> Array
resp.user_pool.auto_verified_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.alias_attributes #=> Array
resp.user_pool.alias_attributes[0] #=> String, one of "phone_number", "email", "preferred_username"
resp.user_pool.username_attributes #=> Array
resp.user_pool.username_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.sms_verification_message #=> String
resp.user_pool.email_verification_message #=> String
resp.user_pool.email_verification_subject #=> String
resp.user_pool.verification_message_template.sms_message #=> String
resp.user_pool.verification_message_template.email_message #=> String
resp.user_pool.verification_message_template.email_subject #=> String
resp.user_pool.verification_message_template.email_message_by_link #=> String
resp.user_pool.verification_message_template.email_subject_by_link #=> String
resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
resp.user_pool.sms_authentication_message #=> String
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
resp.user_pool.estimated_number_of_users #=> Integer
resp.user_pool.email_configuration.source_arn #=> String
resp.user_pool.email_configuration.reply_to_email_address #=> String
resp.user_pool.email_configuration.email_sending_account #=> String, one of "COGNITO_DEFAULT", "DEVELOPER"
resp.user_pool.email_configuration.from #=> String
resp.user_pool.email_configuration.configuration_set #=> String
resp.user_pool.sms_configuration.sns_caller_arn #=> String
resp.user_pool.sms_configuration.external_id #=> String
resp.user_pool.sms_configuration.sns_region #=> String
resp.user_pool.user_pool_tags #=> Hash
resp.user_pool.user_pool_tags["TagKeysType"] #=> String
resp.user_pool.sms_configuration_failure #=> String
resp.user_pool.email_configuration_failure #=> String
resp.user_pool.domain #=> String
resp.user_pool.custom_domain #=> String
resp.user_pool.admin_create_user_config.allow_admin_create_user_only #=> Boolean
resp.user_pool.admin_create_user_config.unused_account_validity_days #=> Integer
resp.user_pool.admin_create_user_config.invite_message_template.sms_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
resp.user_pool.user_pool_add_ons.advanced_security_additional_flows.custom_auth_mode #=> String, one of "AUDIT", "ENFORCED"
resp.user_pool.username_configuration.case_sensitive #=> Boolean
resp.user_pool.arn #=> String
resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].name #=> String, one of "verified_email", "verified_phone_number", "admin_only"
resp.user_pool.user_pool_tier #=> String, one of "LITE", "ESSENTIALS", "PLUS"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:pool_name (required, String) —

A friendly name for your user pool.
:policies (Types::UserPoolPolicyType) —

The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in [choice-based authentication].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice
:deletion_protection (String) —

When active, ‘DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a ‘DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.
:lambda_config (Types::LambdaConfigType) —

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
:auto_verified_attributes (Array<String>) —

The attributes that you want your user pool to automatically verify. For more information, see [Verifying contact information at sign-up].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves
:alias_attributes (Array<String>) —

Attributes supported as an alias for this user pool. For more information about alias attributes, see [Customizing sign-in attributes].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases
:username_attributes (Array<String>) —

Specifies whether a user can use an email address or phone number as a username when they sign up. For more information, see [Customizing sign-in attributes].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases
:sms_verification_message (String) —

This parameter is no longer used.
:email_verification_message (String) —

This parameter is no longer used.
:email_verification_subject (String) —

This parameter is no longer used.
:verification_message_template (Types::VerificationMessageTemplateType) —

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Set the email message type that corresponds to your ‘DefaultEmailOption` selection. For `CONFIRM_WITH_LINK`, specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE`, specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
:sms_authentication_message (String) —

The contents of the SMS message that your user pool sends to users in SMS OTP and MFA authentication.
:mfa_configuration (String) —

Sets multi-factor authentication (MFA) to be on, off, or optional. When ‘ON`, all users must set up MFA before they can sign in. When `OPTIONAL`, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose `OPTIONAL`.

When ‘MfaConfiguration` is `OPTIONAL`, managed login doesn’t automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
:user_attribute_update_settings (Types::UserAttributeUpdateSettingsType) —

The settings for updates to user attributes. These settings include the property ‘AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see [ Verifying updates to email addresses and phone numbers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
:device_configuration (Types::DeviceConfigurationType) —
The device-remembering configuration for a user pool. Device remembering or device tracking 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]. A null value indicates that you have deactivated device remembering in your user pool.

<note markdown=“1”> When you provide a value for any ‘DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more information, see [Working with devices].
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
:email_configuration (Types::EmailConfigurationType) —

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
:sms_configuration (Types::SmsConfigurationType) —

The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For more information see [SMS message settings].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
:user_pool_tags (Hash<String,String>) —

The tag keys and values to assign to the 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.
:admin_create_user_config (Types::AdminCreateUserConfigType) —

The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.
:schema (Array<Types::SchemaAttributeType>) —

An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see [Working with user attributes].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html
:user_pool_add_ons (Types::UserPoolAddOnsType) —

Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to ‘AUDIT`. To configure automatic security responses to potentially unwanted traffic to your user pool, set to `ENFORCED`.

For more information, see [Adding advanced security to a user pool]. To activate this setting, your user pool must be on the [ Plus tier].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html
:username_configuration (Types::UsernameConfigurationType) —

Sets the case sensitivity option for sign-in usernames. When ‘CaseSensitive` is `false` (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, `username`, `USERNAME`, or `UserName`, or for email, `[email protected]` or `[email protected]`. For most use cases, set case sensitivity to `false` as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

When ‘CaseSensitive` is `true` (case sensitive), Amazon Cognito interprets `USERNAME` and `UserName` as distinct users.

This configuration is immutable after you set it.
:account_recovery_setting (Types::AccountRecoverySettingType) —

The available verified method a user can use to recover their password when they call ‘ForgotPassword`. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn’t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. Email MFA is also disqualifying for account recovery with email. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

As a best practice, configure both ‘verified_email` and `verified_phone_number`, with one having a higher priority than the other.
:user_pool_tier (String) —

The user pool [feature plan], or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ‘ESSENTIALS`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html

Returns:

(Types::CreateUserPoolResponse) —
Returns a response object which responds to the following methods:
- #user_pool => Types::UserPoolType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 5672

def create_user_pool(params = {}, options = {})
  req = build_request(:create_user_pool, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Example: Example user pool app client with email and username sign-in


# The following example creates an app client with all configurable properties set to an example value. The resulting user
# pool client connects to an analytics client, allows sign-in with username and password, and has two external identity
# providers associated with it.

resp = client.create_user_pool_client({
  access_token_validity: 6, 
  allowed_o_auth_flows: [
    "code", 
  ], 
  allowed_o_auth_flows_user_pool_client: true, 
  allowed_o_auth_scopes: [
    "aws.cognito.signin.user.admin", 
    "openid", 
  ], 
  analytics_configuration: {
    application_id: "d70b2ba36a8c4dc5a04a0451a31a1e12", 
    external_id: "my-external-id", 
    role_arn: "arn:aws:iam::123456789012:role/test-cognitouserpool-role", 
    user_data_shared: true, 
  }, 
  callback_urls: [
    "https://example.com", 
    "http://localhost", 
    "myapp://example", 
  ], 
  client_name: "my-test-app-client", 
  default_redirect_uri: "https://example.com", 
  explicit_auth_flows: [
    "ALLOW_ADMIN_USER_PASSWORD_AUTH", 
    "ALLOW_USER_PASSWORD_AUTH", 
    "ALLOW_REFRESH_TOKEN_AUTH", 
  ], 
  generate_secret: true, 
  id_token_validity: 6, 
  logout_urls: [
    "https://example.com/logout", 
  ], 
  prevent_user_existence_errors: "ENABLED", 
  read_attributes: [
    "email", 
    "address", 
    "preferred_username", 
  ], 
  refresh_token_validity: 6, 
  supported_identity_providers: [
    "SignInWithApple", 
    "MySSO", 
  ], 
  token_validity_units: {
    access_token: "hours", 
    id_token: "minutes", 
    refresh_token: "days", 
  }, 
  user_pool_id: "us-east-1_EXAMPLE", 
  write_attributes: [
    "family_name", 
    "email", 
  ], 
})

resp.to_h outputs the following:
{
  user_pool_client: {
    access_token_validity: 6, 
    allowed_o_auth_flows: [
      "code", 
    ], 
    allowed_o_auth_flows_user_pool_client: true, 
    allowed_o_auth_scopes: [
      "aws.cognito.signin.user.admin", 
      "openid", 
    ], 
    analytics_configuration: {
      application_id: "d70b2ba36a8c4dc5a04a0451a31a1e12", 
      external_id: "my-external-id", 
      role_arn: "arn:aws:iam::123456789012:role/test-cognitouserpool-role", 
      user_data_shared: true, 
    }, 
    auth_session_validity: 3, 
    callback_urls: [
      "https://example.com", 
      "http://localhost", 
      "myapp://example", 
    ], 
    client_id: "26cb2c60kq7nbmas7rbme9b6pp", 
    client_name: "my-test-app-client", 
    client_secret: "13ka4h7u28d9oo44tqpq9djqsfvhvu8rk4d2ighvpu0k8fj1c2r9", 
    creation_date: Time.parse(1689885426.107), 
    default_redirect_uri: "https://example.com", 
    enable_propagate_additional_user_context_data: false, 
    enable_token_revocation: true, 
    explicit_auth_flows: [
      "ALLOW_USER_PASSWORD_AUTH", 
      "ALLOW_ADMIN_USER_PASSWORD_AUTH", 
      "ALLOW_REFRESH_TOKEN_AUTH", 
    ], 
    id_token_validity: 6, 
    last_modified_date: Time.parse(1689885426.107), 
    logout_urls: [
      "https://example.com/logout", 
    ], 
    prevent_user_existence_errors: "ENABLED", 
    read_attributes: [
      "address", 
      "preferred_username", 
      "email", 
    ], 
    refresh_token_validity: 6, 
    supported_identity_providers: [
      "SignInWithApple", 
      "MySSO", 
    ], 
    token_validity_units: {
      access_token: "hours", 
      id_token: "minutes", 
      refresh_token: "days", 
    }, 
    user_pool_id: "us-east-1_EXAMPLE", 
    write_attributes: [
      "family_name", 
      "email", 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.create_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_name: "ClientNameType", # required
  generate_secret: false,
  refresh_token_validity: 1,
  access_token_validity: 1,
  id_token_validity: 1,
  token_validity_units: {
    access_token: "seconds", # accepts seconds, minutes, hours, days
    id_token: "seconds", # accepts seconds, minutes, hours, days
    refresh_token: "seconds", # accepts seconds, minutes, hours, days
  },
  read_attributes: ["ClientPermissionType"],
  write_attributes: ["ClientPermissionType"],
  explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_AUTH
  supported_identity_providers: ["ProviderNameType"],
  callback_urls: ["RedirectUrlType"],
  logout_urls: ["RedirectUrlType"],
  default_redirect_uri: "RedirectUrlType",
  allowed_o_auth_flows: ["code"], # accepts code, implicit, client_credentials
  allowed_o_auth_scopes: ["ScopeType"],
  allowed_o_auth_flows_user_pool_client: false,
  analytics_configuration: {
    application_id: "HexStringType",
    application_arn: "ArnType",
    role_arn: "ArnType",
    external_id: "StringType",
    user_data_shared: false,
  },
  prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
  enable_token_revocation: false,
  enable_propagate_additional_user_context_data: false,
  auth_session_validity: 1,
  refresh_token_rotation: {
    feature: "ENABLED", # required, accepts ENABLED, DISABLED
    retry_grace_period_seconds: 1,
  },
})

Response structure


resp.user_pool_client.user_pool_id #=> String
resp.user_pool_client.client_name #=> String
resp.user_pool_client.client_id #=> String
resp.user_pool_client.client_secret #=> String
resp.user_pool_client.last_modified_date #=> Time
resp.user_pool_client.creation_date #=> Time
resp.user_pool_client.refresh_token_validity #=> Integer
resp.user_pool_client.access_token_validity #=> Integer
resp.user_pool_client.id_token_validity #=> Integer
resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.read_attributes #=> Array
resp.user_pool_client.read_attributes[0] #=> String
resp.user_pool_client.write_attributes #=> Array
resp.user_pool_client.write_attributes[0] #=> String
resp.user_pool_client.explicit_auth_flows #=> Array
resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH"
resp.user_pool_client.supported_identity_providers #=> Array
resp.user_pool_client.supported_identity_providers[0] #=> String
resp.user_pool_client.callback_urls #=> Array
resp.user_pool_client.callback_urls[0] #=> String
resp.user_pool_client.logout_urls #=> Array
resp.user_pool_client.logout_urls[0] #=> String
resp.user_pool_client.default_redirect_uri #=> String
resp.user_pool_client.allowed_o_auth_flows #=> Array
resp.user_pool_client.allowed_o_auth_flows[0] #=> String, one of "code", "implicit", "client_credentials"
resp.user_pool_client.allowed_o_auth_scopes #=> Array
resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
resp.user_pool_client.analytics_configuration.application_id #=> String
resp.user_pool_client.analytics_configuration.application_arn #=> String
resp.user_pool_client.analytics_configuration.role_arn #=> String
resp.user_pool_client.analytics_configuration.external_id #=> String
resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
resp.user_pool_client.enable_token_revocation #=> Boolean
resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
resp.user_pool_client.auth_session_validity #=> Integer
resp.user_pool_client.refresh_token_rotation.feature #=> String, one of "ENABLED", "DISABLED"
resp.user_pool_client.refresh_token_rotation.retry_grace_period_seconds #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to create an app client.
:client_name (required, String) —

A friendly name for the app client that you want to create.
:generate_secret (Boolean) —

When ‘true`, generates a client secret for the app client. Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can’t specify a secret value. For more information, see [App client types].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types
:refresh_token_validity (Integer) —

The refresh token time limit. After this limit expires, your user can’t use their refresh token. To specify the time unit for ‘RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set ‘RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for ‘RefreshTokenValidity` in an API request is days. You can’t set ‘RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. *Valid range* is displayed below in seconds.

If you don’t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
:access_token_validity (Integer) —

The access token time limit. After this limit expires, your user can’t use their access token. To specify the time unit for ‘AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set ‘AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours.

The default time unit for ‘AccessTokenValidity` in an API request is hours. *Valid range* is displayed below in seconds.

If you don’t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
:id_token_validity (Integer) —

The ID token time limit. After this limit expires, your user can’t use their ID token. To specify the time unit for ‘IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set ‘IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours.

The default time unit for ‘IdTokenValidity` in an API request is hours. *Valid range* is displayed below in seconds.

If you don’t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
:token_validity_units (Types::TokenValidityUnitsType) —

The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
:read_attributes (Array<String>) —

The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list.

When you don’t specify the ‘ReadAttributes` for your app client, your app can read the values of `email_verified`, `phone_number_verified`, and the standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn’t return any information. Amazon Cognito only populates ‘ReadAttributes` in the API response if you have specified your own custom set of read attributes.
:write_attributes (Array<String>) —

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.

When you don’t specify the ‘WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn’t return any information. Amazon Cognito only populates ‘WriteAttributes` in the API response if you have specified your own custom set of write attributes.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
:explicit_auth_flows (Array<String>) —
The [authentication flows] that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

<note markdown=“1”> If you don’t specify a value for ‘ExplicitAuthFlows`, your app client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`.
```
</note>
```
The values for authentication flow options include the following.
- ‘ALLOW_USER_AUTH`: Enable selection-based sign-in with `USER_AUTH`. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other `ExplicitAuthFlows` permitting them. For example users can complete an SRP challenge through `USER_AUTH` without the flow `USER_SRP_AUTH` being active for the app client. This flow doesn’t include ‘CUSTOM_AUTH`.
  
  To activate this setting, your user pool must be in the [ Essentials tier] or higher.
- ‘ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
- ‘ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based authentication.
- ‘ALLOW_USER_PASSWORD_AUTH`: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
- ‘ALLOW_USER_SRP_AUTH`: Enable SRP-based authentication.
- ‘ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.
In some environments, you will see the values ‘ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can’t assign these legacy ‘ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
:supported_identity_providers (Array<String>) —

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: ‘COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`.

This parameter sets the IdPs that [managed login] will display on the login page for your app client. The removal of ‘COGNITO` from this list doesn’t prevent authentication operations for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent SDK-based authentication is to block access with a [WAF rule].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html
:callback_urls (Array<String>) —
A list of allowed redirect, or callback, URLs for managed login authentication. These URLs are the paths where you want to send your users’ browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.

A redirect URI must meet the following requirements:
- Be an absolute URI.
- Be registered with the authorization server. Amazon Cognito doesn’t accept authorization requests with ‘redirect_uri` values that aren’t in the list of ‘CallbackURLs` that you provide in this parameter.
- Not include a fragment component.
See [OAuth 2.0 - Redirection Endpoint].

Amazon Cognito requires HTTPS over HTTP except for localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

[1]: tools.ietf.org/html/rfc6749#section-3.1.2
:logout_urls (Array<String>) —

A list of allowed logout URLs for managed login authentication. When you pass ‘logout_uri` and `client_id` parameters to `/logout`, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of `logout_uri`. A typical use of these URLs is when a user selects “Sign out” and you redirect them to your public homepage. For more information, see [Logout endpoint].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
:default_redirect_uri (String) —

The default redirect URI. In app clients with one assigned IdP, replaces ‘redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.
:allowed_o_auth_flows (Array<String>) —
The OAuth grant types that you want your app client to generate for clients in managed login authentication. To create an app client that generates client credentials grants, you must add ‘client_credentials` as the only allowed OAuth flow.

code

: Use a code grant flow, which provides an authorization code as the
```
response. This code can be exchanged for access tokens with the
`/oauth2/token` endpoint.
```
implicit

: Issue the access token, and the ID token when scopes like ‘openid`
```
and `profile` are requested, directly to your user.
```
client_credentials

: Issue the access token from the ‘/oauth2/token` endpoint directly to
```
a non-person user, authorized by a combination of the client ID and
client secret.
```
:allowed_o_auth_scopes (Array<String>) —

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. Scopes govern access control to user pool self-service API operations, user data from the ‘userInfo` endpoint, and third-party APIs. Scope values include `phone`, `email`, `openid`, and `profile`. The `aws.cognito.signin.user.admin` scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.
:allowed_o_auth_flows_user_pool_client (Boolean) —
Set to ‘true` to use OAuth 2.0 authorization server features in your app client.

This parameter must have a value of ‘true` before you can configure the following features in your app client.
- ‘CallBackURLs`: Callback URLs.
- ‘LogoutURLs`: Sign-out redirect URLs.
- ‘AllowedOAuthScopes`: OAuth 2.0 scopes.
- ‘AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set ‘AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don’t set a value for ‘AllowedOAuthFlowsUserPoolClient` in a request with the CLI or SDKs, it defaults to `false`. When `false`, only SDK-based API sign-in is permitted.
:analytics_configuration (Types::AnalyticsConfigurationType) —

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In Amazon Web Services Regions where Amazon Pinpoint isn’t available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html
:prevent_user_existence_errors (String) —

When ‘ENABLED`, suppresses messages that might indicate a valid user exists when someone attempts sign-in. This parameters sets your preference for the errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn’t exist in the user pool. When set to ‘ENABLED` and the user doesn’t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to ‘LEGACY`, those APIs return a `UserNotFoundException` exception if the user doesn’t exist in the user pool.

Defaults to ‘LEGACY`.
:enable_token_revocation (Boolean) —

Activates or deactivates [token revocation] in the target app client.

If you don’t include this parameter, token revocation is automatically activated for the new user pool client.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html
:enable_propagate_additional_user_context_data (Boolean) —

When ‘true`, your application can include additional `UserContextData` in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see [Adding session data to API requests]. If you don’t include this parameter, you can’t send the source IP address to Amazon Cognito threat protection features. You can only activate ‘EnablePropagateAdditionalUserContextData` in an app client that has a client secret.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint
:auth_session_validity (Integer) —

Amazon Cognito creates a session token for each API request in an authentication flow. ‘AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
:refresh_token_rotation (Types::RefreshTokenRotationType) —

The configuration of your app client for refresh token rotation. When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.

Returns:

(Types::CreateUserPoolClientResponse) —
Returns a response object which responds to the following methods:
- #user_pool_client => Types::UserPoolClientType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6284

def create_user_pool_client(params = {}, options = {})
  req = build_request(:create_user_pool_client, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.create_user_pool_domain({
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
  managed_login_version: 1,
  custom_domain_config: {
    certificate_arn: "ArnType", # required
  },
})

Response structure


resp.managed_login_version #=> Integer
resp.cloud_front_domain #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

The domain string. For custom domains, this is the fully-qualified domain name, such as ‘auth.example.com`. For prefix domains, this is the prefix alone, such as `myprefix`. A prefix value of `myprefix` for a user pool in the `us-east-1` Region results in a domain of `myprefix.auth.us-east-1.amazoncognito.com`.
:user_pool_id (required, String) —

The ID of the user pool where you want to add a domain.
:managed_login_version (Integer) —

The version of managed login branding that you want to apply to your domain. A value of ‘1` indicates hosted UI (classic) and a version of `2` indicates managed login.

Managed login requires that your user pool be configured for any

feature plan][1

other than ‘Lite`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html
:custom_domain_config (Types::CustomDomainConfigType) —

The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the ‘us-east-1` Region.

Provide this parameter only if you want to use a [custom domain] for your user pool. Otherwise, you can omit this parameter and use a

prefix domain][2

instead.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html

Returns:

(Types::CreateUserPoolDomainResponse) —
Returns a response object which responds to the following methods:
- #managed_login_version => Integer
- #cloud_front_domain => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6389

def create_user_pool_domain(params = {}, options = {})
  req = build_request(:create_user_pool_domain, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group that you want to delete.
:user_pool_id (required, String) —

The ID of the user pool where you want to delete the group.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6438

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to delete the identity provider.
:provider_name (required, String) —

The name of the IdP that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6487

def delete_identity_provider(params = {}, options = {})
  req = build_request(:delete_identity_provider, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_managed_login_branding({
  managed_login_branding_id: "ManagedLoginBrandingIdType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:managed_login_branding_id (required, String) —

The ID of the managed login branding style that you want to delete.
:user_pool_id (required, String) —

The ID of the user pool that contains the managed login branding style that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6536

def delete_managed_login_branding(params = {}, options = {})
  req = build_request(:delete_managed_login_branding, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to delete the resource server.
:identifier (required, String) —

The identifier of the resource server that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6587

def delete_resource_server(params = {}, options = {})
  req = build_request(:delete_resource_server, params)
  req.send_request(options)
end

#delete_terms(params = {}) ⇒ `Struct`

Deletes the terms documents with the requested ID from your app client.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_terms({
  terms_id: "TermsIdType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:terms_id (required, String) —

The ID of the terms documents that you want to delete.
:user_pool_id (required, String) —

The ID of the user pool that contains the terms documents that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6633

def delete_terms(params = {}, options = {})
  req = build_request(:delete_terms, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6674

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_user_attributes({
  user_attribute_names: ["AttributeNameType"], # required
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_attribute_names (required, Array<String>) —

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the ‘custom:` prefix to the attribute name, for example `custom:department`.
:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6724

def delete_user_attributes(params = {}, options = {})
  req = build_request(:delete_user_attributes, params)
  req.send_request(options)
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 ServicesSupport 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.

Examples:

Request syntax with placeholder values


resp = client.delete_user_pool({
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6759

def delete_user_pool(params = {}, options = {})
  req = build_request(:delete_user_pool, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to delete the client.
:client_id (required, String) —

The ID of the user pool app client that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6786

def delete_user_pool_client(params = {}, options = {})
  req = build_request(:delete_user_pool_client, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_user_pool_domain({
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

The domain that you want to delete. For custom domains, this is the fully-qualified domain name like ‘auth.example.com`. For Amazon Cognito prefix domains, this is the prefix alone, like `myprefix`.
:user_pool_id (required, String) —

The ID of the user pool where you want to delete the domain.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6816

def delete_user_pool_domain(params = {}, options = {})
  req = build_request(:delete_user_pool_domain, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.delete_web_authn_credential({
  access_token: "TokenModelType", # required
  credential_id: "StringType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:credential_id (required, String) —

The unique identifier of the passkey that you want to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6861

def delete_web_authn_credential(params = {}, options = {})
  req = build_request(:delete_web_authn_credential, params)
  req.send_request(options)
end

#describe_identity_provider(params = {}) ⇒ `Types::DescribeIdentityProviderResponse`

Given a user pool ID and identity provider (IdP) name, returns details about the IdP.

Examples:

Request syntax with placeholder values


resp = client.describe_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameType", # required
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that has the IdP that you want to describe..
:provider_name (required, String) —

The name of the IdP that you want to describe.

Returns:

(Types::DescribeIdentityProviderResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6904

def describe_identity_provider(params = {}, options = {})
  req = build_request(:describe_identity_provider, params)
  req.send_request(options)
end

#describe_managed_login_branding(params = {}) ⇒ `Types::DescribeManagedLoginBrandingResponse`

Given the ID of a managed login branding style, returns detailed information about the style.

Examples:

Request syntax with placeholder values


resp = client.describe_managed_login_branding({
  user_pool_id: "UserPoolIdType", # required
  managed_login_branding_id: "ManagedLoginBrandingIdType", # required
  return_merged_resources: false,
})

Response structure


resp.managed_login_branding.managed_login_branding_id #=> String
resp.managed_login_branding.user_pool_id #=> String
resp.managed_login_branding.use_cognito_provided_values #=> Boolean
resp.managed_login_branding.assets #=> Array
resp.managed_login_branding.assets[0].category #=> String, one of "FAVICON_ICO", "FAVICON_SVG", "EMAIL_GRAPHIC", "SMS_GRAPHIC", "AUTH_APP_GRAPHIC", "PASSWORD_GRAPHIC", "PASSKEY_GRAPHIC", "PAGE_HEADER_LOGO", "PAGE_HEADER_BACKGROUND", "PAGE_FOOTER_LOGO", "PAGE_FOOTER_BACKGROUND", "PAGE_BACKGROUND", "FORM_BACKGROUND", "FORM_LOGO", "IDP_BUTTON_ICON"
resp.managed_login_branding.assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp.managed_login_branding.assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp.managed_login_branding.assets[0].bytes #=> String
resp.managed_login_branding.assets[0].resource_id #=> String
resp.managed_login_branding.creation_date #=> Time
resp.managed_login_branding.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the managed login branding style that you want to get information about.
:managed_login_branding_id (required, String) —

The ID of the managed login branding style that you want to get more information about.
:return_merged_resources (Boolean) —

When ‘true`, returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style.

Returns:

(Types::DescribeManagedLoginBrandingResponse) —
Returns a response object which responds to the following methods:
- #managed_login_branding => Types::ManagedLoginBrandingType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6956

def describe_managed_login_branding(params = {}, options = {})
  req = build_request(:describe_managed_login_branding, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_managed_login_branding_by_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  return_merged_resources: false,
})

Response structure


resp.managed_login_branding.managed_login_branding_id #=> String
resp.managed_login_branding.user_pool_id #=> String
resp.managed_login_branding.use_cognito_provided_values #=> Boolean
resp.managed_login_branding.assets #=> Array
resp.managed_login_branding.assets[0].category #=> String, one of "FAVICON_ICO", "FAVICON_SVG", "EMAIL_GRAPHIC", "SMS_GRAPHIC", "AUTH_APP_GRAPHIC", "PASSWORD_GRAPHIC", "PASSKEY_GRAPHIC", "PAGE_HEADER_LOGO", "PAGE_HEADER_BACKGROUND", "PAGE_FOOTER_LOGO", "PAGE_FOOTER_BACKGROUND", "PAGE_BACKGROUND", "FORM_BACKGROUND", "FORM_LOGO", "IDP_BUTTON_ICON"
resp.managed_login_branding.assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp.managed_login_branding.assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp.managed_login_branding.assets[0].bytes #=> String
resp.managed_login_branding.assets[0].resource_id #=> String
resp.managed_login_branding.creation_date #=> Time
resp.managed_login_branding.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the app client where you want more information about the managed login branding style.
:client_id (required, String) —

The app client that’s assigned to the branding style that you want more information about.
:return_merged_resources (Boolean) —

When ‘true`, returns values for branding options that are unchanged from Amazon Cognito defaults. When `false` or when you omit this parameter, returns only values that you customized in your branding style.

Returns:

(Types::DescribeManagedLoginBrandingByClientResponse) —
Returns a response object which responds to the following methods:
- #managed_login_branding => Types::ManagedLoginBrandingType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7008

def describe_managed_login_branding_by_client(params = {}, options = {})
  req = build_request(:describe_managed_login_branding_by_client, params)
  req.send_request(options)
end

#describe_resource_server(params = {}) ⇒ `Types::DescribeResourceServerResponse`

Describes a resource server. For more information about resource servers, see [Access control with resource servers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html

Examples:

Request syntax with placeholder values


resp = client.describe_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
})

Response structure


resp.resource_server.user_pool_id #=> String
resp.resource_server.identifier #=> String
resp.resource_server.name #=> String
resp.resource_server.scopes #=> Array
resp.resource_server.scopes[0].scope_name #=> String
resp.resource_server.scopes[0].scope_description #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that hosts the resource server.
:identifier (required, String) —

A unique resource server identifier for the resource server. The identifier can be an API friendly name like ‘solar-system-data`. You can also set an API URL like `solar-system-data-api.example.com` as your identifier.

Amazon Cognito represents scopes in the access token in the format ‘$resource-server-identifier/$scope`. Longer scope-identifier strings increase the size of your access tokens.

Returns:

(Types::DescribeResourceServerResponse) —
Returns a response object which responds to the following methods:
- #resource_server => Types::ResourceServerType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7057

def describe_resource_server(params = {}, options = {})
  req = build_request(:describe_resource_server, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html

Examples:

Request syntax with placeholder values


resp = client.describe_risk_configuration({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
})

Response structure


resp.risk_configuration.user_pool_id #=> String
resp.risk_configuration.client_id #=> String
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter #=> Array
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter[0] #=> String, one of "SIGN_IN", "PASSWORD_CHANGE", "SIGN_UP"
resp.risk_configuration.compromised_credentials_risk_configuration.actions.event_action #=> String, one of "BLOCK", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.from #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.reply_to #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.source_arn #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list[0] #=> String
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list[0] #=> String
resp.risk_configuration.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool with the risk configuration that you want to inspect. You can apply default risk configuration at the user pool level and further customize it from user pool defaults at the app-client level. Specify ‘ClientId` to inspect client-level configuration, or `UserPoolId` to inspect pool-level configuration.
:client_id (String) —

The ID of the app client with the risk configuration that you want to inspect. You can apply default risk configuration at the user pool level and further customize it from user pool defaults at the app-client level. Specify ‘ClientId` to inspect client-level configuration, or `UserPoolId` to inspect pool-level configuration.

Returns:

(Types::DescribeRiskConfigurationResponse) —
Returns a response object which responds to the following methods:
- #risk_configuration => Types::RiskConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7132

def describe_risk_configuration(params = {}, options = {})
  req = build_request(:describe_risk_configuration, params)
  req.send_request(options)
end

#describe_terms(params = {}) ⇒ `Types::DescribeTermsResponse`

Returns details for the requested terms documents ID. For more information, see [Terms documents].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.describe_terms({
  terms_id: "TermsIdType", # required
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.terms.terms_id #=> String
resp.terms.user_pool_id #=> String
resp.terms.client_id #=> String
resp.terms.terms_name #=> String
resp.terms.terms_source #=> String, one of "LINK"
resp.terms.enforcement #=> String, one of "NONE"
resp.terms.links #=> Hash
resp.terms.links["LanguageIdType"] #=> String
resp.terms.creation_date #=> Time
resp.terms.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:terms_id (required, String) —

The ID of the terms documents that you want to describe.
:user_pool_id (required, String) —

The ID of the user pool that contains the terms documents that you want to describe.

Returns:

(Types::DescribeTermsResponse) —
Returns a response object which responds to the following methods:
- #terms => Types::TermsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7194

def describe_terms(params = {}, options = {})
  req = build_request(:describe_terms, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html

Examples:

Request syntax with placeholder values


resp = client.describe_user_import_job({
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that’s associated with the import job.
:job_id (required, String) —

The Id of the user import job that you want to describe.

Returns:

(Types::DescribeUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7243

def describe_user_import_job(params = {}, options = {})
  req = build_request(:describe_user_import_job, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.describe_user_pool({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.user_pool.id #=> String
resp.user_pool.name #=> String
resp.user_pool.policies.password_policy.minimum_length #=> Integer
resp.user_pool.policies.password_policy.require_uppercase #=> Boolean
resp.user_pool.policies.password_policy.require_lowercase #=> Boolean
resp.user_pool.policies.password_policy.require_numbers #=> Boolean
resp.user_pool.policies.password_policy.require_symbols #=> Boolean
resp.user_pool.policies.password_policy.password_history_size #=> Integer
resp.user_pool.policies.password_policy.temporary_password_validity_days #=> Integer
resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors #=> Array
resp.user_pool.policies.sign_in_policy.allowed_first_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN"
resp.user_pool.deletion_protection #=> String, one of "ACTIVE", "INACTIVE"
resp.user_pool.lambda_config.pre_sign_up #=> String
resp.user_pool.lambda_config.custom_message #=> String
resp.user_pool.lambda_config.post_confirmation #=> String
resp.user_pool.lambda_config.pre_authentication #=> String
resp.user_pool.lambda_config.post_authentication #=> String
resp.user_pool.lambda_config.define_auth_challenge #=> String
resp.user_pool.lambda_config.create_auth_challenge #=> String
resp.user_pool.lambda_config.verify_auth_challenge_response #=> String
resp.user_pool.lambda_config.pre_token_generation #=> String
resp.user_pool.lambda_config.user_migration #=> String
resp.user_pool.lambda_config.pre_token_generation_config.lambda_version #=> String, one of "V1_0", "V2_0", "V3_0"
resp.user_pool.lambda_config.pre_token_generation_config.lambda_arn #=> String
resp.user_pool.lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_sms_sender.lambda_arn #=> String
resp.user_pool.lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
resp.user_pool.lambda_config.custom_email_sender.lambda_arn #=> String
resp.user_pool.lambda_config.kms_key_id #=> String
resp.user_pool.status #=> String, one of "Enabled", "Disabled"
resp.user_pool.last_modified_date #=> Time
resp.user_pool.creation_date #=> Time
resp.user_pool.schema_attributes #=> Array
resp.user_pool.schema_attributes[0].name #=> String
resp.user_pool.schema_attributes[0].attribute_data_type #=> String, one of "String", "Number", "DateTime", "Boolean"
resp.user_pool.schema_attributes[0].developer_only_attribute #=> Boolean
resp.user_pool.schema_attributes[0].mutable #=> Boolean
resp.user_pool.schema_attributes[0].required #=> Boolean
resp.user_pool.schema_attributes[0].number_attribute_constraints.min_value #=> String
resp.user_pool.schema_attributes[0].number_attribute_constraints.max_value #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.min_length #=> String
resp.user_pool.schema_attributes[0].string_attribute_constraints.max_length #=> String
resp.user_pool.auto_verified_attributes #=> Array
resp.user_pool.auto_verified_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.alias_attributes #=> Array
resp.user_pool.alias_attributes[0] #=> String, one of "phone_number", "email", "preferred_username"
resp.user_pool.username_attributes #=> Array
resp.user_pool.username_attributes[0] #=> String, one of "phone_number", "email"
resp.user_pool.sms_verification_message #=> String
resp.user_pool.email_verification_message #=> String
resp.user_pool.email_verification_subject #=> String
resp.user_pool.verification_message_template.sms_message #=> String
resp.user_pool.verification_message_template.email_message #=> String
resp.user_pool.verification_message_template.email_subject #=> String
resp.user_pool.verification_message_template.email_message_by_link #=> String
resp.user_pool.verification_message_template.email_subject_by_link #=> String
resp.user_pool.verification_message_template.default_email_option #=> String, one of "CONFIRM_WITH_LINK", "CONFIRM_WITH_CODE"
resp.user_pool.sms_authentication_message #=> String
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update #=> Array
resp.user_pool.user_attribute_update_settings.attributes_require_verification_before_update[0] #=> String, one of "phone_number", "email"
resp.user_pool.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
resp.user_pool.device_configuration.challenge_required_on_new_device #=> Boolean
resp.user_pool.device_configuration.device_only_remembered_on_user_prompt #=> Boolean
resp.user_pool.estimated_number_of_users #=> Integer
resp.user_pool.email_configuration.source_arn #=> String
resp.user_pool.email_configuration.reply_to_email_address #=> String
resp.user_pool.email_configuration.email_sending_account #=> String, one of "COGNITO_DEFAULT", "DEVELOPER"
resp.user_pool.email_configuration.from #=> String
resp.user_pool.email_configuration.configuration_set #=> String
resp.user_pool.sms_configuration.sns_caller_arn #=> String
resp.user_pool.sms_configuration.external_id #=> String
resp.user_pool.sms_configuration.sns_region #=> String
resp.user_pool.user_pool_tags #=> Hash
resp.user_pool.user_pool_tags["TagKeysType"] #=> String
resp.user_pool.sms_configuration_failure #=> String
resp.user_pool.email_configuration_failure #=> String
resp.user_pool.domain #=> String
resp.user_pool.custom_domain #=> String
resp.user_pool.admin_create_user_config.allow_admin_create_user_only #=> Boolean
resp.user_pool.admin_create_user_config.unused_account_validity_days #=> Integer
resp.user_pool.admin_create_user_config.invite_message_template.sms_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_message #=> String
resp.user_pool.admin_create_user_config.invite_message_template.email_subject #=> String
resp.user_pool.user_pool_add_ons.advanced_security_mode #=> String, one of "OFF", "AUDIT", "ENFORCED"
resp.user_pool.user_pool_add_ons.advanced_security_additional_flows.custom_auth_mode #=> String, one of "AUDIT", "ENFORCED"
resp.user_pool.username_configuration.case_sensitive #=> Boolean
resp.user_pool.arn #=> String
resp.user_pool.account_recovery_setting.recovery_mechanisms #=> Array
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].priority #=> Integer
resp.user_pool.account_recovery_setting.recovery_mechanisms[0].name #=> String, one of "verified_email", "verified_phone_number", "admin_only"
resp.user_pool.user_pool_tier #=> String, one of "LITE", "ESSENTIALS", "PLUS"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool you want to describe.

Returns:

(Types::DescribeUserPoolResponse) —
Returns a response object which responds to the following methods:
- #user_pool => Types::UserPoolType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7381

def describe_user_pool(params = {}, options = {})
  req = build_request(:describe_user_pool, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.describe_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
})

Response structure


resp.user_pool_client.user_pool_id #=> String
resp.user_pool_client.client_name #=> String
resp.user_pool_client.client_id #=> String
resp.user_pool_client.client_secret #=> String
resp.user_pool_client.last_modified_date #=> Time
resp.user_pool_client.creation_date #=> Time
resp.user_pool_client.refresh_token_validity #=> Integer
resp.user_pool_client.access_token_validity #=> Integer
resp.user_pool_client.id_token_validity #=> Integer
resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.read_attributes #=> Array
resp.user_pool_client.read_attributes[0] #=> String
resp.user_pool_client.write_attributes #=> Array
resp.user_pool_client.write_attributes[0] #=> String
resp.user_pool_client.explicit_auth_flows #=> Array
resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH"
resp.user_pool_client.supported_identity_providers #=> Array
resp.user_pool_client.supported_identity_providers[0] #=> String
resp.user_pool_client.callback_urls #=> Array
resp.user_pool_client.callback_urls[0] #=> String
resp.user_pool_client.logout_urls #=> Array
resp.user_pool_client.logout_urls[0] #=> String
resp.user_pool_client.default_redirect_uri #=> String
resp.user_pool_client.allowed_o_auth_flows #=> Array
resp.user_pool_client.allowed_o_auth_flows[0] #=> String, one of "code", "implicit", "client_credentials"
resp.user_pool_client.allowed_o_auth_scopes #=> Array
resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
resp.user_pool_client.analytics_configuration.application_id #=> String
resp.user_pool_client.analytics_configuration.application_arn #=> String
resp.user_pool_client.analytics_configuration.role_arn #=> String
resp.user_pool_client.analytics_configuration.external_id #=> String
resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
resp.user_pool_client.enable_token_revocation #=> Boolean
resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
resp.user_pool_client.auth_session_validity #=> Integer
resp.user_pool_client.refresh_token_rotation.feature #=> String, one of "ENABLED", "DISABLED"
resp.user_pool_client.refresh_token_rotation.retry_grace_period_seconds #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the app client you want to describe.
:client_id (required, String) —

The ID of the app client that you want to describe.

Returns:

(Types::DescribeUserPoolClientResponse) —
Returns a response object which responds to the following methods:
- #user_pool_client => Types::UserPoolClientType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7476

def describe_user_pool_client(params = {}, options = {})
  req = build_request(:describe_user_pool_client, params)
  req.send_request(options)
end

#describe_user_pool_domain(params = {}) ⇒ `Types::DescribeUserPoolDomainResponse`

Given a user pool domain name, returns information about the domain configuration.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.describe_user_pool_domain({
  domain: "DomainType", # required
})

Response structure


resp.domain_description.user_pool_id #=> String
resp.domain_description.aws_account_id #=> String
resp.domain_description.domain #=> String
resp.domain_description.s3_bucket #=> String
resp.domain_description.cloud_front_distribution #=> String
resp.domain_description.version #=> String
resp.domain_description.status #=> String, one of "CREATING", "DELETING", "UPDATING", "ACTIVE", "FAILED"
resp.domain_description.custom_domain_config.certificate_arn #=> String
resp.domain_description.managed_login_version #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

The domain that you want to describe. For custom domains, this is the fully-qualified domain name, such as ‘auth.example.com`. For Amazon Cognito prefix domains, this is the prefix alone, such as `auth`.

Returns:

(Types::DescribeUserPoolDomainResponse) —
Returns a response object which responds to the following methods:
- #domain_description => Types::DomainDescriptionType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7533

def describe_user_pool_domain(params = {}, options = {})
  req = build_request(:describe_user_pool_domain, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.forget_device({
  access_token: "TokenModelType",
  device_key: "DeviceKeyType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:device_key (required, String) —

The unique identifier, or device key, of the device that the user wants to forget.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7581

def forget_device(params = {}, options = {})
  req = build_request(:forget_device, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.forgot_password({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  username: "UsernameType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the user pool app client associated with the current signed-in user.
:secret_hash (String) —

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: *pre sign-up*, *custom message*, and *user migration*. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::ForgotPasswordResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details => Types::CodeDeliveryDetailsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7744

def forgot_password(params = {}, options = {})
  req = build_request(:forgot_password, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_csv_header({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.user_pool_id #=> String
resp.csv_header #=> Array
resp.csv_header[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that you want to import users into.

Returns:

(Types::GetCSVHeaderResponse) —
Returns a response object which responds to the following methods:
- #user_pool_id => String
- #csv_header => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7800

def get_csv_header(params = {}, options = {})
  req = build_request(:get_csv_header, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_device({
  device_key: "DeviceKeyType", # required
  access_token: "TokenModelType",
})

Response structure


resp.device.device_key #=> String
resp.device.device_attributes #=> Array
resp.device.device_attributes[0].name #=> String
resp.device.device_attributes[0].value #=> String
resp.device.device_create_date #=> Time
resp.device.device_last_modified_date #=> Time
resp.device.device_last_authenticated_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:device_key (required, String) —

The key of the device that you want to get information about.
:access_token (String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Types::GetDeviceResponse) —
Returns a response object which responds to the following methods:
- #device => Types::DeviceType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7859

def get_device(params = {}, options = {})
  req = build_request(:get_device, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.group.group_name #=> String
resp.group.user_pool_id #=> String
resp.group.description #=> String
resp.group.role_arn #=> String
resp.group.precedence #=> Integer
resp.group.last_modified_date #=> Time
resp.group.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group that you want to get information about.
:user_pool_id (required, String) —

The ID of the user pool that contains the group that you want to query.

Returns:

(Types::GetGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::GroupType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7921

def get_group(params = {}, options = {})
  req = build_request(:get_group, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html

Examples:

Request syntax with placeholder values


resp = client.get_identity_provider_by_identifier({
  user_pool_id: "UserPoolIdType", # required
  idp_identifier: "IdpIdentifierType", # required
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to get information about the IdP.
:idp_identifier (required, String) —

The identifier that you assigned to your user pool. The identifier is an alternative name for an IdP that is distinct from the IdP name. For example, an IdP with a name of ‘MyIdP` might have an identifier of the email domain `example.com`.

Returns:

(Types::GetIdentityProviderByIdentifierResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 7974

def get_identity_provider_by_identifier(params = {}, options = {})
  req = build_request(:get_identity_provider_by_identifier, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_log_delivery_configuration({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.log_delivery_configuration.user_pool_id #=> String
resp.log_delivery_configuration.log_configurations #=> Array
resp.log_delivery_configuration.log_configurations[0].log_level #=> String, one of "ERROR", "INFO"
resp.log_delivery_configuration.log_configurations[0].event_source #=> String, one of "userNotification", "userAuthEvents"
resp.log_delivery_configuration.log_configurations[0].cloud_watch_logs_configuration.log_group_arn #=> String
resp.log_delivery_configuration.log_configurations[0].s3_configuration.bucket_arn #=> String
resp.log_delivery_configuration.log_configurations[0].firehose_configuration.stream_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that has the logging configuration that you want to view.

Returns:

(Types::GetLogDeliveryConfigurationResponse) —
Returns a response object which responds to the following methods:
- #log_delivery_configuration => Types::LogDeliveryConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8031

def get_log_delivery_configuration(params = {}, options = {})
  req = build_request(:get_log_delivery_configuration, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html#cognito-user-pools-SAML-signing [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_signing_certificate({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.certificate #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to view the signing certificate.

Returns:

(Types::GetSigningCertificateResponse) —
Returns a response object which responds to the following methods:
- #certificate => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8088

def get_signing_certificate(params = {}, options = {})
  req = build_request(:get_signing_certificate, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_tokens_from_refresh_token({
  refresh_token: "TokenModelType", # required
  client_id: "ClientIdType", # required
  client_secret: "ClientSecretType",
  device_key: "DeviceKeyType",
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:refresh_token (required, String) —

A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete and after an optional grace period.
:client_id (required, String) —

The app client that issued the refresh token to the user who wants to request new tokens.
:client_secret (String) —

The client secret of the requested app client, if the client has a secret.
:device_key (String) —

When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement ‘GetTokensFromRefreshToken` in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn’t provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.

For more information about device remembering, see [Working with devices].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ‘GetTokensFromRefreshToken` API action, Amazon Cognito invokes the Lambda function the pre token generation trigger.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::GetTokensFromRefreshTokenResponse) —
Returns a response object which responds to the following methods:
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8192

def get_tokens_from_refresh_token(params = {}, options = {})
  req = build_request(:get_tokens_from_refresh_token, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html

Examples:

Request syntax with placeholder values


resp = client.get_ui_customization({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
})

Response structure


resp.ui_customization.user_pool_id #=> String
resp.ui_customization.client_id #=> String
resp.ui_customization.image_url #=> String
resp.ui_customization.css #=> String
resp.ui_customization.css_version #=> String
resp.ui_customization.last_modified_date #=> Time
resp.ui_customization.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that you want to query for branding settings.
:client_id (String) —

The ID of the app client that you want to query for branding settings.

Returns:

(Types::GetUICustomizationResponse) —
Returns a response object which responds to the following methods:
- #ui_customization => Types::UICustomizationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8239

def get_ui_customization(params = {}, options = {})
  req = build_request(:get_ui_customization, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_user({
  access_token: "TokenModelType", # required
})

Response structure


resp.username #=> String
resp.user_attributes #=> Array
resp.user_attributes[0].name #=> String
resp.user_attributes[0].value #=> String
resp.mfa_options #=> Array
resp.mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.mfa_options[0].attribute_name #=> String
resp.preferred_mfa_setting #=> String
resp.user_mfa_setting_list #=> Array
resp.user_mfa_setting_list[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Types::GetUserResponse) —
Returns a response object which responds to the following methods:
- #username => String
- #user_attributes => Array<Types::AttributeType>
- #mfa_options => Array<Types::MFAOptionType>
- #preferred_mfa_setting => String
- #user_mfa_setting_list => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8299

def get_user(params = {}, options = {})
  req = build_request(:get_user, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.get_user_attribute_verification_code({
  access_token: "TokenModelType", # required
  attribute_name: "AttributeNameType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:attribute_name (required, String) —

The name of the attribute that the user wants to verify, for example ‘email`.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the *custom message* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::GetUserAttributeVerificationCodeResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details => Types::CodeDeliveryDetailsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8416

def get_user_attribute_verification_code(params = {}, options = {})
  req = build_request(:get_user_attribute_verification_code, params)
  req.send_request(options)
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_AUTH` flow.

Authorize this action with a signed-in user’s access token. It must include the scope ‘aws.cognito.signin.user.admin`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_user_auth_factors({
  access_token: "TokenModelType", # required
})

Response structure


resp.username #=> String
resp.preferred_mfa_setting #=> String
resp.user_mfa_setting_list #=> Array
resp.user_mfa_setting_list[0] #=> String
resp.configured_user_auth_factors #=> Array
resp.configured_user_auth_factors[0] #=> String, one of "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Types::GetUserAuthFactorsResponse) —
Returns a response object which responds to the following methods:
- #username => String
- #preferred_mfa_setting => String
- #user_mfa_setting_list => Array<String>
- #configured_user_auth_factors => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8476

def get_user_auth_factors(params = {}, options = {})
  req = build_request(:get_user_auth_factors, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.get_user_pool_mfa_config({
  user_pool_id: "UserPoolIdType", # required
})

Response structure


resp.sms_mfa_configuration.sms_authentication_message #=> String
resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
resp.sms_mfa_configuration.sms_configuration.external_id #=> String
resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
resp.software_token_mfa_configuration.enabled #=> Boolean
resp.email_mfa_configuration.message #=> String
resp.email_mfa_configuration.subject #=> String
resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
resp.web_authn_configuration.relying_party_id #=> String
resp.web_authn_configuration.user_verification #=> String, one of "required", "preferred"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to query WebAuthn and MFA configuration.

Returns:

(Types::GetUserPoolMfaConfigResponse) —
Returns a response object which responds to the following methods:
- #sms_mfa_configuration => Types::SmsMfaConfigType
- #software_token_mfa_configuration => Types::SoftwareTokenMfaConfigType
- #email_mfa_configuration => Types::EmailMfaConfigType
- #mfa_configuration => String
- #web_authn_configuration => Types::WebAuthnConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8548

def get_user_pool_mfa_config(params = {}, options = {})
  req = build_request(:get_user_pool_mfa_config, params)
  req.send_request(options)
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 revoked` error when your app attempts to authorize a user pools API request with a revoked access token that contains the scope `aws.cognito.signin.user.admin`.
Amazon Cognito no longer accepts a signed-out user’s ID token in a

GetId ][2

request to an identity pool with ‘ServerSideTokenCheck`

enabled 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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetId.html [3]: docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_CognitoIdentityProvider.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html

Examples:

Request syntax with placeholder values


resp = client.global_sign_out({
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8618

def global_sign_out(params = {}, options = {})
  req = build_request(:global_sign_out, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [3]: console.aws.amazon.com/pinpoint/home/ [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Example: Example username and password sign-in for a user who has TOTP MFA


# The following example signs in the user mytestuser with analytics data, client metadata, and user context data for
# advanced security.

resp = client.initiate_auth({
  analytics_metadata: {
    analytics_endpoint_id: "d70b2ba36a8c4dc5a04a0451a31a1e12", 
  }, 
  auth_flow: "USER_PASSWORD_AUTH", 
  auth_parameters: {
    "PASSWORD" => "This-is-my-test-99!", 
    "SECRET_HASH" => "oT5ZkS8ctnrhYeeGsGTvOzPhoc/Jd1cO5fueBWFVmp8=", 
    "USERNAME" => "mytestuser", 
  }, 
  client_id: "1example23456789", 
  client_metadata: {
    "MyTestKey" => "MyTestValue", 
  }, 
  user_context_data: {
    encoded_data: "AmazonCognitoAdvancedSecurityData_object", 
    ip_address: "192.0.2.1", 
  }, 
})

resp.to_h outputs the following:
{
  challenge_name: "SOFTWARE_TOKEN_MFA", 
  challenge_parameters: {
    "FRIENDLY_DEVICE_NAME" => "mytestauthenticator", 
    "USER_ID_FOR_SRP" => "mytestuser", 
  }, 
  session: "AYABeC1-y8qooiuysEv0uM4wAqQAHQABAAdTZXJ2aWNlABBDb2duaXRvVXNlclBvb2xzAAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMjowMTU3MzY3MjcxOTg6a2V5LzI5OTFhNGE5LTM5YTAtNDQ0Mi04MWU4LWRkYjY4NTllMTg2MQC4AQIBAHhjxv5lVLhE2_WNrC1zuomqn08qDUUp3z9v4EGAjazZ-wGP3HuBF5Izvxf-9WkCT5uyAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMeQoT5e6Dpfh52caqAgEQgDvuL8uLMhPt0WmQpZnkNED1gob6xbqt5LaQo_H4L5CuT4Kj499dGCoZ1q1trmlZSRgRm0wwGGG8lFU37QIAAAAADAAAEAAAAAAAAAAAAAAAAADuLe9_UJ4oZAMsQYr0ntiT_____wAAAAEAAAAAAAAAAAAAAAEAAADnLDGmKBQtsCafNokRmPLgl2itBKuKR2dfZBQb5ucCYkzThM5HOfQUSEL-A3dZzfYDC0IODsrcMkrbeeVyMJk-FCzsxS9Og8BEBVnvi9WjZkPJ4mF0YS6FUXnoPSBV5oUqGzRaT-tJ169SUFZAUfFM1fGeJ8T57-QdCxjyISRCWV1VG5_7TiCioyRGfWwzNVWh7exJortF3ccfOyiEyxeqJ2VJvJq3m_w8NP24_PMDpktpRMKftObIMlD5ewRTNCdrUXQ1BW5KIxhJLGjYfRzJDZuKzmEgS-VHsKz0z76w-AlAgdfvdAjflLnsgduU5kUX4YP6jqnetg", 
}

Request syntax with placeholder values


resp = client.initiate_auth({
  auth_flow: "USER_SRP_AUTH", # required, accepts USER_SRP_AUTH, REFRESH_TOKEN_AUTH, REFRESH_TOKEN, CUSTOM_AUTH, ADMIN_NO_SRP_AUTH, USER_PASSWORD_AUTH, ADMIN_USER_PASSWORD_AUTH, USER_AUTH
  auth_parameters: {
    "StringType" => "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
  client_id: "ClientIdType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  session: "SessionType",
})

Response structure


resp.challenge_name #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String
resp.available_challenges #=> Array
resp.available_challenges[0] #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:auth_flow (required, String) —
The authentication flow that you want to initiate. Each ‘AuthFlow` has linked `AuthParameters` that you must submit. The following are some example flows.

USER_AUTH

: The entry point for [choice-based authentication] with passwords,
```
one-time passwords, and WebAuthn authenticators. Request a preferred
authentication type or review available authentication types. From
the offered authentication types, select one in a challenge response
and then authenticate with that method in an additional challenge
response. To activate this setting, your user pool must be in the [
Essentials tier][2] or higher.
```
USER_SRP_AUTH

: Username-password authentication with the Secure Remote Password
```
(SRP) protocol. For more information, see [Use SRP password
verification in custom authentication flow][3].
```
REFRESH_TOKEN_AUTH and REFRESH_TOKEN

: Receive new ID and access tokens when you pass a ‘REFRESH_TOKEN`
```
parameter with a valid refresh token as the value. For more
information, see [Using the refresh token][4].
```
CUSTOM_AUTH

: Custom authentication with Lambda triggers. For more information,
```
see [Custom authentication challenge Lambda triggers][5].
```
USER_PASSWORD_AUTH

: Client-side username-password authentication with the password sent
```
directly in the request. For more information about client-side and
server-side authentication, see [SDK authorization models][6].
```
‘ADMIN_USER_PASSWORD_AUTH` is a flow type of `AdminInitiateAuth` and isn’t valid for InitiateAuth. ‘ADMIN_NO_SRP_AUTH` is a legacy server-side username-password flow and isn’t valid for InitiateAuth.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Using-SRP-password-verification-in-custom-authentication-flow [4]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html [5]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html [6]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html
:auth_parameters (Hash<String,String>) —
The authentication parameters. These are inputs corresponding to the ‘AuthFlow` that you’re invoking.

The following are some authentication flows and their parameters. Add a ‘SECRET_HASH` parameter if your app client has a client secret. Add `DEVICE_KEY` if you want to bypass multi-factor authentication with a remembered device.

USER_AUTH : * ‘USERNAME` (required)
```
* `PREFERRED_CHALLENGE`. If you don't provide a value for
  `PREFERRED_CHALLENGE`, Amazon Cognito responds with the
  `AvailableChallenges` parameter that specifies the available
  sign-in methods.
```
USER_SRP_AUTH : * ‘USERNAME` (required)
```
* `SRP_A` (required)
```
USER_PASSWORD_AUTH : * ‘USERNAME` (required)
```
* `PASSWORD` (required)
```
REFRESH_TOKEN_AUTH/REFRESH_TOKEN : * ‘REFRESH_TOKEN`(required)
```
^
```
CUSTOM_AUTH : * ‘USERNAME` (required)
```
* `ChallengeName: SRP_A` (when doing SRP authentication before
  custom challenges)

* `SRP_A: (An SRP_A value)` (when doing SRP authentication before
  custom challenges)
```
For more information about ‘SECRET_HASH`, see [Computing secret hash values]. For information about `DEVICE_KEY`, see [Working with user devices in your user pool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash [2]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you send an ‘InitiateAuth` request, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The `ClientMetadata` value is passed as input to the functions for only the following triggers.
- Pre sign-up
- Pre authentication
- User migration
When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload as input to the function. This payload contains a ‘validationData` attribute with the data that you assigned to the `ClientMetadata` parameter in your `InitiateAuth` request. In your function, `validationData` can contribute to operations that require data that isn’t in the default payload.

‘InitiateAuth` requests invokes the following triggers without `ClientMetadata` as input.
- Post authentication
- Custom message
- Pre token generation
- Create auth challenge
- Define auth challenge
- Custom email sender
- Custom SMS sender
For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
:client_id (required, String) —

The ID of the app client that your user wants to sign in to.
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:session (String) —

The optional session ID from a ‘ConfirmSignUp` API request. You can sign in a user directly from the sign-up process with the `USER_AUTH` authentication flow. When you pass the session ID to `InitiateAuth`, Amazon Cognito assumes the SMS or email message one-time verification password from `ConfirmSignUp` as the primary authentication factor. You’re not required to submit this code a second time. This option is only valid for users who have confirmed their sign-up and are signing in for the first time within the authentication flow session duration of the session ID.

Returns:

(Types::InitiateAuthResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType
- #available_challenges => Array<String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 8948

def initiate_auth(params = {}, options = {})
  req = build_request(:initiate_auth, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.list_devices({
  access_token: "TokenModelType", # required
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
})

Response structure


resp.devices #=> Array
resp.devices[0].device_key #=> String
resp.devices[0].device_attributes #=> Array
resp.devices[0].device_attributes[0].name #=> String
resp.devices[0].device_attributes[0].value #=> String
resp.devices[0].device_create_date #=> Time
resp.devices[0].device_last_modified_date #=> Time
resp.devices[0].device_last_authenticated_date #=> Time
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:limit (Integer) —

The maximum number of devices that you want Amazon Cognito to return in the response.
:pagination_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListDevicesResponse) —
Returns a response object which responds to the following methods:
- #devices => Array<Types::DeviceType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9020

def list_devices(params = {}, options = {})
  req = build_request(:list_devices, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ `Types::ListGroupsResponse`

Given a user pool ID, returns user pool groups and their details.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  user_pool_id: "UserPoolIdType", # required
  limit: 1,
  next_token: "PaginationKey",
})

Response structure


resp.groups #=> Array
resp.groups[0].group_name #=> String
resp.groups[0].user_pool_id #=> String
resp.groups[0].description #=> String
resp.groups[0].role_arn #=> String
resp.groups[0].precedence #=> Integer
resp.groups[0].last_modified_date #=> Time
resp.groups[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to list user groups.
:limit (Integer) —

The maximum number of groups that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListGroupsResponse) —
Returns a response object which responds to the following methods:
- #groups => Array<Types::GroupType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9091

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_identity_providers({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKeyType",
})

Response structure


resp.providers #=> Array
resp.providers[0].provider_name #=> String
resp.providers[0].provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.providers[0].last_modified_date #=> Time
resp.providers[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to list IdPs.
:max_results (Integer) —

The maximum number of IdPs that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListIdentityProvidersResponse) —
Returns a response object which responds to the following methods:
- #providers => Array<Types::ProviderDescription>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9162

def list_identity_providers(params = {}, options = {})
  req = build_request(:list_identity_providers, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_servers({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKeyType",
})

Response structure


resp.resource_servers #=> Array
resp.resource_servers[0].user_pool_id #=> String
resp.resource_servers[0].identifier #=> String
resp.resource_servers[0].name #=> String
resp.resource_servers[0].scopes #=> Array
resp.resource_servers[0].scopes[0].scope_name #=> String
resp.resource_servers[0].scopes[0].scope_description #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to list resource servers.
:max_results (Integer) —

The maximum number of resource servers that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListResourceServersResponse) —
Returns a response object which responds to the following methods:
- #resource_servers => Array<Types::ResourceServerType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9235

def list_resource_servers(params = {}, options = {})
  req = build_request(:list_resource_servers, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/tagging.html

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ArnType", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKeysType"] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

Returns:

(Types::ListTagsForResourceResponse) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9270

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_terms(params = {}) ⇒ `Types::ListTermsResponse`

Returns details about all terms documents for the requested user pool.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.list_terms({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "StringType",
})

Response structure


resp.terms #=> Array
resp.terms[0].terms_id #=> String
resp.terms[0].terms_name #=> String
resp.terms[0].enforcement #=> String, one of "NONE"
resp.terms[0].creation_date #=> Time
resp.terms[0].last_modified_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to list terms documents.
:max_results (Integer) —

The maximum number of terms documents that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListTermsResponse) —
Returns a response object which responds to the following methods:
- #terms => Array<Types::TermsDescriptionType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9337

def list_terms(params = {}, options = {})
  req = build_request(:list_terms, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.list_user_import_jobs({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1, # required
  pagination_token: "PaginationKeyType",
})

Response structure


resp.user_import_jobs #=> Array
resp.user_import_jobs[0].job_name #=> String
resp.user_import_jobs[0].job_id #=> String
resp.user_import_jobs[0].user_pool_id #=> String
resp.user_import_jobs[0].pre_signed_url #=> String
resp.user_import_jobs[0].creation_date #=> Time
resp.user_import_jobs[0].start_date #=> Time
resp.user_import_jobs[0].completion_date #=> Time
resp.user_import_jobs[0].status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_jobs[0].cloud_watch_logs_role_arn #=> String
resp.user_import_jobs[0].imported_users #=> Integer
resp.user_import_jobs[0].skipped_users #=> Integer
resp.user_import_jobs[0].failed_users #=> Integer
resp.user_import_jobs[0].completion_message #=> String
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to list import jobs.
:max_results (required, Integer) —

The maximum number of import jobs that you want Amazon Cognito to return in the response.
:pagination_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListUserImportJobsResponse) —
Returns a response object which responds to the following methods:
- #user_import_jobs => Array<Types::UserImportJobType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9416

def list_user_import_jobs(params = {}, options = {})
  req = build_request(:list_user_import_jobs, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_user_pool_clients({
  user_pool_id: "UserPoolIdType", # required
  max_results: 1,
  next_token: "PaginationKey",
})

Response structure


resp.user_pool_clients #=> Array
resp.user_pool_clients[0].client_id #=> String
resp.user_pool_clients[0].user_pool_id #=> String
resp.user_pool_clients[0].client_name #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to list user pool clients.
:max_results (Integer) —

The maximum number of app clients that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListUserPoolClientsResponse) —
Returns a response object which responds to the following methods:
- #user_pool_clients => Array<Types::UserPoolClientDescription>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9486

def list_user_pool_clients(params = {}, options = {})
  req = build_request(:list_user_pool_clients, params)
  req.send_request(options)
end

#list_user_pools(params = {}) ⇒ `Types::ListUserPoolsResponse`

Lists user pools and their details in the current Amazon Web Services account.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_user_pools({
  next_token: "PaginationKeyType",
  max_results: 1, # required
})

Response structure


resp.user_pools #=> Array
resp.user_pools[0].id #=> String
resp.user_pools[0].name #=> String
resp.user_pools[0].lambda_config.pre_sign_up #=> String
resp.user_pools[0].lambda_config.custom_message #=> String
resp.user_pools[0].lambda_config.post_confirmation #=> String
resp.user_pools[0].lambda_config.pre_authentication #=> String
resp.user_pools[0].lambda_config.post_authentication #=> String
resp.user_pools[0].lambda_config.define_auth_challenge #=> String
resp.user_pools[0].lambda_config.create_auth_challenge #=> String
resp.user_pools[0].lambda_config.verify_auth_challenge_response #=> String
resp.user_pools[0].lambda_config.pre_token_generation #=> String
resp.user_pools[0].lambda_config.user_migration #=> String
resp.user_pools[0].lambda_config.pre_token_generation_config.lambda_version #=> String, one of "V1_0", "V2_0", "V3_0"
resp.user_pools[0].lambda_config.pre_token_generation_config.lambda_arn #=> String
resp.user_pools[0].lambda_config.custom_sms_sender.lambda_version #=> String, one of "V1_0"
resp.user_pools[0].lambda_config.custom_sms_sender.lambda_arn #=> String
resp.user_pools[0].lambda_config.custom_email_sender.lambda_version #=> String, one of "V1_0"
resp.user_pools[0].lambda_config.custom_email_sender.lambda_arn #=> String
resp.user_pools[0].lambda_config.kms_key_id #=> String
resp.user_pools[0].status #=> String, one of "Enabled", "Disabled"
resp.user_pools[0].last_modified_date #=> Time
resp.user_pools[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
:max_results (required, Integer) —

The maximum number of user pools that you want Amazon Cognito to return in the response.

Returns:

(Types::ListUserPoolsResponse) —
Returns a response object which responds to the following methods:
- #user_pools => Array<Types::UserPoolDescriptionType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9569

def list_user_pools(params = {}, options = {})
  req = build_request(:list_user_pools, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ `Types::ListUsersResponse`

Given a user pool ID, returns a list of users and their basic details in a user pool.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: A ListUsers request for the next 3 users whose email address starts with “testuser.”


# This request submits a value for all possible parameters for ListUsers. By iterating the PaginationToken, you can page
# through and collect all users in a user pool.

resp = client.list_users({
  attributes_to_get: [
    "email", 
    "sub", 
  ], 
  filter: "\"email\"^=\"testuser\"", 
  limit: 3, 
  pagination_token: "abcd1234EXAMPLE", 
  user_pool_id: "us-east-1_EXAMPLE", 
})

resp.to_h outputs the following:
{
  pagination_token: "efgh5678EXAMPLE", 
  users: [
    {
      attributes: [
        {
          name: "sub", 
          value: "eaad0219-2117-439f-8d46-4db20e59268f", 
        }, 
        {
          name: "email", 
          value: "[email protected]", 
        }, 
      ], 
      enabled: true, 
      user_create_date: Time.parse(1682955829.578), 
      user_last_modified_date: Time.parse(1689030181.63), 
      user_status: "CONFIRMED", 
      username: "testuser", 
    }, 
    {
      attributes: [
        {
          name: "sub", 
          value: "3b994cfd-0b07-4581-be46-3c82f9a70c90", 
        }, 
        {
          name: "email", 
          value: "[email protected]", 
        }, 
      ], 
      enabled: true, 
      user_create_date: Time.parse(1684427979.201), 
      user_last_modified_date: Time.parse(1684427979.201), 
      user_status: "UNCONFIRMED", 
      username: "testuser2", 
    }, 
    {
      attributes: [
        {
          name: "sub", 
          value: "5929e0d1-4c34-42d1-9b79-a5ecacfe66f7", 
        }, 
        {
          name: "email", 
          value: "[email protected]", 
        }, 
      ], 
      enabled: true, 
      user_create_date: Time.parse(1684427823.641), 
      user_last_modified_date: Time.parse(1684427823.641), 
      user_status: "UNCONFIRMED", 
      username: "[email protected]", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_users({
  user_pool_id: "UserPoolIdType", # required
  attributes_to_get: ["AttributeNameType"],
  limit: 1,
  pagination_token: "SearchPaginationTokenType",
  filter: "UserFilterType",
})

Response structure


resp.users #=> Array
resp.users[0].username #=> String
resp.users[0].attributes #=> Array
resp.users[0].attributes[0].name #=> String
resp.users[0].attributes[0].value #=> String
resp.users[0].user_create_date #=> Time
resp.users[0].user_last_modified_date #=> Time
resp.users[0].enabled #=> Boolean
resp.users[0].user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD", "EXTERNAL_PROVIDER"
resp.users[0].mfa_options #=> Array
resp.users[0].mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.users[0].mfa_options[0].attribute_name #=> String
resp.pagination_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to display or search for users.
:attributes_to_get (Array<String>) —

A JSON array of user attribute names, for example ‘given_name`, that you want Amazon Cognito to include in the response for each user. When you don’t provide an ‘AttributesToGet` parameter, Amazon Cognito returns all attributes for each user.

Use ‘AttributesToGet` with required attributes in your user pool, or in conjunction with `Filter`. Amazon Cognito returns an error if not all users in the results have set a value for the attribute you request. Attributes that you can’t filter on, including custom attributes, must have a value set in every user profile before an ‘AttributesToGet` parameter returns results.
:limit (Integer) —

The maximum number of users that you want Amazon Cognito to return in the response.
:pagination_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
:filter (String) —
A filter string of the form ‘“AttributeName Filter-Type ”AttributeValue“`. Quotation marks within the filter string must be escaped using the backslash (“) character. For example, `”family_name = “Reddy”“`.
- AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
- Filter-Type: For an exact match, use ‘=`, for example, “`given_name = ”Jon“`”. For a prefix (“starts with”) match, use `^=`, for example, “`given_name ^= ”Jon“`”.
- AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ‘ListUsers` returns all users in the user pool.

You can only search for the following standard attributes:
- ‘username` (case-sensitive)
- ‘email`
- ‘phone_number`
- ‘name`
- ‘given_name`
- ‘family_name`
- ‘preferred_username`
- ‘cognito:user_status` (called Status in the Console) (case-insensitive)
- ‘status (called Enabled in the Console) (case-sensitive)`
- ‘sub`
Custom attributes aren’t searchable.

<note markdown=“1”> You can also list users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the ‘–query` parameter of the `list-users` action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results. Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.
```
For more information about server-side and client-side filtering, see
```
FilteringCLI output][1

in the [Command Line Interface User

Guide].
```
</note>
```
For more information, see [Searching for Users Using the ListUsers API] and [Examples of Using the ListUsers API] in the *Amazon Cognito Developer Guide*.

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api [3]: docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples

Returns:

(Types::ListUsersResponse) —
Returns a response object which responds to the following methods:
- #users => Array<Types::UserType>
- #pagination_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9804

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users_in_group({
  user_pool_id: "UserPoolIdType", # required
  group_name: "GroupNameType", # required
  limit: 1,
  next_token: "PaginationKey",
})

Response structure


resp.users #=> Array
resp.users[0].username #=> String
resp.users[0].attributes #=> Array
resp.users[0].attributes[0].name #=> String
resp.users[0].attributes[0].value #=> String
resp.users[0].user_create_date #=> Time
resp.users[0].user_last_modified_date #=> Time
resp.users[0].enabled #=> Boolean
resp.users[0].user_status #=> String, one of "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD", "EXTERNAL_PROVIDER"
resp.users[0].mfa_options #=> Array
resp.users[0].mfa_options[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.users[0].mfa_options[0].attribute_name #=> String
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to view the membership of the requested group.
:group_name (required, String) —

The name of the group that you want to query for user membership.
:limit (Integer) —

The maximum number of groups that you want Amazon Cognito to return in the response.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

(Types::ListUsersInGroupResponse) —
Returns a response object which responds to the following methods:
- #users => Array<Types::UserType>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9887

def list_users_in_group(params = {}, options = {})
  req = build_request(:list_users_in_group, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.list_web_authn_credentials({
  access_token: "TokenModelType", # required
  next_token: "PaginationKey",
  max_results: 1,
})

Response structure


resp.credentials #=> Array
resp.credentials[0].credential_id #=> String
resp.credentials[0].friendly_credential_name #=> String
resp.credentials[0].relying_party_id #=> String
resp.credentials[0].authenticator_attachment #=> String
resp.credentials[0].authenticator_transports #=> Array
resp.credentials[0].authenticator_transports[0] #=> String
resp.credentials[0].created_at #=> Time
resp.next_token #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:next_token (String) —

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
:max_results (Integer) —

The maximum number of the user’s passkey credentials that you want to return.

Returns:

(Types::ListWebAuthnCredentialsResponse) —
Returns a response object which responds to the following methods:
- #credentials => Array<Types::WebAuthnCredentialDescription>
- #next_token => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 9957

def list_web_authn_credentials(params = {}, options = {})
  req = build_request(:list_web_authn_credentials, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.resend_confirmation_code({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  username: "UsernameType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the user pool app client where the user signed up.
:secret_hash (String) —

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the *custom message* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::ResendConfirmationCodeResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details => Types::CodeDeliveryDetailsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10112

def resend_confirmation_code(params = {}, options = {})
  req = build_request(:resend_confirmation_code, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [3]: console.aws.amazon.com/pinpoint/home/ [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.respond_to_auth_challenge({
  client_id: "ClientIdType", # required
  challenge_name: "SMS_MFA", # required, accepts SMS_MFA, EMAIL_OTP, SOFTWARE_TOKEN_MFA, SELECT_MFA_TYPE, MFA_SETUP, PASSWORD_VERIFIER, CUSTOM_CHALLENGE, SELECT_CHALLENGE, DEVICE_SRP_AUTH, DEVICE_PASSWORD_VERIFIER, ADMIN_NO_SRP_AUTH, NEW_PASSWORD_REQUIRED, SMS_OTP, PASSWORD, WEB_AUTHN, PASSWORD_SRP
  session: "SessionType",
  challenge_responses: {
    "StringType" => "StringType",
  },
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.challenge_name #=> String, one of "SMS_MFA", "EMAIL_OTP", "SOFTWARE_TOKEN_MFA", "SELECT_MFA_TYPE", "MFA_SETUP", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "SELECT_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED", "SMS_OTP", "PASSWORD", "WEB_AUTHN", "PASSWORD_SRP"
resp.session #=> String
resp.challenge_parameters #=> Hash
resp.challenge_parameters["StringType"] #=> String
resp.authentication_result.access_token #=> String
resp.authentication_result.expires_in #=> Integer
resp.authentication_result.token_type #=> String
resp.authentication_result.refresh_token #=> String
resp.authentication_result.id_token #=> String
resp.authentication_result.new_device_metadata.device_key #=> String
resp.authentication_result.new_device_metadata.device_group_key #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the app client where the user is signing in.
:challenge_name (required, String) —
The name of the challenge that you are responding to.

<note markdown=“1”> You can’t respond to an ‘ADMIN_NO_SRP_AUTH` challenge with this operation.
```
</note>
```
Possible challenges include the following:

<note markdown=“1”> All of the following challenges require ‘USERNAME` and, when the app client has a client secret, `SECRET_HASH` in the parameters. Include a `DEVICE_KEY` for device authentication.
```
</note>
```
- ‘WEB_AUTHN`: Respond to the challenge with the results of a successful authentication with a WebAuthn authenticator, or passkey, as `CREDENTIAL`. Examples of WebAuthn authenticators include biometric devices and security keys.
- ‘PASSWORD`: Respond with the user’s password as ‘PASSWORD`.
- ‘PASSWORD_SRP`: Respond with the initial SRP secret as `SRP_A`.
- ‘SELECT_CHALLENGE`: Respond with a challenge selection as `ANSWER`. It must be one of the challenge types in the `AvailableChallenges` response parameter. Add the parameters of the selected challenge, for example `USERNAME` and `SMS_OTP`.
- ‘SMS_MFA`: Respond with the code that your user pool delivered in an SMS message, as `SMS_MFA_CODE`
- ‘EMAIL_MFA`: Respond with the code that your user pool delivered in an email message, as `EMAIL_MFA_CODE`
- ‘EMAIL_OTP`: Respond with the code that your user pool delivered in an email message, as `EMAIL_OTP_CODE` .
- ‘SMS_OTP`: Respond with the code that your user pool delivered in an SMS message, as `SMS_OTP_CODE`.
- ‘PASSWORD_VERIFIER`: Respond with the second stage of SRP secrets as `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP`.
- ‘CUSTOM_CHALLENGE`: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. The parameters of the challenge are determined by your Lambda function and issued in the `ChallengeParameters` of a challenge response.
- ‘DEVICE_SRP_AUTH`: Respond with the initial parameters of device SRP authentication. For more information, see [Signing in with a device].
- ‘DEVICE_PASSWORD_VERIFIER`: Respond with `PASSWORD_CLAIM_SIGNATURE`, `PASSWORD_CLAIM_SECRET_BLOCK`, and `TIMESTAMP` after client-side SRP calculations. For more information, see [Signing in with a device].
- ‘NEW_PASSWORD_REQUIRED`: For users who are required to change their passwords after successful first login. Respond to this challenge with `NEW_PASSWORD` and any required attributes that Amazon Cognito returned in the `requiredAttributes` parameter. You can also set values for attributes that aren’t required by your user pool and that your app client can write.
  
  Amazon Cognito only returns this challenge for users who have temporary passwords. When you create passwordless users, you must provide values for all required attributes.
  
  <note markdown=“1”> In a ‘NEW_PASSWORD_REQUIRED` challenge response, you can’t modify a required attribute that already has a value. In ‘AdminRespondToAuthChallenge` or `RespondToAuthChallenge`, set a value for any keys that Amazon Cognito returned in the `requiredAttributes` parameter, then use the `AdminUpdateUserAttributes` or `UpdateUserAttributes` API operation to modify the value of any additional attributes.
```
</note>
```
- ‘MFA_SETUP`: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user pool will be listed in the challenge parameters `MFAS_CAN_SETUP` value.
  
  To set up time-based one-time password (TOTP) MFA, use the session returned in this challenge from ‘InitiateAuth` or `AdminInitiateAuth` as an input to `AssociateSoftwareToken`. Then, use the session returned by `VerifySoftwareToken` as an input to `RespondToAuthChallenge` or `AdminRespondToAuthChallenge` with challenge name `MFA_SETUP` to complete sign-in.
  
  To set up SMS or email MFA, collect a ‘phone_number` or `email` attribute for the user. Then restart the authentication flow with an `InitiateAuth` or `AdminInitiateAuth` request.
[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device
:session (String) —

The session identifier that maintains the state of authentication requests and challenge responses. If an ‘AdminInitiateAuth` or `AdminRespondToAuthChallenge` API request results in a determination that your application must pass another challenge, Amazon Cognito returns a session with other challenge parameters. Send this session identifier, unmodified, to the next `AdminRespondToAuthChallenge` request.

:challenge_responses (Hash<String,String>) —

The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret. Include a ‘DEVICE_KEY` for device authentication.

SELECT_CHALLENGE

: ‘“ChallengeName”: “SELECT_CHALLENGE”, “ChallengeResponses”:

"USERNAME": "[username]", "ANSWER": "[Challenge name]"`

Available challenges are `PASSWORD`, `PASSWORD_SRP`, `EMAIL_OTP`,
`SMS_OTP`, and `WEB_AUTHN`.

Complete authentication in the `SELECT_CHALLENGE` response for
`PASSWORD`, `PASSWORD_SRP`, and `WEB_AUTHN`:

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "WEB_AUTHN", "USERNAME": "[username]", "CREDENTIAL":
  "[AuthenticationResponseJSON]"}`

  See [ AuthenticationResponseJSON][1].

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "PASSWORD", "USERNAME": "[username]", "PASSWORD":
  "[password]"}`

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "PASSWORD_SRP", "USERNAME": "[username]", "SRP_A":
  "[SRP_A]"}`

For `SMS_OTP` and `EMAIL_OTP`, respond with the username and answer.
Your user pool will send a code for the user to submit in the next
challenge response.

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "SMS_OTP", "USERNAME": "[username]"}`

* `"ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": {
  "ANSWER": "EMAIL_OTP", "USERNAME": "[username]"}`

WEB_AUTHN

: ‘“ChallengeName”: “WEB_AUTHN”, “ChallengeResponses”: { “USERNAME”:

"[username]", "CREDENTIAL": "[AuthenticationResponseJSON]"}`

See [ AuthenticationResponseJSON][1].

PASSWORD

: ‘“ChallengeName”: “PASSWORD”, “ChallengeResponses”: { “USERNAME”:

"[username]", "PASSWORD": "[password]"}`

PASSWORD_SRP

: ‘“ChallengeName”: “PASSWORD_SRP”, “ChallengeResponses”: {

"USERNAME": "[username]", "SRP_A": "[SRP_A]"}`

SMS_OTP

: ‘“ChallengeName”: “SMS_OTP”, “ChallengeResponses”: {“SMS_OTP_CODE”:

"[code]", "USERNAME": "[username]"}`

EMAIL_OTP

: ‘“ChallengeName”: “EMAIL_OTP”, “ChallengeResponses”:

{"EMAIL_OTP_CODE": "[code]", "USERNAME": "[username]"}`

SMS_MFA

: ‘“ChallengeName”: “SMS_MFA”, “ChallengeResponses”: {“SMS_MFA_CODE”:

"[code]", "USERNAME": "[username]"}`

PASSWORD_VERIFIER

: This challenge response is part of the SRP flow. Amazon Cognito

requires that your application respond to this challenge within a
few seconds. When the response time exceeds this period, your user
pool returns a `NotAuthorizedException` error.

`"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
"PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
[timestamp], "USERNAME": "[username]"}`

CUSTOM_CHALLENGE

: ‘“ChallengeName”: “CUSTOM_CHALLENGE”, “ChallengeResponses”:

{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}`

NEW_PASSWORD_REQUIRED

: ‘“ChallengeName”: “NEW_PASSWORD_REQUIRED”, “ChallengeResponses”:

{"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}`

To set any required attributes that `InitiateAuth` returned in an
`requiredAttributes` parameter, add
`"userAttributes.[attribute_name]": "[attribute_value]"`. This
parameter can also set values for writable attributes that aren't
required by your user pool.

<note markdown="1"> In a `NEW_PASSWORD_REQUIRED` challenge response, you can't modify a
required attribute that already has a value. In
`AdminRespondToAuthChallenge` or `RespondToAuthChallenge`, set a
value for any keys that Amazon Cognito returned in the
`requiredAttributes` parameter, then use the
`AdminUpdateUserAttributes` or `UpdateUserAttributes` API operation
to modify the value of any additional attributes.

 </note>

SOFTWARE_TOKEN_MFA

: ‘“ChallengeName”: “SOFTWARE_TOKEN_MFA”, “ChallengeResponses”:

{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
[authenticator_code]}`

DEVICE_SRP_AUTH

: ‘“ChallengeName”: “DEVICE_SRP_AUTH”, “ChallengeResponses”:

{"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
"[srp_a]"}`

DEVICE_PASSWORD_VERIFIER

: ‘“ChallengeName”: “DEVICE_PASSWORD_VERIFIER”, “ChallengeResponses”:

{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
"[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK":
"[secret_block]", "TIMESTAMP": [timestamp], "USERNAME":
"[username]"}`

MFA_SETUP

: ‘“ChallengeName”: “MFA_SETUP”, “ChallengeResponses”: {“USERNAME”:

"[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"`

SELECT_MFA_TYPE

: ‘“ChallengeName”: “SELECT_MFA_TYPE”, “ChallengeResponses”:

{"USERNAME": "[username]", "ANSWER":
"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]"}`

For more information about ‘SECRET_HASH`, see [Computing secret hash values]. For information about `DEVICE_KEY`, see [Working with user devices in your user pool].

[1]: www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson [2]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash [3]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html

:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: *post authentication*, *pre token generation*, *define auth challenge*, *create auth challenge*, and *verify auth challenge*. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::RespondToAuthChallengeResponse) —
Returns a response object which responds to the following methods:
- #challenge_name => String
- #session => String
- #challenge_parameters => Hash<String,String>
- #authentication_result => Types::AuthenticationResultType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10537

def respond_to_auth_challenge(params = {}, options = {})
  req = build_request(:respond_to_auth_challenge, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.revoke_token({
  token: "TokenModelType", # required
  client_id: "ClientIdType", # required
  client_secret: "ClientSecretType",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:token (required, String) —

The refresh token that you want to revoke.
:client_id (required, String) —

The ID of the app client where the token that you want to revoke was issued.
:client_secret (String) —

The client secret of the requested app client, if the client has a secret.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10585

def revoke_token(params = {}, options = {})
  req = build_request(:revoke_token, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html

Examples:

Request syntax with placeholder values


resp = client.set_log_delivery_configuration({
  user_pool_id: "UserPoolIdType", # required
  log_configurations: [ # required
    {
      log_level: "ERROR", # required, accepts ERROR, INFO
      event_source: "userNotification", # required, accepts userNotification, userAuthEvents
      cloud_watch_logs_configuration: {
        log_group_arn: "ArnType",
      },
      s3_configuration: {
        bucket_arn: "S3ArnType",
      },
      firehose_configuration: {
        stream_arn: "ArnType",
      },
    },
  ],
})

Response structure


resp.log_delivery_configuration.user_pool_id #=> String
resp.log_delivery_configuration.log_configurations #=> Array
resp.log_delivery_configuration.log_configurations[0].log_level #=> String, one of "ERROR", "INFO"
resp.log_delivery_configuration.log_configurations[0].event_source #=> String, one of "userNotification", "userAuthEvents"
resp.log_delivery_configuration.log_configurations[0].cloud_watch_logs_configuration.log_group_arn #=> String
resp.log_delivery_configuration.log_configurations[0].s3_configuration.bucket_arn #=> String
resp.log_delivery_configuration.log_configurations[0].firehose_configuration.stream_arn #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to configure logging.
:log_configurations (required, Array<Types::LogConfigurationType>) —

A collection of the logging configurations for a user pool.

Returns:

(Types::SetLogDeliveryConfigurationResponse) —
Returns a response object which responds to the following methods:
- #log_delivery_configuration => Types::LogDeliveryConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10644

def set_log_delivery_configuration(params = {}, options = {})
  req = build_request(:set_log_delivery_configuration, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html

Examples:

Request syntax with placeholder values


resp = client.set_risk_configuration({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
  compromised_credentials_risk_configuration: {
    event_filter: ["SIGN_IN"], # accepts SIGN_IN, PASSWORD_CHANGE, SIGN_UP
    actions: { # required
      event_action: "BLOCK", # required, accepts BLOCK, NO_ACTION
    },
  },
  account_takeover_risk_configuration: {
    notify_configuration: {
      from: "StringType",
      reply_to: "StringType",
      source_arn: "ArnType", # required
      block_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
      no_action_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
      mfa_email: {
        subject: "EmailNotificationSubjectType", # required
        html_body: "EmailNotificationBodyType",
        text_body: "EmailNotificationBodyType",
      },
    },
    actions: { # required
      low_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
      medium_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
      high_action: {
        notify: false, # required
        event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
      },
    },
  },
  risk_exception_configuration: {
    blocked_ip_range_list: ["StringType"],
    skipped_ip_range_list: ["StringType"],
  },
})

Response structure


resp.risk_configuration.user_pool_id #=> String
resp.risk_configuration.client_id #=> String
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter #=> Array
resp.risk_configuration.compromised_credentials_risk_configuration.event_filter[0] #=> String, one of "SIGN_IN", "PASSWORD_CHANGE", "SIGN_UP"
resp.risk_configuration.compromised_credentials_risk_configuration.actions.event_action #=> String, one of "BLOCK", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.from #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.reply_to #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.source_arn #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.block_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.no_action_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.subject #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.html_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.notify_configuration.mfa_email.text_body #=> String
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.low_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.medium_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.notify #=> Boolean
resp.risk_configuration.account_takeover_risk_configuration.actions.high_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.blocked_ip_range_list[0] #=> String
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list #=> Array
resp.risk_configuration.risk_exception_configuration.skipped_ip_range_list[0] #=> String
resp.risk_configuration.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to set a risk configuration. If you include ‘UserPoolId` in your request, don’t include ‘ClientId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. When you include both `ClientId` and `UserPoolId`, Amazon Cognito maps the configuration to the app client only.
:client_id (String) —

The ID of the app client where you want to set a risk configuration. If ‘ClientId` is null, then the risk configuration is mapped to `UserPoolId`. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

When you include a ‘ClientId` parameter, Amazon Cognito maps the configuration to the app client. When you include both `ClientId` and `UserPoolId`, Amazon Cognito maps the configuration to the app client only.
:compromised_credentials_risk_configuration (Types::CompromisedCredentialsRiskConfigurationType) —

The configuration of automated reactions to detected compromised credentials. Includes settings for blocking future sign-in requests and for the types of password-submission events you want to monitor.
:account_takeover_risk_configuration (Types::AccountTakeoverRiskConfigurationType) —

The settings for automated responses and notification templates for adaptive authentication with threat protection.
:risk_exception_configuration (Types::RiskExceptionConfigurationType) —

A set of IP-address overrides to threat protection. You can set up IP-address always-block and always-allow lists.

Returns:

(Types::SetRiskConfigurationResponse) —
Returns a response object which responds to the following methods:
- #risk_configuration => Types::RiskConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10797

def set_risk_configuration(params = {}, options = {})
  req = build_request(:set_risk_configuration, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.set_ui_customization({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType",
  css: "CSSType",
  image_file: "data",
})

Response structure


resp.ui_customization.user_pool_id #=> String
resp.ui_customization.client_id #=> String
resp.ui_customization.image_url #=> String
resp.ui_customization.css #=> String
resp.ui_customization.css_version #=> String
resp.ui_customization.last_modified_date #=> Time
resp.ui_customization.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to apply branding to the classic hosted UI.
:client_id (String) —

The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to ‘ALL`.
:css (String) —

A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool *App clients* tab, select *Login pages*, edit *Hosted UI (classic) style*, and select the link to ‘CSS template.css`.
:image_file (String, StringIO, File) —

The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.

Returns:

(Types::SetUICustomizationResponse) —
Returns a response object which responds to the following methods:
- #ui_customization => Types::UICustomizationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10876

def set_ui_customization(params = {}, options = {})
  req = build_request(:set_ui_customization, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.set_user_mfa_preference({
  sms_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  software_token_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  email_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  access_token: "TokenModelType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:sms_mfa_settings (Types::SMSMfaSettingsType) —

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.
:software_token_mfa_settings (Types::SoftwareTokenMfaSettingsType) —

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. Users must register a TOTP authenticator before they set this as their preferred MFA method.
:email_mfa_settings (Types::EmailMfaSettingsType) —

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the [ Essentials tier] or higher.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 10959

def set_user_mfa_preference(params = {}, options = {})
  req = build_request(:set_user_mfa_preference, params)
  req.send_request(options)
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].

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html#amazon-cognito-user-pools-authentication-flow-methods-passkey [3]: console.aws.amazon.com/pinpoint/home/ [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.set_user_pool_mfa_config({
  user_pool_id: "UserPoolIdType", # required
  sms_mfa_configuration: {
    sms_authentication_message: "SmsVerificationMessageType",
    sms_configuration: {
      sns_caller_arn: "ArnType", # required
      external_id: "StringType",
      sns_region: "RegionCodeType",
    },
  },
  software_token_mfa_configuration: {
    enabled: false,
  },
  email_mfa_configuration: {
    message: "EmailMfaMessageType",
    subject: "EmailMfaSubjectType",
  },
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  web_authn_configuration: {
    relying_party_id: "RelyingPartyIdType",
    user_verification: "required", # accepts required, preferred
  },
})

Response structure


resp.sms_mfa_configuration.sms_authentication_message #=> String
resp.sms_mfa_configuration.sms_configuration.sns_caller_arn #=> String
resp.sms_mfa_configuration.sms_configuration.external_id #=> String
resp.sms_mfa_configuration.sms_configuration.sns_region #=> String
resp.software_token_mfa_configuration.enabled #=> Boolean
resp.email_mfa_configuration.message #=> String
resp.email_mfa_configuration.subject #=> String
resp.mfa_configuration #=> String, one of "OFF", "ON", "OPTIONAL"
resp.web_authn_configuration.relying_party_id #=> String
resp.web_authn_configuration.user_verification #=> String, one of "required", "preferred"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The user pool ID.
:sms_mfa_configuration (Types::SmsMfaConfigType) —

Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.
:software_token_mfa_configuration (Types::SoftwareTokenMfaConfigType) —

Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.
:email_mfa_configuration (Types::EmailMfaConfigType) —

Sets configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the [ Essentials tier] or higher.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
:mfa_configuration (String) —

Sets multi-factor authentication (MFA) to be on, off, or optional. When ‘ON`, all users must set up MFA before they can sign in. When `OPTIONAL`, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose `OPTIONAL`.

When ‘MfaConfiguration` is `OPTIONAL`, managed login doesn’t automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
:web_authn_configuration (Types::WebAuthnConfigurationType) —

The configuration of your user pool for passkey, or WebAuthn, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.

Returns:

(Types::SetUserPoolMfaConfigResponse) —
Returns a response object which responds to the following methods:
- #sms_mfa_configuration => Types::SmsMfaConfigType
- #software_token_mfa_configuration => Types::SoftwareTokenMfaConfigType
- #email_mfa_configuration => Types::EmailMfaConfigType
- #mfa_configuration => String
- #web_authn_configuration => Types::WebAuthnConfigurationType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11087

def set_user_pool_mfa_config(params = {}, options = {})
  req = build_request(:set_user_pool_mfa_config, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.set_user_settings({
  access_token: "TokenModelType", # required
  mfa_options: [ # required
    {
      delivery_medium: "SMS", # accepts SMS, EMAIL
      attribute_name: "AttributeNameType",
    },
  ],
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:mfa_options (required, Array<Types::MFAOptionType>) —

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11139

def set_user_settings(params = {}, options = {})
  req = build_request(:set_user_settings, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.sign_up({
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  password: "PasswordType",
  user_attributes: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  validation_data: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    ip_address: "StringType",
    encoded_data: "StringType",
  },
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.user_confirmed #=> Boolean
resp.code_delivery_details.destination #=> String
resp.code_delivery_details.delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details.attribute_name #=> String
resp.user_sub #=> String
resp.session #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:client_id (required, String) —

The ID of the app client where the user wants to sign up.
:secret_hash (String) —

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash
:username (required, String) —

The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.
:password (String) —

The user’s proposed password. The password must comply with the

password requirements][1

of your user pool.

Users can sign up without a password when your user pool supports passwordless sign-in with email or SMS OTPs. To create a user with no password, omit this parameter or submit a blank value. You can only create a passwordless user when passwordless sign-in is available.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html
:user_attributes (Array<Types::AttributeType>) —

An array of name-value pairs representing user attributes.

For custom attributes, include a ‘custom:` prefix in the attribute name, for example `custom:department`.
:validation_data (Array<Types::AttributeType>) —

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don’t need to retain.

Your Lambda function can analyze this additional data and act on it. Your function can automatically confirm and verify select users or perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs.

For more information about the pre sign-up Lambda trigger, see [Pre sign-up Lambda trigger].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html
:analytics_metadata (Types::AnalyticsMetadataType) —

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
:user_context_data (Types::UserContextDataType) —

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: *pre sign-up*, *custom message*, and *post confirmation*. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::SignUpResponse) —
Returns a response object which responds to the following methods:
- #user_confirmed => Boolean
- #code_delivery_details => Types::CodeDeliveryDetailsType
- #user_sub => String
- #session => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11351

def sign_up(params = {}, options = {})
  req = build_request(:sign_up, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html

Examples:

Request syntax with placeholder values


resp = client.start_user_import_job({
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that you want to start importing users into.
:job_id (required, String) —

The ID of a user import job that you previously created.

Returns:

(Types::StartUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11402

def start_user_import_job(params = {}, options = {})
  req = build_request(:start_user_import_job, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.start_web_authn_registration({
  access_token: "TokenModelType", # required
})

Response structure

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

(Types::StartWebAuthnRegistrationResponse) —
Returns a response object which responds to the following methods:
- #credential_creation_options => Hash,Array,String,Numeric,Boolean

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11439

def start_web_authn_registration(params = {}, options = {})
  req = build_request(:start_web_authn_registration, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html

Examples:

Request syntax with placeholder values


resp = client.stop_user_import_job({
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
})

Response structure


resp.user_import_job.job_name #=> String
resp.user_import_job.job_id #=> String
resp.user_import_job.user_pool_id #=> String
resp.user_import_job.pre_signed_url #=> String
resp.user_import_job.creation_date #=> Time
resp.user_import_job.start_date #=> Time
resp.user_import_job.completion_date #=> Time
resp.user_import_job.status #=> String, one of "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded"
resp.user_import_job.cloud_watch_logs_role_arn #=> String
resp.user_import_job.imported_users #=> Integer
resp.user_import_job.skipped_users #=> Integer
resp.user_import_job.failed_users #=> Integer
resp.user_import_job.completion_message #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that you want to stop.
:job_id (required, String) —

The ID of a running user import job.

Returns:

(Types::StopUserImportJobResponse) —
Returns a response object which responds to the following methods:
- #user_import_job => Types::UserImportJobType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11490

def stop_user_import_job(params = {}, options = {})
  req = build_request(:stop_user_import_job, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ArnType", # required
  tags: { # required
    "TagKeysType" => "TagValueType",
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the user pool to assign the tags to.
:tags (required, Hash<String,String>) —

An array of tag keys and values that you want to assign to the user pool.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11537

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ `Struct`

Given tag IDs that you previously assigned to a user pool, removes them.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ArnType", # required
  tag_keys: ["TagKeysType"], # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource_arn (required, String) —

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
:tag_keys (required, Array<String>) —

An array of tag keys that you want to remove from the user pool.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11565

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_auth_event_feedback({
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  event_id: "EventIdType", # required
  feedback_token: "TokenModelType", # required
  feedback_value: "Valid", # required, accepts Valid, Invalid
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to update auth event feedback.
:username (required, String) —

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.
:event_id (required, String) —

The ID of the authentication event that you want to submit feedback for.
:feedback_token (required, String) —

The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in the notification email message from the event.
:feedback_value (required, String) —

Your feedback to the authentication event. When you provide a ‘FeedbackValue` value of `valid`, you tell Amazon Cognito that you trust a user session where Amazon Cognito has evaluated some level of risk. When you provide a `FeedbackValue` value of `invalid`, you tell Amazon Cognito that you don’t trust a user session, or you don’t believe that Amazon Cognito evaluated a high-enough risk level.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11644

def update_auth_event_feedback(params = {}, options = {})
  req = build_request(:update_auth_event_feedback, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_device_status({
  access_token: "TokenModelType", # required
  device_key: "DeviceKeyType", # required
  device_remembered_status: "remembered", # accepts remembered, not_remembered
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:device_key (required, String) —

The device key of the device you want to update, for example ‘us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.
:device_remembered_status (String) —

To enable device authentication with the specified device, set to ‘remembered`.To disable, set to `not_remembered`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11702

def update_device_status(params = {}, options = {})
  req = build_request(:update_device_status, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_group({
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
  description: "DescriptionType",
  role_arn: "ArnType",
  precedence: 1,
})

Response structure


resp.group.group_name #=> String
resp.group.user_pool_id #=> String
resp.group.description #=> String
resp.group.role_arn #=> String
resp.group.precedence #=> Integer
resp.group.last_modified_date #=> Time
resp.group.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:group_name (required, String) —

The name of the group that you want to update.
:user_pool_id (required, String) —

The ID of the user pool that contains the group you want to update.
:description (String) —

A new description of the existing group.
:role_arn (String) —

The Amazon Resource Name (ARN) of an IAM role that you want to associate with the group. The role assignment contributes to the ‘cognito:roles` and `cognito:preferred_role` claims in group members’ tokens.
:precedence (Integer) —

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower ‘Precedence` values take precedence over groups with higher or null `Precedence` values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user’s tokens for the ‘cognito:roles` and `cognito:preferred_role` claims.

Two groups can have the same ‘Precedence` value. If this happens, neither group takes precedence over the other. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn’t set in users’ tokens.

The default ‘Precedence` value is null. The maximum `Precedence` value is `2^31-1`.

Returns:

(Types::UpdateGroupResponse) —
Returns a response object which responds to the following methods:
- #group => Types::GroupType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 11793

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_identity_provider({
  user_pool_id: "UserPoolIdType", # required
  provider_name: "ProviderNameType", # required
  provider_details: {
    "StringType" => "StringType",
  },
  attribute_mapping: {
    "AttributeMappingKeyType" => "StringType",
  },
  idp_identifiers: ["IdpIdentifierType"],
})

Response structure


resp.identity_provider.user_pool_id #=> String
resp.identity_provider.provider_name #=> String
resp.identity_provider.provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.provider_details #=> Hash
resp.identity_provider.provider_details["StringType"] #=> String
resp.identity_provider.attribute_mapping #=> Hash
resp.identity_provider.attribute_mapping["AttributeMappingKeyType"] #=> String
resp.identity_provider.idp_identifiers #=> Array
resp.identity_provider.idp_identifiers[0] #=> String
resp.identity_provider.last_modified_date #=> Time
resp.identity_provider.creation_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The Id of the user pool where you want to update your IdP.
:provider_name (required, String) —

The name of the IdP that you want to update. You can pass the identity provider name in the ‘identity_provider` query parameter of requests to the [Authorize endpoint] to silently redirect to sign-in with the associated IdP.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html

:provider_details (Hash<String,String>) —

The scopes, URLs, and identifiers for your external identity provider. The following examples describe the provider detail keys for each IdP type. These values and their schema are subject to change. Social IdP ‘authorize_scopes` values must match the values listed here.

OpenID Connect (OIDC)

: Amazon Cognito accepts the following elements when it can’t

discover endpoint URLs from `oidc_issuer`: `attributes_url`,
`authorize_url`, `jwks_uri`, `token_url`.

Create or update request: `"ProviderDetails": {
"attributes_request_method": "GET", "attributes_url":
"https://auth.example.com/userInfo", "authorize_scopes": "openid
profile email", "authorize_url":
"https://auth.example.com/authorize", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret",
"jwks_uri": "https://auth.example.com/.well-known/jwks.json",
"oidc_issuer": "https://auth.example.com", "token_url":
"https://example.com/token" }`

Describe response: `"ProviderDetails": {
"attributes_request_method": "GET", "attributes_url":
"https://auth.example.com/userInfo",
"attributes_url_add_attributes": "false", "authorize_scopes":
"openid profile email", "authorize_url":
"https://auth.example.com/authorize", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret",
"jwks_uri": "https://auth.example.com/.well-known/jwks.json",
"oidc_issuer": "https://auth.example.com", "token_url":
"https://example.com/token" }`

SAML

: Create or update request with Metadata URL: ‘“ProviderDetails”: {

"IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
"true", "MetadataURL": "https://auth.example.com/sso/saml/metadata",
"RequestSigningAlgorithm": "rsa-sha256" }`

Create or update request with Metadata file: `"ProviderDetails": {
"IDPInit": "true", "IDPSignout": "true", "EncryptedResponses" :
"true", "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
"rsa-sha256" }`

The value of `MetadataFile` must be the plaintext metadata document
with all quote (") characters escaped by backslashes.

Describe response: `"ProviderDetails": { "IDPInit": "true",
"IDPSignout": "true", "EncryptedResponses" : "true",
"ActiveEncryptionCertificate": "[certificate]", "MetadataURL":
"https://auth.example.com/sso/saml/metadata",
"RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI":
"https://auth.example.com/slo/saml", "SSORedirectBindingURI":
"https://auth.example.com/sso/saml" }`

LoginWithAmazon

: Create or update request: ‘“ProviderDetails”: { “authorize_scopes”:

"profile postal_code", "client_id":
"amzn1.application-oa2-client.1example23456789", "client_secret":
"provider-app-client-secret"`

Describe response: `"ProviderDetails": { "attributes_url":
"https://api.amazon.com/user/profile",
"attributes_url_add_attributes": "false", "authorize_scopes":
"profile postal_code", "authorize_url":
"https://www.amazon.com/ap/oa", "client_id":
"amzn1.application-oa2-client.1example23456789", "client_secret":
"provider-app-client-secret", "token_request_method": "POST",
"token_url": "https://api.amazon.com/auth/o2/token" }`

Google

: Create or update request: ‘“ProviderDetails”: { “authorize_scopes”:

"email profile openid", "client_id":
"1example23456789.apps.googleusercontent.com", "client_secret":
"provider-app-client-secret" }`

Describe response: `"ProviderDetails": { "attributes_url":
"https://people.googleapis.com/v1/people/me?personFields=",
"attributes_url_add_attributes": "true", "authorize_scopes": "email
profile openid", "authorize_url":
"https://accounts.google.com/o/oauth2/v2/auth", "client_id":
"1example23456789.apps.googleusercontent.com", "client_secret":
"provider-app-client-secret", "oidc_issuer":
"https://accounts.google.com", "token_request_method": "POST",
"token_url": "https://www.googleapis.com/oauth2/v4/token" }`

SignInWithApple

: Create or update request: ‘“ProviderDetails”: { “authorize_scopes”:

"email name", "client_id": "com.example.cognito", "private_key":
"1EXAMPLE", "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" }`

Describe response: `"ProviderDetails": {
"attributes_url_add_attributes": "false", "authorize_scopes": "email
name", "authorize_url": "https://appleid.apple.com/auth/authorize",
"client_id": "com.example.cognito", "key_id": "1EXAMPLE",
"oidc_issuer": "https://appleid.apple.com", "team_id": "2EXAMPLE",
"token_request_method": "POST", "token_url":
"https://appleid.apple.com/auth/token" }`

Facebook

: Create or update request: ‘“ProviderDetails”: { “api_version”:

"v17.0", "authorize_scopes": "public_profile, email", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret" }`

Describe response: `"ProviderDetails": { "api_version": "v17.0",
"attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
"attributes_url_add_attributes": "true", "authorize_scopes":
"public_profile, email", "authorize_url":
"https://www.facebook.com/v17.0/dialog/oauth", "client_id":
"1example23456789", "client_secret": "provider-app-client-secret",
"token_request_method": "GET", "token_url":
"https://graph.facebook.com/v17.0/oauth/access_token" }`

:attribute_mapping (Hash<String,String>) —

A mapping of IdP attributes to standard and custom user pool attributes. Specify a user pool attribute as the key of the key-value pair, and the IdP attribute claim name as the value.
:idp_identifiers (Array<String>) —

An array of IdP identifiers, for example ‘“IdPIdentifiers”: [ “MyIdP”, “MyIdP2” ]`. Identifiers are friendly names that you can pass in the `idp_identifier` query parameter of requests to the [Authorize endpoint] to silently redirect to sign-in with the associated IdP. Identifiers in a domain format also enable the use of [email-address matching with SAML providers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html

Returns:

(Types::UpdateIdentityProviderResponse) —
Returns a response object which responds to the following methods:
- #identity_provider => Types::IdentityProviderType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 12008

def update_identity_provider(params = {}, options = {})
  req = build_request(:update_identity_provider, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_managed_login_branding({
  user_pool_id: "UserPoolIdType",
  managed_login_branding_id: "ManagedLoginBrandingIdType",
  use_cognito_provided_values: false,
  settings: {
  },
  assets: [
    {
      category: "FAVICON_ICO", # required, accepts FAVICON_ICO, FAVICON_SVG, EMAIL_GRAPHIC, SMS_GRAPHIC, AUTH_APP_GRAPHIC, PASSWORD_GRAPHIC, PASSKEY_GRAPHIC, PAGE_HEADER_LOGO, PAGE_HEADER_BACKGROUND, PAGE_FOOTER_LOGO, PAGE_FOOTER_BACKGROUND, PAGE_BACKGROUND, FORM_BACKGROUND, FORM_LOGO, IDP_BUTTON_ICON
      color_mode: "LIGHT", # required, accepts LIGHT, DARK, DYNAMIC
      extension: "ICO", # required, accepts ICO, JPEG, PNG, SVG, WEBP
      bytes: "data",
      resource_id: "ResourceIdType",
    },
  ],
})

Response structure


resp.managed_login_branding.managed_login_branding_id #=> String
resp.managed_login_branding.user_pool_id #=> String
resp.managed_login_branding.use_cognito_provided_values #=> Boolean
resp.managed_login_branding.assets #=> Array
resp.managed_login_branding.assets[0].category #=> String, one of "FAVICON_ICO", "FAVICON_SVG", "EMAIL_GRAPHIC", "SMS_GRAPHIC", "AUTH_APP_GRAPHIC", "PASSWORD_GRAPHIC", "PASSKEY_GRAPHIC", "PAGE_HEADER_LOGO", "PAGE_HEADER_BACKGROUND", "PAGE_FOOTER_LOGO", "PAGE_FOOTER_BACKGROUND", "PAGE_BACKGROUND", "FORM_BACKGROUND", "FORM_LOGO", "IDP_BUTTON_ICON"
resp.managed_login_branding.assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp.managed_login_branding.assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp.managed_login_branding.assets[0].bytes #=> String
resp.managed_login_branding.assets[0].resource_id #=> String
resp.managed_login_branding.creation_date #=> Time
resp.managed_login_branding.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (String) —

The ID of the user pool that contains the managed login branding style that you want to update.
:managed_login_branding_id (String) —

The ID of the managed login branding style that you want to update.
:use_cognito_provided_values (Boolean) —

When ‘true`, applies the default branding style options. This option reverts to default style options that are managed by Amazon Cognito. You can modify them later in the branding editor.

When you specify ‘true` for this option, you must also omit values for `Settings` and `Assets` in the request.
:settings (Hash, Array, String, Numeric, Boolean) —
A JSON file, encoded as a ‘Document` type, with the the settings that you want to apply to your style.

The following components are not currently implemented and reserved for future use:
- ‘signUp`
- ‘instructions`
- ‘sessionTimerDisplay`
- ‘languageSelector` (for localization, see [Managed login localization)]
Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization
:assets (Array<Types::AssetType>) —

An array of image files that you want to apply to roles like backgrounds, logos, and icons. Each object must also indicate whether it is for dark mode, light mode, or browser-adaptive mode.

Returns:

(Types::UpdateManagedLoginBrandingResponse) —
Returns a response object which responds to the following methods:
- #managed_login_branding => Types::ManagedLoginBrandingType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 12132

def update_managed_login_branding(params = {}, options = {})
  req = build_request(:update_managed_login_branding, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_resource_server({
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
  name: "ResourceServerNameType", # required
  scopes: [
    {
      scope_name: "ResourceServerScopeNameType", # required
      scope_description: "ResourceServerScopeDescriptionType", # required
    },
  ],
})

Response structure


resp.resource_server.user_pool_id #=> String
resp.resource_server.identifier #=> String
resp.resource_server.name #=> String
resp.resource_server.scopes #=> Array
resp.resource_server.scopes[0].scope_name #=> String
resp.resource_server.scopes[0].scope_description #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool that contains the resource server that you want to update.
:identifier (required, String) —

A unique resource server identifier for the resource server. The identifier can be an API friendly name like ‘solar-system-data`. You can also set an API URL like `solar-system-data-api.example.com` as your identifier.

Amazon Cognito represents scopes in the access token in the format ‘$resource-server-identifier/$scope`. Longer scope-identifier strings increase the size of your access tokens.
:name (required, String) —

The updated name of the resource server.
:scopes (Array<Types::ResourceServerScopeType>) —

An array of updated custom scope names and descriptions that you want to associate with your resource server.

Returns:

(Types::UpdateResourceServerResponse) —
Returns a response object which responds to the following methods:
- #resource_server => Types::ResourceServerType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 12215

def update_resource_server(params = {}, options = {})
  req = build_request(:update_resource_server, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][3]

Using the Amazon Cognito user pools API and user pool endpoints][4

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-localization [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_terms({
  terms_id: "TermsIdType", # required
  user_pool_id: "UserPoolIdType", # required
  terms_name: "TermsNameType",
  terms_source: "LINK", # accepts LINK
  enforcement: "NONE", # accepts NONE
  links: {
    "LanguageIdType" => "LinkUrlType",
  },
})

Response structure


resp.terms.terms_id #=> String
resp.terms.user_pool_id #=> String
resp.terms.client_id #=> String
resp.terms.terms_name #=> String
resp.terms.terms_source #=> String, one of "LINK"
resp.terms.enforcement #=> String, one of "NONE"
resp.terms.links #=> Hash
resp.terms.links["LanguageIdType"] #=> String
resp.terms.creation_date #=> Time
resp.terms.last_modified_date #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:terms_id (required, String) —

The ID of the terms document that you want to update.
:user_pool_id (required, String) —

The ID of the user pool that contains the terms that you want to update.
:terms_name (String) —

The new name that you want to apply to the requested terms documents.
:terms_source (String) —

This parameter is reserved for future use and currently accepts only one value.
:enforcement (String) —

This parameter is reserved for future use and currently accepts only one value.
:links (Hash<String,String>) —

A map of URLs to languages. For each localized language that will view the requested ‘TermsName`, assign a URL. A selection of `cognito:default` displays for all languages that don’t have a language-specific URL.

For example, ‘“cognito:default”: “terms.example.com”, “cognito:spanish”: “terms.example.com/es”`.

Returns:

(Types::UpdateTermsResponse) —
Returns a response object which responds to the following methods:
- #terms => Types::TermsType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 12318

def update_terms(params = {}, options = {})
  req = build_request(:update_terms, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html [2]: console.aws.amazon.com/pinpoint/home/ [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html

Examples:

Request syntax with placeholder values


resp = client.update_user_attributes({
  user_attributes: [ # required
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  access_token: "TokenModelType", # required
  client_metadata: {
    "StringType" => "StringType",
  },
})

Response structure


resp.code_delivery_details_list #=> Array
resp.code_delivery_details_list[0].destination #=> String
resp.code_delivery_details_list[0].delivery_medium #=> String, one of "SMS", "EMAIL"
resp.code_delivery_details_list[0].attribute_name #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_attributes (required, Array<Types::AttributeType>) —

An array of name-value pairs representing user attributes.

For custom attributes, you must add a ‘custom:` prefix to the attribute name.

If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:client_metadata (Hash<String,String>) —
A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the *custom message* trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:
```
* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.
```
- Validate the ‘ClientMetadata` value.
- Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

(Types::UpdateUserAttributesResponse) —
Returns a response object which responds to the following methods:
- #code_delivery_details_list => Array<Types::CodeDeliveryDetailsType>

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 12453

def update_user_attributes(params = {}, options = {})
  req = build_request(:update_user_attributes, params)
  req.send_request(options)
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.

<note markdown=“1”> This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with [Amazon Pinpoint]. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

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 <a href=“https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html”>sandbox mode</a> , 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*.

</note>

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][3]

Using the Amazon Cognito user pools API and user pool endpoints][4

</note>

[1]: console.aws.amazon.com/pinpoint/home/ [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [4]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_user_pool({
  user_pool_id: "UserPoolIdType", # required
  policies: {
    password_policy: {
      minimum_length: 1,
      require_uppercase: false,
      require_lowercase: false,
      require_numbers: false,
      require_symbols: false,
      password_history_size: 1,
      temporary_password_validity_days: 1,
    },
    sign_in_policy: {
      allowed_first_auth_factors: ["PASSWORD"], # accepts PASSWORD, EMAIL_OTP, SMS_OTP, WEB_AUTHN
    },
  },
  deletion_protection: "ACTIVE", # accepts ACTIVE, INACTIVE
  lambda_config: {
    pre_sign_up: "ArnType",
    custom_message: "ArnType",
    post_confirmation: "ArnType",
    pre_authentication: "ArnType",
    post_authentication: "ArnType",
    define_auth_challenge: "ArnType",
    create_auth_challenge: "ArnType",
    verify_auth_challenge_response: "ArnType",
    pre_token_generation: "ArnType",
    user_migration: "ArnType",
    pre_token_generation_config: {
      lambda_version: "V1_0", # required, accepts V1_0, V2_0, V3_0
      lambda_arn: "ArnType", # required
    },
    custom_sms_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    custom_email_sender: {
      lambda_version: "V1_0", # required, accepts V1_0
      lambda_arn: "ArnType", # required
    },
    kms_key_id: "ArnType",
  },
  auto_verified_attributes: ["phone_number"], # accepts phone_number, email
  sms_verification_message: "SmsVerificationMessageType",
  email_verification_message: "EmailVerificationMessageType",
  email_verification_subject: "EmailVerificationSubjectType",
  verification_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
    email_message_by_link: "EmailVerificationMessageByLinkType",
    email_subject_by_link: "EmailVerificationSubjectByLinkType",
    default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
  },
  sms_authentication_message: "SmsVerificationMessageType",
  user_attribute_update_settings: {
    attributes_require_verification_before_update: ["phone_number"], # accepts phone_number, email
  },
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  device_configuration: {
    challenge_required_on_new_device: false,
    device_only_remembered_on_user_prompt: false,
  },
  email_configuration: {
    source_arn: "ArnType",
    reply_to_email_address: "EmailAddressType",
    email_sending_account: "COGNITO_DEFAULT", # accepts COGNITO_DEFAULT, DEVELOPER
    from: "StringType",
    configuration_set: "SESConfigurationSet",
  },
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
    sns_region: "RegionCodeType",
  },
  user_pool_tags: {
    "TagKeysType" => "TagValueType",
  },
  admin_create_user_config: {
    allow_admin_create_user_only: false,
    unused_account_validity_days: 1,
    invite_message_template: {
      sms_message: "SmsInviteMessageType",
      email_message: "EmailInviteMessageType",
      email_subject: "EmailVerificationSubjectType",
    },
  },
  user_pool_add_ons: {
    advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
    advanced_security_additional_flows: {
      custom_auth_mode: "AUDIT", # accepts AUDIT, ENFORCED
    },
  },
  account_recovery_setting: {
    recovery_mechanisms: [
      {
        priority: 1, # required
        name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
      },
    ],
  },
  pool_name: "UserPoolNameType",
  user_pool_tier: "LITE", # accepts LITE, ESSENTIALS, PLUS
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool you want to update.
:policies (Types::UserPoolPolicyType) —

The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in [choice-based authentication].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice
:deletion_protection (String) —

When active, ‘DeletionProtection` prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a ‘DeleteUserPool` API request, Amazon Cognito returns an `InvalidParameterException` error. To delete a protected user pool, send a new `DeleteUserPool` request after you deactivate deletion protection in an `UpdateUserPool` API request.
:lambda_config (Types::LambdaConfigType) —

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
:auto_verified_attributes (Array<String>) —

The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. For more information see [Verifying contact information at sign-up].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves
:sms_verification_message (String) —

This parameter is no longer used.
:email_verification_message (String) —

This parameter is no longer used.
:email_verification_subject (String) —

This parameter is no longer used.
:verification_message_template (Types::VerificationMessageTemplateType) —

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Set the email message type that corresponds to your ‘DefaultEmailOption` selection. For `CONFIRM_WITH_LINK`, specify an `EmailMessageByLink` and leave `EmailMessage` blank. For `CONFIRM_WITH_CODE`, specify an `EmailMessage` and leave `EmailMessageByLink` blank. When you supply both parameters with either choice, Amazon Cognito returns an error.
:sms_authentication_message (String) —

The contents of the SMS message that your user pool sends to users in SMS authentication.
:user_attribute_update_settings (Types::UserAttributeUpdateSettingsType) —

The settings for updates to user attributes. These settings include the property ‘AttributesRequireVerificationBeforeUpdate`, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see [ Verifying updates to email addresses and phone numbers].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates
:mfa_configuration (String) —

Sets multi-factor authentication (MFA) to be on, off, or optional. When ‘ON`, all users must set up MFA before they can sign in. When `OPTIONAL`, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose `OPTIONAL`.

When ‘MfaConfiguration` is `OPTIONAL`, managed login doesn’t automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
:device_configuration (Types::DeviceConfigurationType) —
The device-remembering configuration for a user pool. Device remembering or device tracking 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]. A null value indicates that you have deactivated device remembering in your user pool.

<note markdown=“1”> When you provide a value for any ‘DeviceConfiguration` field, you activate the Amazon Cognito device-remembering feature. For more information, see [Working with devices].
```
</note>
```
[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html
:email_configuration (Types::EmailConfigurationType) —

The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
:sms_configuration (Types::SmsConfigurationType) —

The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For more information see [SMS message settings].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html
:user_pool_tags (Hash<String,String>) —

The tag keys and values to assign to the 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.
:admin_create_user_config (Types::AdminCreateUserConfigType) —

The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.
:user_pool_add_ons (Types::UserPoolAddOnsType) —

Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to ‘AUDIT`. To configure automatic security responses to potentially unwanted traffic to your user pool, set to `ENFORCED`.

For more information, see [Adding advanced security to a user pool]. To activate this setting, your user pool must be on the [ Plus tier].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html
:account_recovery_setting (Types::AccountRecoverySettingType) —

The available verified method a user can use to recover their password when they call ‘ForgotPassword`. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn’t qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
:pool_name (String) —

The updated name of your user pool.
:user_pool_tier (String) —

The user pool [feature plan], or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ‘ESSENTIALS`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 12792

def update_user_pool(params = {}, options = {})
  req = build_request(:update_user_pool, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][1]

Using the Amazon Cognito user pools API and user pool endpoints][2

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_user_pool_client({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  client_name: "ClientNameType",
  refresh_token_validity: 1,
  access_token_validity: 1,
  id_token_validity: 1,
  token_validity_units: {
    access_token: "seconds", # accepts seconds, minutes, hours, days
    id_token: "seconds", # accepts seconds, minutes, hours, days
    refresh_token: "seconds", # accepts seconds, minutes, hours, days
  },
  read_attributes: ["ClientPermissionType"],
  write_attributes: ["ClientPermissionType"],
  explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH, ALLOW_ADMIN_USER_PASSWORD_AUTH, ALLOW_CUSTOM_AUTH, ALLOW_USER_PASSWORD_AUTH, ALLOW_USER_SRP_AUTH, ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_AUTH
  supported_identity_providers: ["ProviderNameType"],
  callback_urls: ["RedirectUrlType"],
  logout_urls: ["RedirectUrlType"],
  default_redirect_uri: "RedirectUrlType",
  allowed_o_auth_flows: ["code"], # accepts code, implicit, client_credentials
  allowed_o_auth_scopes: ["ScopeType"],
  allowed_o_auth_flows_user_pool_client: false,
  analytics_configuration: {
    application_id: "HexStringType",
    application_arn: "ArnType",
    role_arn: "ArnType",
    external_id: "StringType",
    user_data_shared: false,
  },
  prevent_user_existence_errors: "LEGACY", # accepts LEGACY, ENABLED
  enable_token_revocation: false,
  enable_propagate_additional_user_context_data: false,
  auth_session_validity: 1,
  refresh_token_rotation: {
    feature: "ENABLED", # required, accepts ENABLED, DISABLED
    retry_grace_period_seconds: 1,
  },
})

Response structure


resp.user_pool_client.user_pool_id #=> String
resp.user_pool_client.client_name #=> String
resp.user_pool_client.client_id #=> String
resp.user_pool_client.client_secret #=> String
resp.user_pool_client.last_modified_date #=> Time
resp.user_pool_client.creation_date #=> Time
resp.user_pool_client.refresh_token_validity #=> Integer
resp.user_pool_client.access_token_validity #=> Integer
resp.user_pool_client.id_token_validity #=> Integer
resp.user_pool_client.token_validity_units.access_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.id_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.token_validity_units.refresh_token #=> String, one of "seconds", "minutes", "hours", "days"
resp.user_pool_client.read_attributes #=> Array
resp.user_pool_client.read_attributes[0] #=> String
resp.user_pool_client.write_attributes #=> Array
resp.user_pool_client.write_attributes[0] #=> String
resp.user_pool_client.explicit_auth_flows #=> Array
resp.user_pool_client.explicit_auth_flows[0] #=> String, one of "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY", "USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH", "ALLOW_USER_AUTH"
resp.user_pool_client.supported_identity_providers #=> Array
resp.user_pool_client.supported_identity_providers[0] #=> String
resp.user_pool_client.callback_urls #=> Array
resp.user_pool_client.callback_urls[0] #=> String
resp.user_pool_client.logout_urls #=> Array
resp.user_pool_client.logout_urls[0] #=> String
resp.user_pool_client.default_redirect_uri #=> String
resp.user_pool_client.allowed_o_auth_flows #=> Array
resp.user_pool_client.allowed_o_auth_flows[0] #=> String, one of "code", "implicit", "client_credentials"
resp.user_pool_client.allowed_o_auth_scopes #=> Array
resp.user_pool_client.allowed_o_auth_scopes[0] #=> String
resp.user_pool_client.allowed_o_auth_flows_user_pool_client #=> Boolean
resp.user_pool_client.analytics_configuration.application_id #=> String
resp.user_pool_client.analytics_configuration.application_arn #=> String
resp.user_pool_client.analytics_configuration.role_arn #=> String
resp.user_pool_client.analytics_configuration.external_id #=> String
resp.user_pool_client.analytics_configuration.user_data_shared #=> Boolean
resp.user_pool_client.prevent_user_existence_errors #=> String, one of "LEGACY", "ENABLED"
resp.user_pool_client.enable_token_revocation #=> Boolean
resp.user_pool_client.enable_propagate_additional_user_context_data #=> Boolean
resp.user_pool_client.auth_session_validity #=> Integer
resp.user_pool_client.refresh_token_rotation.feature #=> String, one of "ENABLED", "DISABLED"
resp.user_pool_client.refresh_token_rotation.retry_grace_period_seconds #=> Integer

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:user_pool_id (required, String) —

The ID of the user pool where you want to update the app client.
:client_id (required, String) —

The ID of the app client that you want to update.
:client_name (String) —

A friendly name for the app client.
:refresh_token_validity (Integer) —

The refresh token time limit. After this limit expires, your user can’t use their refresh token. To specify the time unit for ‘RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set ‘RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days.

The default time unit for ‘RefreshTokenValidity` in an API request is days. You can’t set ‘RefreshTokenValidity` to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. *Valid range* is displayed below in seconds.

If you don’t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
:access_token_validity (Integer) —

The access token time limit. After this limit expires, your user can’t use their access token. To specify the time unit for ‘AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set ‘AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours.

The default time unit for ‘AccessTokenValidity` in an API request is hours. *Valid range* is displayed below in seconds.

If you don’t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
:id_token_validity (Integer) —

The ID token time limit. After this limit expires, your user can’t use their ID token. To specify the time unit for ‘IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request.

For example, when you set ‘IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours.

The default time unit for ‘IdTokenValidity` in an API request is hours. *Valid range* is displayed below in seconds.

If you don’t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
:token_validity_units (Types::TokenValidityUnitsType) —

The units that validity times are represented in. The default unit for refresh tokens is days, and the default for ID and access tokens are hours.
:read_attributes (Array<String>) —

The list of user attributes that you want your app client to have read access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list.

When you don’t specify the ‘ReadAttributes` for your app client, your app can read the values of `email_verified`, `phone_number_verified`, and the standard attributes of your user pool. When your user pool app client has read access to these default attributes, `ReadAttributes` doesn’t return any information. Amazon Cognito only populates ‘ReadAttributes` in the API response if you have specified your own custom set of read attributes.
:write_attributes (Array<String>) —

The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.

When you don’t specify the ‘WriteAttributes` for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, `WriteAttributes` doesn’t return any information. Amazon Cognito only populates ‘WriteAttributes` in the API response if you have specified your own custom set of write attributes.

If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see [Specifying IdP Attribute Mappings for Your user pool].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
:explicit_auth_flows (Array<String>) —
The [authentication flows] that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

<note markdown=“1”> If you don’t specify a value for ‘ExplicitAuthFlows`, your app client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`.
```
</note>
```
The values for authentication flow options include the following.
- ‘ALLOW_USER_AUTH`: Enable selection-based sign-in with `USER_AUTH`. This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other `ExplicitAuthFlows` permitting them. For example users can complete an SRP challenge through `USER_AUTH` without the flow `USER_SRP_AUTH` being active for the app client. This flow doesn’t include ‘CUSTOM_AUTH`.
  
  To activate this setting, your user pool must be in the [ Essentials tier] or higher.
- ‘ALLOW_ADMIN_USER_PASSWORD_AUTH`: Enable admin based user password authentication flow `ADMIN_USER_PASSWORD_AUTH`. This setting replaces the `ADMIN_NO_SRP_AUTH` setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
- ‘ALLOW_CUSTOM_AUTH`: Enable Lambda trigger based authentication.
- ‘ALLOW_USER_PASSWORD_AUTH`: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
- ‘ALLOW_USER_SRP_AUTH`: Enable SRP-based authentication.
- ‘ALLOW_REFRESH_TOKEN_AUTH`: Enable authflow to refresh tokens.
In some environments, you will see the values ‘ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`. You can’t assign these legacy ‘ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html
:supported_identity_providers (Array<String>) —

A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: ‘COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`.

This parameter sets the IdPs that [managed login] will display on the login page for your app client. The removal of ‘COGNITO` from this list doesn’t prevent authentication operations for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent SDK-based authentication is to block access with a [WAF rule].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html
:callback_urls (Array<String>) —
A list of allowed redirect, or callback, URLs for managed login authentication. These URLs are the paths where you want to send your users’ browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.

A redirect URI must meet the following requirements:
- Be an absolute URI.
- Be registered with the authorization server. Amazon Cognito doesn’t accept authorization requests with ‘redirect_uri` values that aren’t in the list of ‘CallbackURLs` that you provide in this parameter.
- Not include a fragment component.
See [OAuth 2.0 - Redirection Endpoint].

Amazon Cognito requires HTTPS over HTTP except for localhost for testing purposes only.

App callback URLs such as ‘myapp://example` are also supported.

[1]: tools.ietf.org/html/rfc6749#section-3.1.2
:logout_urls (Array<String>) —

A list of allowed logout URLs for managed login authentication. When you pass ‘logout_uri` and `client_id` parameters to `/logout`, Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of `logout_uri`. A typical use of these URLs is when a user selects “Sign out” and you redirect them to your public homepage. For more information, see [Logout endpoint].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
:default_redirect_uri (String) —

The default redirect URI. In app clients with one assigned IdP, replaces ‘redirect_uri` in authentication requests. Must be in the `CallbackURLs` list.
:allowed_o_auth_flows (Array<String>) —
The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add ‘client_credentials` as the only allowed OAuth flow.

code

: Use a code grant flow, which provides an authorization code as the
```
response. This code can be exchanged for access tokens with the
`/oauth2/token` endpoint.
```
implicit

: Issue the access token (and, optionally, ID token, based on scopes)
```
directly to your user.
```
client_credentials

: Issue the access token from the ‘/oauth2/token` endpoint directly to
```
a non-person user using a combination of the client ID and client
secret.
```
:allowed_o_auth_scopes (Array<String>) —

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with. Scopes govern access control to user pool self-service API operations, user data from the ‘userInfo` endpoint, and third-party APIs. Scope values include `phone`, `email`, `openid`, and `profile`. The `aws.cognito.signin.user.admin` scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.
:allowed_o_auth_flows_user_pool_client (Boolean) —
Set to ‘true` to use OAuth 2.0 authorization server features in your app client.

This parameter must have a value of ‘true` before you can configure the following features in your app client.
- ‘CallBackURLs`: Callback URLs.
- ‘LogoutURLs`: Sign-out redirect URLs.
- ‘AllowedOAuthScopes`: OAuth 2.0 scopes.
- ‘AllowedOAuthFlows`: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set ‘AllowedOAuthFlowsUserPoolClient` to `true` in a `CreateUserPoolClient` or `UpdateUserPoolClient` API request. If you don’t set a value for ‘AllowedOAuthFlowsUserPoolClient` in a request with the CLI or SDKs, it defaults to `false`. When `false`, only SDK-based API sign-in is permitted.
:analytics_configuration (Types::AnalyticsConfigurationType) —

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In Amazon Web Services Regions where Amazon Pinpoint isn’t available, user pools might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see [Using Amazon Pinpoint analytics].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html
:prevent_user_existence_errors (String) —

When ‘ENABLED`, suppresses messages that might indicate a valid user exists when someone attempts sign-in. This parameters sets your preference for the errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn’t exist in the user pool. When set to ‘ENABLED` and the user doesn’t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to ‘LEGACY`, those APIs return a `UserNotFoundException` exception if the user doesn’t exist in the user pool.

Defaults to ‘LEGACY`.
:enable_token_revocation (Boolean) —

Activates or deactivates [token revocation] in the target app client.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html
:enable_propagate_additional_user_context_data (Boolean) —

When ‘true`, your application can include additional `UserContextData` in authentication requests. This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see [Adding session data to API requests]. If you don’t include this parameter, you can’t send the source IP address to Amazon Cognito threat protection features. You can only activate ‘EnablePropagateAdditionalUserContextData` in an app client that has a client secret.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint
:auth_session_validity (Integer) —

Amazon Cognito creates a session token for each API request in an authentication flow. ‘AuthSessionValidity` is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
:refresh_token_rotation (Types::RefreshTokenRotationType) —

The configuration of your app client for refresh token rotation. When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.

Returns:

(Types::UpdateUserPoolClientResponse) —
Returns a response object which responds to the following methods:
- #user_pool_client => Types::UserPoolClientType

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 13267

def update_user_pool_client(params = {}, options = {})
  req = build_request(:update_user_pool_client, params)
  req.send_request(options)
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].

<note markdown=“1”> Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

**Learn more**

* [Signing Amazon Web Services API Requests][2]

Using the Amazon Cognito user pools API and user pool endpoints][3

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html [3]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.update_user_pool_domain({
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
  managed_login_version: 1,
  custom_domain_config: {
    certificate_arn: "ArnType", # required
  },
})

Response structure


resp.managed_login_version #=> Integer
resp.cloud_front_domain #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:domain (required, String) —

The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example ‘auth.example.com`. For prefix domains, this is the prefix alone, such as `myprefix`.
:user_pool_id (required, String) —

The ID of the user pool that is associated with the domain you’re updating.
:managed_login_version (Integer) —

A version number that indicates the state of managed login for your domain. Version ‘1` is hosted UI (classic). Version `2` is the newer managed login with the branding editor. For more information, see [Managed login].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html
:custom_domain_config (Types::CustomDomainConfigType) —

The configuration for a custom domain that hosts managed login for your application. In an ‘UpdateUserPoolDomain` request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in `us-east-1`.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

Returns:

(Types::UpdateUserPoolDomainResponse) —
Returns a response object which responds to the following methods:
- #managed_login_version => Integer
- #cloud_front_domain => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 13375

def update_user_pool_domain(params = {}, options = {})
  req = build_request(:update_user_pool_domain, params)
  req.send_request(options)
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.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.verify_software_token({
  access_token: "TokenModelType",
  session: "SessionType",
  user_code: "SoftwareTokenMFAUserCodeType", # required
  friendly_device_name: "StringType",
})

Response structure


resp.status #=> String, one of "SUCCESS", "ERROR"
resp.session #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:session (String) —

The session ID from an ‘AssociateSoftwareToken` request.
:user_code (required, String) —

A TOTP that the user generated in their configured authenticator app.
:friendly_device_name (String) —

A friendly name for the device that’s running the TOTP authenticator.

Returns:

(Types::VerifySoftwareTokenResponse) —
Returns a response object which responds to the following methods:
- #status => String
- #session => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 13436

def verify_software_token(params = {}, options = {})
  req = build_request(:verify_software_token, params)
  req.send_request(options)
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`.

<note markdown=“1”> Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see [Using the Amazon Cognito user pools API and user pool endpoints].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values


resp = client.verify_user_attribute({
  access_token: "TokenModelType", # required
  attribute_name: "AttributeNameType", # required
  code: "ConfirmationCodeType", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:access_token (required, String) —

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.
:attribute_name (required, String) —

The name of the attribute that you want to verify.
:code (required, String) —

The verification code that your user pool sent to the added or changed attribute, for example the user’s email address.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 13492

def verify_user_attribute(params = {}, options = {})
  req = build_request(:verify_user_attribute, params)
  req.send_request(options)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



13521
13522
13523

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 13521

def waiter_names
  []
end

Class: Aws::CognitoIdentityProvider::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#add_custom_attributes(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_add_user_to_group(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_confirm_sign_up(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_create_user(params = {}) ⇒ Types::AdminCreateUserResponse

Examples:

Example: An AdminCreateUser request for for a test user named John.

Request syntax with placeholder values

Response structure

#admin_delete_user(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_delete_user_attributes(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_disable_provider_for_user(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_disable_user(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_enable_user(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_forget_device(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_get_device(params = {}) ⇒ Types::AdminGetDeviceResponse

Examples:

Request syntax with placeholder values

Response structure

#admin_get_user(params = {}) ⇒ Types::AdminGetUserResponse

Examples:

Request syntax with placeholder values

Response structure

#admin_initiate_auth(params = {}) ⇒ Types::AdminInitiateAuthResponse

Examples:

Request syntax with placeholder values

Response structure

#admin_link_provider_for_user(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_list_devices(params = {}) ⇒ Types::AdminListDevicesResponse

Examples:

Request syntax with placeholder values

Response structure

#admin_list_groups_for_user(params = {}) ⇒ Types::AdminListGroupsForUserResponse

Examples:

Request syntax with placeholder values

Response structure

#admin_list_user_auth_events(params = {}) ⇒ Types::AdminListUserAuthEventsResponse

Examples:

Request syntax with placeholder values

Response structure

#admin_remove_user_from_group(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_reset_user_password(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#admin_respond_to_auth_challenge(params = {}) ⇒ Types::AdminRespondToAuthChallengeResponse

Examples:

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#add_custom_attributes(params = {}) ⇒ `Struct`

#admin_add_user_to_group(params = {}) ⇒ `Struct`

#admin_confirm_sign_up(params = {}) ⇒ `Struct`

#admin_create_user(params = {}) ⇒ `Types::AdminCreateUserResponse`

#admin_delete_user(params = {}) ⇒ `Struct`

#admin_delete_user_attributes(params = {}) ⇒ `Struct`

#admin_disable_provider_for_user(params = {}) ⇒ `Struct`

#admin_disable_user(params = {}) ⇒ `Struct`

#admin_enable_user(params = {}) ⇒ `Struct`

#admin_forget_device(params = {}) ⇒ `Struct`

#admin_get_device(params = {}) ⇒ `Types::AdminGetDeviceResponse`

#admin_get_user(params = {}) ⇒ `Types::AdminGetUserResponse`

#admin_initiate_auth(params = {}) ⇒ `Types::AdminInitiateAuthResponse`

#admin_link_provider_for_user(params = {}) ⇒ `Struct`

#admin_list_devices(params = {}) ⇒ `Types::AdminListDevicesResponse`

#admin_list_groups_for_user(params = {}) ⇒ `Types::AdminListGroupsForUserResponse`

#admin_list_user_auth_events(params = {}) ⇒ `Types::AdminListUserAuthEventsResponse`

#admin_remove_user_from_group(params = {}) ⇒ `Struct`

#admin_reset_user_password(params = {}) ⇒ `Struct`

#admin_respond_to_auth_challenge(params = {}) ⇒ `Types::AdminRespondToAuthChallengeResponse`

#admin_set_user_mfa_preference(params = {}) ⇒ `Struct`

#admin_set_user_password(params = {}) ⇒ `Struct`

#admin_set_user_settings(params = {}) ⇒ `Struct`

#admin_update_auth_event_feedback(params = {}) ⇒ `Struct`

#admin_update_device_status(params = {}) ⇒ `Struct`

#admin_update_user_attributes(params = {}) ⇒ `Struct`

#admin_user_global_sign_out(params = {}) ⇒ `Struct`

#associate_software_token(params = {}) ⇒ `Types::AssociateSoftwareTokenResponse`

#build_request(operation_name, params = {}) ⇒ `Object`

#change_password(params = {}) ⇒ `Struct`

#complete_web_authn_registration(params = {}) ⇒ `Struct`

#confirm_device(params = {}) ⇒ `Types::ConfirmDeviceResponse`

#confirm_forgot_password(params = {}) ⇒ `Struct`

#confirm_sign_up(params = {}) ⇒ `Types::ConfirmSignUpResponse`

#create_group(params = {}) ⇒ `Types::CreateGroupResponse`

#create_identity_provider(params = {}) ⇒ `Types::CreateIdentityProviderResponse`

#create_managed_login_branding(params = {}) ⇒ `Types::CreateManagedLoginBrandingResponse`

#create_resource_server(params = {}) ⇒ `Types::CreateResourceServerResponse`

#create_terms(params = {}) ⇒ `Types::CreateTermsResponse`

#create_user_import_job(params = {}) ⇒ `Types::CreateUserImportJobResponse`

#create_user_pool(params = {}) ⇒ `Types::CreateUserPoolResponse`