openapi: 3.0.0
info:
version: 2014-06-30
x-release: v4
title: 'Amazon Cognito Identity #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.DescribeUserPool API'
description: <fullname>Amazon Cognito Federated Identities</fullname> <p>Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p> <p>Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p> <p>For a description of the authentication flow from the Amazon Cognito Developer Guide see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p> <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: cognito-identity
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://cognito-identity.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Cognito Identity multi-region endpoint
- url: https://cognito-identity.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Cognito Identity multi-region endpoint
- url: http://cognito-identity.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-identity.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.DescribeUserPool'
paths:
/#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPool:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeUserPool
description: Returns the configuration information and metadata of the specified user pool.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserPoolResponse'
examples:
DescribeUserPool200Example:
summary: Default DescribeUserPool 200 response
x-microcks-default: true
value:
UserPool: example-value
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DescribeUserPool480Example:
summary: Default DescribeUserPool 480 response
x-microcks-default: true
value: example
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
examples:
DescribeUserPool481Example:
summary: Default DescribeUserPool 481 response
x-microcks-default: true
value: example
'482':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
DescribeUserPool482Example:
summary: Default DescribeUserPool 482 response
x-microcks-default: true
value: example
'483':
description: NotAuthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/NotAuthorizedException'
examples:
DescribeUserPool483Example:
summary: Default DescribeUserPool 483 response
x-microcks-default: true
value: example
'484':
description: UserPoolTaggingException
content:
application/json:
schema:
$ref: '#/components/schemas/UserPoolTaggingException'
examples:
DescribeUserPool484Example:
summary: Default DescribeUserPool 484 response
x-microcks-default: true
value: example
'485':
description: InternalErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalErrorException'
examples:
DescribeUserPool485Example:
summary: Default DescribeUserPool 485 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserPoolRequest'
examples:
DescribeUserPoolRequestExample:
summary: Default DescribeUserPool request
x-microcks-default: true
value:
UserPoolId: us-east-1_AbCdEfGhI
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSCognitoIdentityProviderService.DescribeUserPool
summary: Amazon Cognito Describe User Pool
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=AWSCognitoIdentityProviderService.DescribeUserPool'
components:
schemas:
ResourceNotFoundException: {}
NumberAttributeConstraintsType:
type: object
properties:
MinValue:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The minimum value of an attribute that is of the number data type.
MaxValue:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The maximum value of an attribute that is of the number data type.
description: The minimum and maximum values of an attribute that is of the number data type.
UserPoolAddOnsType:
type: object
required:
- AdvancedSecurityMode
properties:
AdvancedSecurityMode:
allOf:
- $ref: '#/components/schemas/AdvancedSecurityModeType'
- description: The advanced security mode.
description: The user pool add-ons type.
UserPoolNameType:
type: string
pattern: '[\w\s+=,.@-]+'
minLength: 1
maxLength: 128
DateType:
type: string
format: date-time
EmailAddressType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
InternalErrorException: {}
AttributesRequireVerificationBeforeUpdateType:
type: array
items:
$ref: '#/components/schemas/VerifiedAttributeType'
StringType:
type: string
SESConfigurationSet:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 64
IntegerType:
type: integer
TemporaryPasswordValidityDaysType:
type: integer
minimum: 0
maximum: 365
SchemaAttributeType:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/CustomAttributeNameType'
- description: A schema attribute of the name type.
AttributeDataType:
allOf:
- $ref: '#/components/schemas/AttributeDataType'
- description: The attribute data type.
DeveloperOnlyAttribute:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: <note> <p>You should use <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes">WriteAttributes</a> in the user pool client to control how attributes can be mutated for new use cases instead of using <code>DeveloperOnlyAttribute</code>.</p> </note> <p>Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example, <code>DeveloperOnlyAttribute</code> can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.</p>
Mutable:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: <p>Specifies whether the value of the attribute can be changed.</p> <p>For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to <code>true</code>. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying Identity Provider Attribute Mappings for Your User Pool</a>.</p>
Required:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
NumberAttributeConstraints:
allOf:
- $ref: '#/components/schemas/NumberAttributeConstraintsType'
- description: Specifies the constraints for an attribute of the number type.
StringAttributeConstraints:
allOf:
- $ref: '#/components/schemas/StringAttributeConstraintsType'
- description: Specifies the constraints for an attribute of the string type.
description: Contains information about the schema attribute.
PasswordPolicyMinLengthType:
type: integer
minimum: 6
maximum: 99
UserPoolTagsType:
type: object
additionalProperties:
$ref: '#/components/schemas/TagValueType'
UserPoolIdType:
type: string
pattern: '[\w-]+_[0-9a-zA-Z]+'
minLength: 1
maxLength: 55
UsernameAttributesListType:
type: array
items:
$ref: '#/components/schemas/UsernameAttributeType'
UserPoolTaggingException: {}
AdvancedSecurityModeType:
type: string
enum:
- false
- AUDIT
- ENFORCED
UsernameConfigurationType:
type: object
required:
- CaseSensitive
properties:
CaseSensitive:
allOf:
- $ref: '#/components/schemas/WrappedBooleanType'
- description: <p>Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.</p> <p>Valid values include:</p> <dl> <dt>True</dt> <dd> <p>Enables case sensitivity for all username input. When this option is set to <code>True</code>, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.</p> </dd> <dt>False</dt> <dd> <p>Enables case insensitivity for all username input. For example, when this option is set to <code>False</code>, users can sign in using either "username" or "Username". This option also enables both <code>preferred_username</code> and <code>email</code> alias to be case insensitive, in addition to the <code>username</code> attribute.</p> </dd> </dl>
description: 'The username configuration type. '
UsernameAttributeType:
type: string
enum:
- phone_number
- email
VerificationMessageTemplateType:
type: object
properties:
SmsMessage:
allOf:
- $ref: '#/components/schemas/SmsVerificationMessageType'
- description: The template for SMS messages that Amazon Cognito sends to your users.
EmailMessage:
allOf:
- $ref: '#/components/schemas/EmailVerificationMessageType'
- description: The template for email messages that Amazon Cognito sends to your users. You can set an <code>EmailMessage</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
EmailSubject:
allOf:
- $ref: '#/components/schemas/EmailVerificationSubjectType'
- description: The subject line for the email message template. You can set an <code>EmailSubject</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
EmailMessageByLink:
allOf:
- $ref: '#/components/schemas/EmailVerificationMessageByLinkType'
- description: The email message template for sending a confirmation link to the user. You can set an <code>EmailMessageByLink</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
EmailSubjectByLink:
allOf:
- $ref: '#/components/schemas/EmailVerificationSubjectByLinkType'
- description: The subject line for the email message template for sending a confirmation link to the user. You can set an <code>EmailSubjectByLink</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
DefaultEmailOption:
allOf:
- $ref: '#/components/schemas/DefaultEmailOptionType'
- description: The default email option.
description: The template for verification messages.
EmailVerificationMessageByLinkType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{##[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*'
minLength: 6
maxLength: 20000
SmsConfigurationType:
type: object
required:
- SnsCallerArn
properties:
SnsCallerArn:
allOf:
- $ref: '#/components/schemas/ArnType'
- description: 'The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS messages are subject to a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html">spending limit</a>. '
ExternalId:
allOf:
- $ref: '#/components/schemas/StringType'
- description: <p>The external ID provides additional security for your IAM role. You can use an <code>ExternalId</code> with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an <code>ExternalId</code>, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the <code>ExternalID</code>. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the <code>ExternalId</code>.</p> <p>For more information about the <code>ExternalId</code> of a role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to use an external ID when granting access to your Amazon Web Services resources to a third party</a> </p>
SnsRegion:
allOf:
- $ref: '#/components/schemas/RegionCodeType'
- description: <p>The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported <b>Legacy Amazon SNS alternate Region</b>. </p> <p> Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS configuration in the Asia Pacific (Tokyo) Region. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings for Amazon Cognito user pools</a>.</p>
description: The SMS configuration type is 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.
AdminCreateUserUnusedAccountValidityDaysType:
type: integer
minimum: 0
maximum: 365
DefaultEmailOptionType:
type: string
enum:
- CONFIRM_WITH_LINK
- CONFIRM_WITH_CODE
NotAuthorizedException: {}
AdminCreateUserConfigType:
type: object
properties:
AllowAdminCreateUserOnly:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: Set to <code>True</code> if only the administrator is allowed to create user profiles. Set to <code>False</code> if users can sign themselves up via an app.
UnusedAccountValidityDays:
allOf:
- $ref: '#/components/schemas/AdminCreateUserUnusedAccountValidityDaysType'
- description: <p>The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter. The default value for this parameter is 7. </p> <note> <p>If you set a value for <code>TemporaryPasswordValidityDays</code> in <code>PasswordPolicy</code>, that value will be used, and <code>UnusedAccountValidityDays</code> will be no longer be an available parameter for that user pool.</p> </note>
InviteMessageTemplate:
allOf:
- $ref: '#/components/schemas/MessageTemplateType'
- description: <p>The message template to be used for the welcome message to new users.</p> <p>See also <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization">Customizing User Invitation Messages</a>.</p>
description: The configuration for creating a new user profile.
DeletionProtectionType:
type: string
enum:
- ACTIVE
- INACTIVE
PasswordPolicyType:
type: object
properties:
MinimumLength:
allOf:
- $ref: '#/components/schemas/PasswordPolicyMinLengthType'
- description: The minimum length of the password in the policy that you have set. This value can't be less than 6.
RequireUppercase:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
RequireLowercase:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
RequireNumbers:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
RequireSymbols:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
TemporaryPasswordValidityDays:
allOf:
- $ref: '#/components/schemas/TemporaryPasswordValidityDaysType'
- description: <p>The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password.</p> <note> <p>When you set <code>TemporaryPasswordValidityDays</code> for a user pool, you can no longer set a value for the legacy <code>UnusedAccountValidityDays</code> parameter in that user pool.</p> </note>
description: The password policy type.
MessageTemplateType:
type: object
properties:
SMSMessage:
allOf:
- $ref: '#/components/schemas/SmsVerificationMessageType'
- description: The message template for SMS messages.
EmailMessage:
allOf:
- $ref: '#/components/schemas/EmailVerificationMessageType'
- description: 'The message template for email messages. EmailMessage is allowed only if <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is DEVELOPER. '
EmailSubject:
allOf:
- $ref: '#/components/schemas/EmailVerificationSubjectType'
- description: 'The subject line for email messages. EmailSubject is allowed only if <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is DEVELOPER. '
description: The message template structure.
BooleanType:
type: boolean
CustomEmailSenderLambdaVersionType:
type: string
enum:
- V1_0
ArnType:
type: string
pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
minLength: 20
maxLength: 2048
DescribeUserPoolRequest:
type: object
required:
- UserPoolId
title: DescribeUserPoolRequest
properties:
UserPoolId:
allOf:
- $ref: '#/components/schemas/UserPoolIdType'
- description: The user pool ID for the user pool you want to describe.
description: Represents the request to describe the user pool.
UserPoolPolicyType:
type: object
properties:
PasswordPolicy:
allOf:
- $ref: '#/components/schemas/PasswordPolicyType'
- description: The password policy.
description: The policy associated with a user pool.
StringAttributeConstraintsType:
type: object
properties:
MinLength:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The minimum length.
MaxLength:
allOf:
- $ref: '#/components/schemas/StringType'
- description: The maximum length.
description: The constraints associated with a string attribute.
CustomEmailLambdaVersionConfigType:
type: object
required:
- LambdaVersion
- LambdaArn
properties:
LambdaVersion:
allOf:
- $ref: '#/components/schemas/CustomEmailSenderLambdaVersionType'
- description: Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is <code>V1_0</code>.
LambdaArn:
allOf:
- $ref: '#/components/schemas/ArnType'
- description: The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
description: A custom email sender Lambda configuration type.
EmailSendingAccountType:
type: string
enum:
- COGNITO_DEFAULT
- DEVELOPER
UserPoolMfaType:
type: string
enum:
- false
- true
- OPTIONAL
VerifiedAttributesListType:
type: array
items:
$ref: '#/components/schemas/VerifiedAttributeType'
RecoveryMechanismsType:
type: array
items:
$ref: '#/components/schemas/RecoveryOptionType'
minItems: 1
maxItems: 2
SmsVerificationMessageType:
type: string
pattern: .*\{####\}.*
minLength: 6
maxLength: 140
UserAttributeUpdateSettingsType:
type: object
properties:
AttributesRequireVerificationBeforeUpdate:
allOf:
- $ref: '#/components/schemas/AttributesRequireVerificationBeforeUpdateType'
- description: <p>Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.</p> <p>You can verify an updated email address or phone number with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html">VerifyUserAttribute</a> API request. You can also call the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a> API and set <code>email_verified</code> or <code>phone_number_verified</code> to true.</p> <p>When <code>AttributesRequireVerificationBeforeUpdate</code> is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where <code>AttributesRequireVerificationBeforeUpdate</code> is false, API operations that change attribute values can immediately update a user’s <code>email</code> or <code>phone_number</code> attribute.</p>
description: The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, 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 <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.
DeviceConfigurationType:
type: object
properties:
ChallengeRequiredOnNewDevice:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: <p>When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).</p> <note> <p>Whether or not <code>ChallengeRequiredOnNewDevice</code> is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.</p> </note>
DeviceOnlyRememberedOnUserPrompt:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: <p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html"> ConfirmDevice</a> API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's ch
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/openapi/aws-cognito-x-amz-target-awscognitoidentityproviderservice-describeuserpool-api-openapi.yml