Class: Aws::CognitoIdentityProvider::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb

Overview

An API client for CognitoIdentityProvider. To construct a client, you need to configure a :region and :credentials.

client = Aws::CognitoIdentityProvider::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []]

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP)

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array)

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CognitoIdentityProvider::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CognitoIdentityProvider::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc)

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String)

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate)

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey)

    Sets a client key when creating http connections.

  • :ssl_timeout (Float)

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.



451
452
453
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 451

def initialize(*args)
  super
end

Instance Method Details

#add_custom_attributes(params = {}) ⇒ Struct

Adds additional user attributes to the user pool schema. Custom attributes can be mutable or immutable and have a custom: or dev: prefix. For more information, see Custom attributes.

You can also create custom attributes in the Schema parameter of CreateUserPool and UpdateUserPool. You can't delete custom attributes after you create them.

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

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:



558
559
560
561
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 558

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.

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

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 username 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:



613
614
615
616
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 613

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. Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation. No confirmation code is required.

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.

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

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

Examples:

Request syntax with placeholder values


resp = client.({
  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 username 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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



714
715
716
717
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 714

def (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 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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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.

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

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: "testuser@example.com", 
    }, 
  ], 
  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: "testuser@example.com", 
      }, 
    ], 
    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.

  • :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 call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. You can also do this by calling AdminUpdateUserAttributes.

    • email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter.

    • phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified 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 might perform external API operations like logging user attributes and validation data to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns to Amazon Cognito, like automatically confirming the user if they sign up from within your network.

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

  • :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. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.

    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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

See Also:



1062
1063
1064
1065
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1062

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.

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

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 username 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:



1110
1111
1112
1113
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1110

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 this attribute.

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

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 username 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:



1168
1169
1170
1171
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1168

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. See AdminLinkProviderForUser.

The ProviderName must match the value specified when creating an IdP for the pool.

To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.

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. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

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

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:



1249
1250
1251
1252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1249

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.

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

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 username 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:



1299
1300
1301
1302
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1299

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

#admin_enable_user(params = {}) ⇒ Struct

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

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

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 username 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:



1349
1350
1351
1352
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1349

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.

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

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 username 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. You can get device keys in the response to an AdminListDevices request.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1410
1411
1412
1413
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1410

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' device. For more information, see Working with devices.

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

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. You can get device IDs in the response to an AdminListDevices request.

  • :user_pool_id (required, String)

    The ID of the user pool where the device owner is a user.

  • :username (required, String)

    The username 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:

See Also:



1481
1482
1483
1484
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1481

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 the username, returns details about a user profile in a user pool. This operation contributes to your monthly active user (MAU) count for the purpose of billing. You can specify alias attributes in the Username parameter.

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

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 username 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:

See Also:



1560
1561
1562
1563
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1560

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.

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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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

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..device_key #=> String
resp.authentication_result..device_group_key #=> String

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 and their parameters.

    • USER_AUTH: 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.

    • REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value.

    • USER_SRP_AUTH: Receive secure remote password (SRP) variables for the next challenge, PASSWORD_VERIFIER, when you pass USERNAME and SRP_A parameters..

    • ADMIN_USER_PASSWORD_AUTH: Receive new tokens or the next challenge, for example SOFTWARE_TOKEN_MFA, when you pass USERNAME and PASSWORD parameters.

    All flows

    USER_AUTH

    The entry point for sign-in with passwords, one-time passwords, and WebAuthN authenticators.

    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.

    REFRESH_TOKEN_AUTH and REFRESH_TOKEN

    Provide a valid refresh token and receive new ID and access tokens. For more information, see Using the refresh token.

    CUSTOM_AUTH

    Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.

    ADMIN_USER_PASSWORD_AUTH

    Username-password authentication with the password sent directly in the request. For more information, see Admin authentication flow.

    USER_PASSWORD_AUTH is a flow type of InitiateAuth and isn't valid for AdminInitiateAuth.

  • :auth_parameters (Hash<String,String>)

    The authentication parameters. These are inputs corresponding to the AuthFlow that you're invoking. The required values depend on the value of AuthFlow:

    • For 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.

    • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

    • For ADMIN_USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

    • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY.

    • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

    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.

  • :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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

  • :analytics_metadata (Types::AnalyticsMetadataType)

    The analytics metadata for collecting Amazon Pinpoint metrics.

  • :context_data (Types::ContextDataType)

    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

  • :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:

