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.
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.
For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.
For more information see Amazon Cognito Federated Identities.
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.UpdateUserPool' paths: /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPool: 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: UpdateUserPool description:Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value.
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 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.
The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, 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 ExternalID. 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 ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your user pool, or a supported Legacy Amazon SNS alternate Region.
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 SMS message settings for Amazon Cognito user pools.
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. InvalidSmsRoleTrustRelationshipException: {} VerifiedAttributesListType: type: array items: $ref: '#/components/schemas/VerifiedAttributeType' AdminCreateUserUnusedAccountValidityDaysType: type: integer minimum: 0 maximum: 365 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: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.
You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the UpdateUserAttributes or AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.
When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.
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.
InvalidParameterException: {}
RegionCodeType:
type: string
minLength: 5
maxLength: 32
EmailVerificationSubjectByLinkType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+'
minLength: 1
maxLength: 140
AccountRecoverySettingType:
type: object
properties:
RecoveryMechanisms:
allOf:
- $ref: '#/components/schemas/RecoveryMechanismsType'
- description: The list of RecoveryOptionTypes.
description: The data type for AccountRecoverySetting.
EmailAddressType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+@[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
DefaultEmailOptionType:
type: string
enum:
- CONFIRM_WITH_LINK
- CONFIRM_WITH_CODE
InternalErrorException: {}
DeviceConfigurationType:
type: object
properties:
ChallengeRequiredOnNewDevice:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: 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).
Whether or not ChallengeRequiredOnNewDevice 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.
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.
The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to remembered or not_remembered.
To sign in with a remembered device, include DEVICE_KEY in the authentication parameters in your user's InitiateAuth request. If your app doesn't include a DEVICE_KEY parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY values under NewDeviceMetadata. Store these values to use in future device-authentication requests.
When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.
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.
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.
MfaConfiguration:
allOf:
- $ref: '#/components/schemas/UserPoolMfaType'
- description: Possible values include:
OFF - MFA tokens aren't required and can't be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
OPTIONAL - Users have the option when registering to create an MFA token.
The device-remembering configuration for a 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.
AdminCreateUser requests.
UserPoolAddOns:
allOf:
- $ref: '#/components/schemas/UserPoolAddOnsType'
- description: Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
AccountRecoverySetting:
allOf:
- $ref: '#/components/schemas/AccountRecoverySettingType'
- description: 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.
description: Represents the request to update the user pool.
EmailVerificationMessageType:
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*]*'
minLength: 6
maxLength: 20000
VerifiedAttributeType:
type: string
enum:
- phone_number
- email
TemporaryPasswordValidityDaysType:
type: integer
minimum: 0
maximum: 365
RecoveryOptionType:
type: object
required:
- Priority
- Name
properties:
Priority:
allOf:
- $ref: '#/components/schemas/PriorityType'
- description: A positive integer specifying priority of a method with 1 being the highest priority.
Name:
allOf:
- $ref: '#/components/schemas/RecoveryOptionNameType'
- description: The recovery method for a user.
description: A map containing a priority as a key, and recovery method name as a value.
AdminCreateUserConfigType:
type: object
properties:
AllowAdminCreateUserOnly:
allOf:
- $ref: '#/components/schemas/BooleanType'
- description: Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
UnusedAccountValidityDays:
allOf:
- $ref: '#/components/schemas/AdminCreateUserUnusedAccountValidityDaysType'
- description: 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 AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.
If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
description: The configuration for creating a new user profile. PriorityType: type: integer minimum: 1 maximum: 2 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: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.
When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.
CustomEmailSender and CustomSMSSender.
description: Specifies the configuration for Lambda triggers.
CustomSMSLambdaVersionConfigType:
type: object
required:
- LambdaVersion
- LambdaArn
properties:
LambdaVersion:
allOf:
- $ref: '#/components/schemas/CustomSMSSenderLambdaVersionType'
- description: Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.
LambdaArn:
allOf:
- $ref: '#/components/schemas/ArnType'
- description: The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
description: A custom SMS sender Lambda configuration type.
PasswordPolicyMinLengthType:
type: integer
minimum: 6
maximum: 99
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 EmailSendingAccount is DEVELOPER. '
EmailSubject:
allOf:
- $ref: '#/components/schemas/EmailVerificationSubjectType'
- description: 'The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER. '
description: The message template structure.
UserPoolTagsType:
type: object
additionalProperties:
$ref: '#/components/schemas/TagValueType'
UserPoolIdType:
type: string
pattern: '[\w-]+_[0-9a-zA-Z]+'
minLength: 1
maxLength: 55
BooleanType:
type: boolean
UserPoolTaggingException: {}
CustomEmailSenderLambdaVersionType:
type: string
enum:
- V1_0
ArnType:
type: string
pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
minLength: 20
maxLength: 2048
EmailVerificationSubjectType:
type: string
pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+'
minLength: 1
maxLength: 140
AdvancedSecurityModeType:
type: string
enum:
- false
- AUDIT
- ENFORCED
InvalidEmailRoleAccessPolicyException: {}
UserImportInProgressException: {}
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 EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, 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 EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, 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 EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, 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 EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, 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.
ConcurrentModificationException: {}
UserPoolPolicyType:
type: object
properties:
PasswordPolicy:
allOf:
- $ref: '#/components/schemas/PasswordPolicyType'
- description: The password policy.
description: The policy associated with a user pool.
EmailConfigurationType:
type: object
properties:
SourceArn:
allOf:
- $ref: '#/components/schemas/ArnType'
- description: The ARN of a verified email address in Amazon SES. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.
If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer Guide.
Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:
When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.
To look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer Guide.
The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email address for the SourceArn parameter.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your Amazon Web Services account.
If you use this option, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of role in your Amazon Web Services account. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.
ConfigurationSet:
allOf:
- $ref: '#/components/schemas/SESConfigurationSet'
- description: 'The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails:
Amazon Simple Email Service can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other Amazon Web Services services such as and Amazon CloudWatch
When leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
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.
Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.
V1_0.
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
UpdateUserPoolResponse:
type: object
properties: {}
description: Represents the response from the server when you make a request to update the user pool.
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/cognito-identity/
x-hasEquivalentPaths: true