See Also:



1859
1860
1861
1862
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1859

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

Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in. You can then use the federated user identity to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity. When the user signs in with a federated user identity, they sign in as the existing user account.

The maximum number of federated identities linked to a user is five.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external IdPs and provider attributes that have been trusted by the application owner.

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

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:



1980
1981
1982
1983
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 1980

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.

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

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 username 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:

See Also:



2063
2064
2065
2066
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2063

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.

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

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 username 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:

See Also:



2146
2147
2148
2149
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2146

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.

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

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 username 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:

See Also:



2241
2242
2243
2244
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2241

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.

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

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 username 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:



2300
2301
2302
2303
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2300

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

Resets the specified user's password in a user pool. This operation doesn't change the user's password, but sends a password-reset code. This operation is the administrative authentication API equivalent to ForgotPassword.

This operation deactivates a user's password, requiring them to change it. If a user tries to sign in after the API request, Amazon Cognito responds with a PasswordResetRequiredException error. Your app must then complete the forgot-password flow by prompting the user for their code and a new password, then submitting those values in a ConfirmForgotPassword request. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.

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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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

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 username 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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2431
2432
2433
2434
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2431

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.

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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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

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..device_key #=> String
resp.authentication_result..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. You can find more information about values for ChallengeName in the response parameters of AdminInitiateAuth.

  • :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.

    • "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]"}

    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]"}

    Add "DEVICE_KEY" when you sign in with a remembered device.

    CUSTOM_CHALLENGE

    "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}

    Add "DEVICE_KEY" when you sign in with a remembered device.

    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.

    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

    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 or 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.

  • :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)

    The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.

  • :context_data (Types::ContextDataType)

    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

  • :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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

See Also:



2783
2784
2785
2786
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2783

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.

This operation doesn't reset an existing TOTP MFA for a user. To register a new TOTP factor for a user, make an AssociateSoftwareToken request. For more information, see TOTP software token MFA.

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

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.

  • :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, advanced security features must be active in your user pool.

  • :username (required, String)

    The username 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:



2876
2877
2878
2879
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2876

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.

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

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 username 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:



2970
2971
2972
2973
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 2970

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. To configure either type of MFA, use AdminSetUserMFAPreference instead.

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

Examples:

Request syntax with placeholder values


resp = client.({
  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 username 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:



3033
3034
3035
3036
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3033

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

#admin_update_auth_event_feedback(params = {}) ⇒ Struct

Provides feedback for an authentication event indicating if it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. 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.

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

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 username 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 authentication event ID. To query authentication events for a user, see AdminListUserAuthEvents.

  • :feedback_value (required, String)

    The authentication event feedback value. 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:



3107
3108
3109
3110
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3107

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.

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

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 username 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:



3174
3175
3176
3177
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3174

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

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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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 prepend the custom: prefix to the attribute name.

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.

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

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 username 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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3323
3324
3325
3326
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3323

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

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

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 username 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:



3402
3403
3404
3405
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3402

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.

Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs in. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.

After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.

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.

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.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 user whose software token you want to generate. 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:

See Also:



3478
3479
3480
3481
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3478

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

#change_password(params = {}) ⇒ Struct

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

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

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.

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:



3528
3529
3530
3531
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3528

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 current user. Your application provides data from a successful registration request with the data from the output of a StartWebAuthnRegistration.

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 user whose passkey registration you want to complete.

  • :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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3576
3577
3578
3579
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3576

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.

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.

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 user whose device you want to confirm.

  • :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:

See Also:



3643
3644
3645
3646
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3643

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.

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.

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' passwords for all app clients in 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.

  • :username (required, String)

    The username 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 an AdminResetUserPassword or a ForgotPassword request.

  • :password (required, String)

    The new password that your user wants to set.

  • :analytics_metadata (Types::AnalyticsMetadataType)

    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

  • :user_context_data (Types::UserContextDataType)

    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

  • :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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3780
3781
3782
3783
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3780

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

#confirm_sign_up(params = {}) ⇒ Types::ConfirmSignUpResponse

This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation. 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. Administrator-created users, users created with the AdminCreateUser API operation, confirm their accounts when they respond to their invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a temporary password.

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.

Examples:

Request syntax with placeholder values


resp = client.({
  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.

  • :username (required, String)

    The username 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 bob@example.com and email is an alias in your user pool. If the new user also has an email of bob@example.com and your ConfirmSignUp response sets ForceAliasCreation to true, the new user can sign in with a username of bob@example.com 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.

  • :analytics_metadata (Types::AnalyticsMetadataType)

    The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

  • :user_context_data (Types::UserContextDataType)

    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

  • :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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

  • :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:

See Also:



3956
3957
3958
3959
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 3956

def (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.

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

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:

See Also:



4049
4050
4051
4052
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4049

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.

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

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.

  • :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.

Returns:

See Also:



4270
4271
4272
4273
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4270

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 designer.

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.

As a best practice, modify the output of DescribeManagedLoginBrandingByClient into the request parameters for this operation. To get all settings, set ReturnMergedResources to true. For more information, see API and SDK operations for managed login branding.

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

Examples:

Request syntax with placeholder values


resp = client.({
  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.. #=> String
resp..user_pool_id #=> String
resp..use_cognito_provided_values #=> Boolean
resp..assets #=> Array
resp..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..assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp..assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp..assets[0].bytes #=> String
resp..assets[0].resource_id #=> String
resp..creation_date #=> Time
resp..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 permanently linked to an app client. To change the style for an app client, delete the existing style with DeleteManagedLoginBranding and create a new one.

  • :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 designer.

    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.

    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.

  • :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:

See Also:



4396
4397
4398
4399
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4396

def (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.

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

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 https://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:

See Also:



4478
4479
4480
4481
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4478

def create_resource_server(params = {}, options = {})
  req = build_request(:create_resource_server, 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. To generate a template for your import, see GetCSVHeader. To learn more about CSV import, see Importing users from a CSV file.

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

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:

See Also:



4552
4553
4554
4555
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 4552

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

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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration options. You can create a user pool in the Amazon Cognito console to your preferences and use the output of DescribeUserPool to generate requests from that baseline.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

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

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: "support@example.com", 
    reply_to_email_address: "support@example.com", 
    source_arn: "arn:aws:ses:us-east-1:123456789012:identity/support@example.com", 
  }, 
  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: "support@example.com", 
      reply_to_email_address: "support@example.com", 
      source_arn: "arn:aws:ses:us-east-1:123456789012:identity/support@example.com", 
    }, 
    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
      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..allowed_first_auth_factors #=> Array
resp.user_pool.policies..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. #=> 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"
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. #=> 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. #=> 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..recovery_mechanisms #=> Array
resp.user_pool..recovery_mechanisms[0].priority #=> Integer
resp.user_pool..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 friendlhy 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.

  • :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.

  • :alias_attributes (Array<String>)

    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. For more information about alias attributes, see Customizing sign-in attributes.

  • :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.

  • :sms_verification_message (String)

    This parameter is no longer used. See VerificationMessageTemplateType.

  • :email_verification_message (String)

    This parameter is no longer used. See VerificationMessageTemplateType.

  • :email_verification_subject (String)

    This parameter is no longer used. See VerificationMessageTemplateType.

  • :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)

    A string representing the SMS authentication message.

  • :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.

  • :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.

  • :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.

    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more infor

  • :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 SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through 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.

  • :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 AdminCreateUser requests. 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.

  • :user_pool_add_ons (Types::UserPoolAddOnsType)

    User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

    For more information, see Adding advanced security to a user pool.

  • :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@example.com or EMaiL@eXamplE.Com. 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. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

  • :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.

Returns:

See Also:



5517
5518
5519
5520
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 5517

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. You can create an app client in the Amazon Cognito console to your preferences and use the output of DescribeUserPoolClient to generate requests from that baseline.

New app clients activate token revocation by default. For more information about revoking tokens, see RevokeToken.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

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

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,
})

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

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. For more information, see 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. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.

    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. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.

    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.

  • :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.

    If you don't specify a value for ExplicitAuthFlows, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

    Valid values include:

    • 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.

    • 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.

  • :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 setting applies to providers that you can access with managed login. 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 API-based authentication is to block access with a WAF rule.

  • :callback_urls (Array<String>)

    A list of allowed redirect (callback) URLs for the IdPs.

    A redirect URI must:

    • 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 http://localhost for testing purposes only.

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

  • :logout_urls (Array<String>)

    A list of allowed logout URLs for managed login authentication. For more information, see Logout endpoint.

  • :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 2.0 scopes that you want to permit your app client to authorize. Scopes govern access control to user pool self-service API operations, user data from the userInfo endpoint, and third-party APIs. Possible values provided by OAuth are phone, email, openid, and profile. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

  • :allowed_o_auth_flows_user_pool_client (Boolean)

    Set to true to use OAuth 2.0 features in your user pool app client.

    AllowedOAuthFlowsUserPoolClient must be 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 OAuth 2.0 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.

  • :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.

  • :prevent_user_existence_errors (String)

    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.

    Valid values include:

    • ENABLED - This prevents user existence-related errors.

    • LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

    Defaults to LEGACY when you don't provide a value.

  • :enable_token_revocation (Boolean)

    Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.

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

  • :enable_propagate_additional_user_context_data (Boolean)

    Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

  • :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.

Returns:

See Also:



6109
6110
6111
6112
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6109

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

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

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. #=> 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 other than Lite.

  • :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 exclude this parameter and use a prefix domain instead.

    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

Returns:

See Also:



6210
6211
6212
6213
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6210

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.

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

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:



6259
6260
6261
6262
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6259

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.

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

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:



6308
6309
6310
6311
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6308

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.

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

Examples:

Request syntax with placeholder values


resp = client.({
  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:



6357
6358
6359
6360
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6357

def (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.

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

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:



6408
6409
6410
6411
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6408

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

#delete_user(params = {}) ⇒ Struct

Self-deletes a user profile. 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.

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.

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 user whose user profile you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6448
6449
6450
6451
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6448

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

#delete_user_attributes(params = {}) ⇒ Struct

Self-deletes attributes for a 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.

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.

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 user whose attributes you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6497
6498
6499
6500
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6497

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.

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:



6520
6521
6522
6523
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6520

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:



6547
6548
6549
6550
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6547

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, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

  • :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:



6577
6578
6579
6580
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6577

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.

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.

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 user whose passkey credential you want to delete.

  • :credential_id (required, String)

    The unique identifier of the passkey that you want to delete. Look up registered devices with ListWebAuthnCredentials.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



6626
6627
6628
6629
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6626

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:

See Also:



6669
6670
6671
6672
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6669

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.({
  user_pool_id: "UserPoolIdType", # required
  managed_login_branding_id: "ManagedLoginBrandingIdType", # required
  return_merged_resources: false,
})

Response structure


resp.. #=> String
resp..user_pool_id #=> String
resp..use_cognito_provided_values #=> Boolean
resp..assets #=> Array
resp..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..assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp..assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp..assets[0].bytes #=> String
resp..assets[0].resource_id #=> String
resp..creation_date #=> Time
resp..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:

See Also:



6721
6722
6723
6724
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6721

def (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.({
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  return_merged_resources: false,
})

Response structure


resp.. #=> String
resp..user_pool_id #=> String
resp..use_cognito_provided_values #=> Boolean
resp..assets #=> Array
resp..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..assets[0].color_mode #=> String, one of "LIGHT", "DARK", "DYNAMIC"
resp..assets[0].extension #=> String, one of "ICO", "JPEG", "PNG", "SVG", "WEBP"
resp..assets[0].bytes #=> String
resp..assets[0].resource_id #=> String
resp..creation_date #=> Time
resp..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:

See Also:



6773
6774
6775
6776
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6773

def (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.

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 https://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:

See Also:



6822
6823
6824
6825
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6822

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.

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..notify_configuration.from #=> String
resp.risk_configuration..notify_configuration.reply_to #=> String
resp.risk_configuration..notify_configuration.source_arn #=> String
resp.risk_configuration..notify_configuration.block_email.subject #=> String
resp.risk_configuration..notify_configuration.block_email.html_body #=> String
resp.risk_configuration..notify_configuration.block_email.text_body #=> String
resp.risk_configuration..notify_configuration.no_action_email.subject #=> String
resp.risk_configuration..notify_configuration.no_action_email.html_body #=> String
resp.risk_configuration..notify_configuration.no_action_email.text_body #=> String
resp.risk_configuration..notify_configuration.mfa_email.subject #=> String
resp.risk_configuration..notify_configuration.mfa_email.html_body #=> String
resp.risk_configuration..notify_configuration.mfa_email.text_body #=> String
resp.risk_configuration..actions.low_action.notify #=> Boolean
resp.risk_configuration..actions.low_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration..actions.medium_action.notify #=> Boolean
resp.risk_configuration..actions.medium_action.event_action #=> String, one of "BLOCK", "MFA_IF_CONFIGURED", "MFA_REQUIRED", "NO_ACTION"
resp.risk_configuration..actions.high_action.notify #=> Boolean
resp.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:

See Also:



6897
6898
6899
6900
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6897

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

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:

See Also:



6946
6947
6948
6949
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 6946

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.

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

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..allowed_first_auth_factors #=> Array
resp.user_pool.policies..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. #=> 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"
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. #=> 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. #=> 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..recovery_mechanisms #=> Array
resp.user_pool..recovery_mechanisms[0].priority #=> Integer
resp.user_pool..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:

See Also:



7084
7085
7086
7087
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7084

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.

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

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

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:

See Also:



7177
7178
7179
7180
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7177

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.

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

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. #=> 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. #=> 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:

See Also:



7234
7235
7236
7237
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7234

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

#forget_device(params = {}) ⇒ Struct

Forgets the specified device. 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.

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.

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 user whose registered device you want to forget.

  • :device_key (required, String)

    The device key.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



7279
7280
7281
7282
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7279

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

#forgot_password(params = {}) ⇒ Types::ForgotPasswordResponse

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

If neither a verified phone number nor a verified email exists, this API returns InvalidParameterException. If your app client has a client secret and you don't provide a SECRET_HASH parameter, this API returns NotAuthorizedException.

To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.

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.

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 sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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

  • :user_context_data (Types::UserContextDataType)

    Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

  • :username (required, String)

    The username 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)

    The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

  • :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 Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

    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.

Returns:

See Also:



7448
7449
7450
7451
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7448

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

#get_csv_header(params = {}) ⇒ Types::GetCSVHeaderResponse

Gets the header information for the comma-separated value (CSV) file to be used as input for the user import job.

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 the users are to be imported into.

Returns:

See Also:



7480
7481
7482
7483
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7480

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

#get_device(params = {}) ⇒ Types::GetDeviceResponse

Gets the device. 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.

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.

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 device key.

  • :access_token (String)

    A valid access token that Amazon Cognito issued to the user whose device information you want to request.

Returns:

See Also:



7537
7538
7539
7540
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7537

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

#get_group(params = {}) ⇒ Types::GetGroupResponse

Gets a group.

Calling this action requires developer credentials.

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.

  • :user_pool_id (required, String)

    The ID of the user pool.

Returns:

See Also:



7577
7578
7579
7580
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7577

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

#get_identity_provider_by_identifier(params = {}) ⇒ Types::GetIdentityProviderByIdentifierResponse

Gets the specified IdP.

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 user pool ID.

  • :idp_identifier (required, String)

    The IdP identifier.

Returns:

See Also:



7619
7620
7621
7622
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7619

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

Gets the logging configuration of a user pool.

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:

See Also:



7654
7655
7656
7657
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7654

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

This method takes a user pool ID, and returns the signing certificate. The issued certificate is valid for 10 years from the date of issue.

Amazon Cognito issues and assigns a new signing certificate annually. This process returns a new value in the response to GetSigningCertificate, but doesn't invalidate the original certificate.

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 user pool ID.

Returns:

See Also:



7688
7689
7690
7691
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7688

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

#get_ui_customization(params = {}) ⇒ Types::GetUICustomizationResponse

Gets the user interface (UI) Customization information for a particular app client's app UI, if any such information exists for the client. If nothing is set for the particular client, but there is an existing pool level customization (the app clientId is ALL), then that information is returned. If nothing is present, then an empty shape is returned.

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.

  • :client_id (String)

    The client ID for the client app.

Returns:

See Also:



7731
7732
7733
7734
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/client.rb', line 7731

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

#get_user(params = {}) ⇒ Types::GetUserResponse

Gets the user attributes and metadata for a user.

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

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.username #=> String
resp.user_attributes