openapi: 3.0.0 info: version: 2016-04-18 x-release: v4 title: Amazon Cognito Identity Provider description:
Using the Amazon Cognito user pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito user pools.
For more information, see the Amazon Cognito Documentation.
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-idp x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-idp-2016-04-18.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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/cognito-idp/ servers: - url: http://cognito-idp.{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 Provider multi-region endpoint - url: https://cognito-idp.{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 Provider multi-region endpoint - url: http://cognito-idp.{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 Provider endpoint for China (Beijing) and China (Ningxia) - url: https://cognito-idp.{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 Provider endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /#X-Amz-Target=AWSCognitoIdentityProviderService.AddCustomAttributes: post: operationId: AddCustomAttributes description: Adds additional user attributes to the user pool schema. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AddCustomAttributesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AddCustomAttributes480Example: summary: Default AddCustomAttributes 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AddCustomAttributes481Example: summary: Default AddCustomAttributes 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AddCustomAttributes482Example: summary: Default AddCustomAttributes 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AddCustomAttributes483Example: summary: Default AddCustomAttributes 483 response x-microcks-default: true value: example "484": description: UserImportInProgressException content: application/json: schema: $ref: "#/components/schemas/UserImportInProgressException" examples: AddCustomAttributes484Example: summary: Default AddCustomAttributes 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AddCustomAttributes485Example: summary: Default AddCustomAttributes 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AddCustomAttributesRequest" examples: AddCustomAttributesRequestExample: summary: Default AddCustomAttributes request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI CustomAttributes: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AddCustomAttributes summary: Amazon Cognito Add Custom Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminAddUserToGroup: post: operationId: AdminAddUserToGroup description:Adds the specified user to the specified group.
Calling this action requires developer credentials.
responses: "200": description: Success "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminAddUserToGroup480Example: summary: Default AdminAddUserToGroup 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminAddUserToGroup481Example: summary: Default AdminAddUserToGroup 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminAddUserToGroup482Example: summary: Default AdminAddUserToGroup 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminAddUserToGroup483Example: summary: Default AdminAddUserToGroup 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminAddUserToGroup484Example: summary: Default AdminAddUserToGroup 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminAddUserToGroup485Example: summary: Default AdminAddUserToGroup 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminAddUserToGroupRequest" examples: AdminAddUserToGroupRequestExample: summary: Default AdminAddUserToGroup request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool GroupName: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminAddUserToGroup summary: Amazon Cognito Admin Add User to Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminConfirmSignUp: post: operationId: AdminConfirmSignUp description:Confirms user registration as an admin without using a confirmation code. Works on any user.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminConfirmSignUpResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminConfirmSignUp480Example: summary: Default AdminConfirmSignUp 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminConfirmSignUp481Example: summary: Default AdminConfirmSignUp 481 response x-microcks-default: true value: example "482": description: UnexpectedLambdaException content: application/json: schema: $ref: "#/components/schemas/UnexpectedLambdaException" examples: AdminConfirmSignUp482Example: summary: Default AdminConfirmSignUp 482 response x-microcks-default: true value: example "483": description: UserLambdaValidationException content: application/json: schema: $ref: "#/components/schemas/UserLambdaValidationException" examples: AdminConfirmSignUp483Example: summary: Default AdminConfirmSignUp 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminConfirmSignUp484Example: summary: Default AdminConfirmSignUp 484 response x-microcks-default: true value: example "485": description: TooManyFailedAttemptsException content: application/json: schema: $ref: "#/components/schemas/TooManyFailedAttemptsException" examples: AdminConfirmSignUp485Example: summary: Default AdminConfirmSignUp 485 response x-microcks-default: true value: example "486": description: InvalidLambdaResponseException content: application/json: schema: $ref: "#/components/schemas/InvalidLambdaResponseException" examples: AdminConfirmSignUp486Example: summary: Default AdminConfirmSignUp 486 response x-microcks-default: true value: example "487": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminConfirmSignUp487Example: summary: Default AdminConfirmSignUp 487 response x-microcks-default: true value: example "488": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: AdminConfirmSignUp488Example: summary: Default AdminConfirmSignUp 488 response x-microcks-default: true value: example "489": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminConfirmSignUp489Example: summary: Default AdminConfirmSignUp 489 response x-microcks-default: true value: example "490": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminConfirmSignUp490Example: summary: Default AdminConfirmSignUp 490 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminConfirmSignUpRequest" examples: AdminConfirmSignUpRequestExample: summary: Default AdminConfirmSignUp request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool ClientMetadata: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminConfirmSignUp summary: Amazon Cognito Admin Confirm Sign Up x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminCreateUser: post: operationId: AdminCreateUser description: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 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, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and
change their password.
AdminCreateUser requires developer credentials.
Deletes a user as an administrator. Works on any user.
Calling this action requires developer credentials.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminDeleteUser480Example: summary: Default AdminDeleteUser 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminDeleteUser481Example: summary: Default AdminDeleteUser 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminDeleteUser482Example: summary: Default AdminDeleteUser 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminDeleteUser483Example: summary: Default AdminDeleteUser 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminDeleteUser484Example: summary: Default AdminDeleteUser 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminDeleteUser485Example: summary: Default AdminDeleteUser 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminDeleteUserRequest" examples: AdminDeleteUserRequestExample: summary: Default AdminDeleteUser request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminDeleteUser summary: Amazon Cognito Admin Delete User x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDeleteUserAttributes: post: operationId: AdminDeleteUserAttributes description:Deletes the user attributes in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminDeleteUserAttributesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminDeleteUserAttributes480Example: summary: Default AdminDeleteUserAttributes 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminDeleteUserAttributes481Example: summary: Default AdminDeleteUserAttributes 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminDeleteUserAttributes482Example: summary: Default AdminDeleteUserAttributes 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminDeleteUserAttributes483Example: summary: Default AdminDeleteUserAttributes 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminDeleteUserAttributes484Example: summary: Default AdminDeleteUserAttributes 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminDeleteUserAttributes485Example: summary: Default AdminDeleteUserAttributes 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminDeleteUserAttributesRequest" examples: AdminDeleteUserAttributesRequestExample: summary: Default AdminDeleteUserAttributes request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool UserAttributeNames: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminDeleteUserAttributes summary: Amazon Cognito Admin Delete User Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminDisableProviderForUser: post: operationId: AdminDisableProviderForUser description: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.
This action is enabled only for admin access and requires developer credentials.
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.
Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and
ListUsers API requests.
You must make this API request with Amazon Web Services credentials that have cognito-idp:AdminDisableUser permissions.
Enables the specified user as an administrator. Works on any user.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminEnableUserResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminEnableUser480Example: summary: Default AdminEnableUser 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminEnableUser481Example: summary: Default AdminEnableUser 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminEnableUser482Example: summary: Default AdminEnableUser 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminEnableUser483Example: summary: Default AdminEnableUser 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminEnableUser484Example: summary: Default AdminEnableUser 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminEnableUser485Example: summary: Default AdminEnableUser 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminEnableUserRequest" examples: AdminEnableUserRequestExample: summary: Default AdminEnableUser request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminEnableUser summary: Amazon Cognito Admin Enable User x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminForgetDevice: post: operationId: AdminForgetDevice description:Forgets the device, as an administrator.
Calling this action requires developer credentials.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminForgetDevice480Example: summary: Default AdminForgetDevice 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminForgetDevice481Example: summary: Default AdminForgetDevice 481 response x-microcks-default: true value: example "482": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: AdminForgetDevice482Example: summary: Default AdminForgetDevice 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminForgetDevice483Example: summary: Default AdminForgetDevice 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminForgetDevice484Example: summary: Default AdminForgetDevice 484 response x-microcks-default: true value: example "485": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminForgetDevice485Example: summary: Default AdminForgetDevice 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminForgetDevice486Example: summary: Default AdminForgetDevice 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminForgetDeviceRequest" examples: AdminForgetDeviceRequestExample: summary: Default AdminForgetDevice request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool DeviceKey: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminForgetDevice summary: Amazon Cognito Admin Forget Device x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetDevice: post: operationId: AdminGetDevice description:Gets the device, as an administrator.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminGetDeviceResponse" examples: AdminGetDevice200Example: summary: Default AdminGetDevice 200 response x-microcks-default: true value: Device: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminGetDevice480Example: summary: Default AdminGetDevice 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminGetDevice481Example: summary: Default AdminGetDevice 481 response x-microcks-default: true value: example "482": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: AdminGetDevice482Example: summary: Default AdminGetDevice 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminGetDevice483Example: summary: Default AdminGetDevice 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminGetDevice484Example: summary: Default AdminGetDevice 484 response x-microcks-default: true value: example "485": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminGetDevice485Example: summary: Default AdminGetDevice 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminGetDeviceRequest" examples: AdminGetDeviceRequestExample: summary: Default AdminGetDevice request x-microcks-default: true value: DeviceKey: example-value UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminGetDevice summary: Amazon Cognito Admin Get Device x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetUser: post: operationId: AdminGetUser description:Gets the specified user by user name in a user pool as an administrator. Works on any user.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminGetUserResponse" examples: AdminGetUser200Example: summary: Default AdminGetUser 200 response x-microcks-default: true value: Username: my-user-pool UserAttributes: example-value UserCreateDate: example-value UserLastModifiedDate: example-value Enabled: example-value UserStatus: CONFIRMED MFAOptions: example-value PreferredMfaSetting: example-value UserMFASettingList: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminGetUser480Example: summary: Default AdminGetUser 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminGetUser481Example: summary: Default AdminGetUser 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminGetUser482Example: summary: Default AdminGetUser 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminGetUser483Example: summary: Default AdminGetUser 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminGetUser484Example: summary: Default AdminGetUser 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminGetUser485Example: summary: Default AdminGetUser 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminGetUserRequest" examples: AdminGetUserRequestExample: summary: Default AdminGetUser request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminGetUser summary: Amazon Cognito Admin Get User x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminInitiateAuth: post: operationId: AdminInitiateAuth description:Initiates the authentication flow, 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 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.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminInitiateAuthResponse" examples: AdminInitiateAuth200Example: summary: Default AdminInitiateAuth 200 response x-microcks-default: true value: ChallengeName: my-user-pool Session: example-value ChallengeParameters: example-value AuthenticationResult: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminInitiateAuth480Example: summary: Default AdminInitiateAuth 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminInitiateAuth481Example: summary: Default AdminInitiateAuth 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminInitiateAuth482Example: summary: Default AdminInitiateAuth 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminInitiateAuth483Example: summary: Default AdminInitiateAuth 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminInitiateAuth484Example: summary: Default AdminInitiateAuth 484 response x-microcks-default: true value: example "485": description: UnexpectedLambdaException content: application/json: schema: $ref: "#/components/schemas/UnexpectedLambdaException" examples: AdminInitiateAuth485Example: summary: Default AdminInitiateAuth 485 response x-microcks-default: true value: example "486": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: AdminInitiateAuth486Example: summary: Default AdminInitiateAuth 486 response x-microcks-default: true value: example "487": description: UserLambdaValidationException content: application/json: schema: $ref: "#/components/schemas/UserLambdaValidationException" examples: AdminInitiateAuth487Example: summary: Default AdminInitiateAuth 487 response x-microcks-default: true value: example "488": description: InvalidLambdaResponseException content: application/json: schema: $ref: "#/components/schemas/InvalidLambdaResponseException" examples: AdminInitiateAuth488Example: summary: Default AdminInitiateAuth 488 response x-microcks-default: true value: example "489": description: MFAMethodNotFoundException content: application/json: schema: $ref: "#/components/schemas/MFAMethodNotFoundException" examples: AdminInitiateAuth489Example: summary: Default AdminInitiateAuth 489 response x-microcks-default: true value: example "490": description: InvalidSmsRoleAccessPolicyException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleAccessPolicyException" examples: AdminInitiateAuth490Example: summary: Default AdminInitiateAuth 490 response x-microcks-default: true value: example "491": description: InvalidSmsRoleTrustRelationshipException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleTrustRelationshipException" examples: AdminInitiateAuth491Example: summary: Default AdminInitiateAuth 491 response x-microcks-default: true value: example "492": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: AdminInitiateAuth492Example: summary: Default AdminInitiateAuth 492 response x-microcks-default: true value: example "493": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminInitiateAuth493Example: summary: Default AdminInitiateAuth 493 response x-microcks-default: true value: example "494": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: AdminInitiateAuth494Example: summary: Default AdminInitiateAuth 494 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminInitiateAuthRequest" examples: AdminInitiateAuthRequestExample: summary: Default AdminInitiateAuth request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientId: us-east-1_AbCdEfGhI AuthFlow: example-value AuthParameters: example-value ClientMetadata: example-value AnalyticsMetadata: example-value ContextData: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminInitiateAuth summary: Amazon Cognito Admin Initiate Auth x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminLinkProviderForUser: post: operationId: AdminLinkProviderForUser description: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.
This action is administrative and requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminLinkProviderForUserResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminLinkProviderForUser480Example: summary: Default AdminLinkProviderForUser 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminLinkProviderForUser481Example: summary: Default AdminLinkProviderForUser 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminLinkProviderForUser482Example: summary: Default AdminLinkProviderForUser 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminLinkProviderForUser483Example: summary: Default AdminLinkProviderForUser 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminLinkProviderForUser484Example: summary: Default AdminLinkProviderForUser 484 response x-microcks-default: true value: example "485": description: AliasExistsException content: application/json: schema: $ref: "#/components/schemas/AliasExistsException" examples: AdminLinkProviderForUser485Example: summary: Default AdminLinkProviderForUser 485 response x-microcks-default: true value: example "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: AdminLinkProviderForUser486Example: summary: Default AdminLinkProviderForUser 486 response x-microcks-default: true value: example "487": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminLinkProviderForUser487Example: summary: Default AdminLinkProviderForUser 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminLinkProviderForUserRequest" examples: AdminLinkProviderForUserRequestExample: summary: Default AdminLinkProviderForUser request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI DestinationUser: example-value SourceUser: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminLinkProviderForUser summary: Amazon Cognito Admin Link Provider for User x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListDevices: post: operationId: AdminListDevices description:Lists devices, as an administrator.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminListDevicesResponse" examples: AdminListDevices200Example: summary: Default AdminListDevices 200 response x-microcks-default: true value: Devices: example-value PaginationToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminListDevices480Example: summary: Default AdminListDevices 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminListDevices481Example: summary: Default AdminListDevices 481 response x-microcks-default: true value: example "482": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: AdminListDevices482Example: summary: Default AdminListDevices 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminListDevices483Example: summary: Default AdminListDevices 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminListDevices484Example: summary: Default AdminListDevices 484 response x-microcks-default: true value: example "485": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminListDevices485Example: summary: Default AdminListDevices 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminListDevicesRequest" examples: AdminListDevicesRequestExample: summary: Default AdminListDevices request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool Limit: example-value PaginationToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminListDevices summary: Amazon Cognito Admin List Devices x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListGroupsForUser: post: operationId: AdminListGroupsForUser description:Lists the groups that the user belongs to.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminListGroupsForUserResponse" examples: AdminListGroupsForUser200Example: summary: Default AdminListGroupsForUser 200 response x-microcks-default: true value: Groups: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminListGroupsForUser480Example: summary: Default AdminListGroupsForUser 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminListGroupsForUser481Example: summary: Default AdminListGroupsForUser 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminListGroupsForUser482Example: summary: Default AdminListGroupsForUser 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminListGroupsForUser483Example: summary: Default AdminListGroupsForUser 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminListGroupsForUser484Example: summary: Default AdminListGroupsForUser 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminListGroupsForUser485Example: summary: Default AdminListGroupsForUser 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminListGroupsForUserRequest" examples: AdminListGroupsForUserRequestExample: summary: Default AdminListGroupsForUser request x-microcks-default: true value: Username: my-user-pool UserPoolId: us-east-1_AbCdEfGhI Limit: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: Limit in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminListGroupsForUser summary: Amazon Cognito Admin List Groups for User x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminListUserAuthEvents: post: operationId: AdminListUserAuthEvents description: A history of user activity and any risks detected as part of Amazon Cognito advanced security. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminListUserAuthEventsResponse" examples: AdminListUserAuthEvents200Example: summary: Default AdminListUserAuthEvents 200 response x-microcks-default: true value: AuthEvents: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminListUserAuthEvents480Example: summary: Default AdminListUserAuthEvents 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminListUserAuthEvents481Example: summary: Default AdminListUserAuthEvents 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminListUserAuthEvents482Example: summary: Default AdminListUserAuthEvents 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminListUserAuthEvents483Example: summary: Default AdminListUserAuthEvents 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminListUserAuthEvents484Example: summary: Default AdminListUserAuthEvents 484 response x-microcks-default: true value: example "485": description: UserPoolAddOnNotEnabledException content: application/json: schema: $ref: "#/components/schemas/UserPoolAddOnNotEnabledException" examples: AdminListUserAuthEvents485Example: summary: Default AdminListUserAuthEvents 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminListUserAuthEvents486Example: summary: Default AdminListUserAuthEvents 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminListUserAuthEventsRequest" examples: AdminListUserAuthEventsRequestExample: summary: Default AdminListUserAuthEvents request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool MaxResults: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminListUserAuthEvents summary: Amazon Cognito Admin List User Auth Events x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRemoveUserFromGroup: post: operationId: AdminRemoveUserFromGroup description:Removes the specified user from the specified group.
Calling this action requires developer credentials.
responses: "200": description: Success "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminRemoveUserFromGroup480Example: summary: Default AdminRemoveUserFromGroup 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminRemoveUserFromGroup481Example: summary: Default AdminRemoveUserFromGroup 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminRemoveUserFromGroup482Example: summary: Default AdminRemoveUserFromGroup 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminRemoveUserFromGroup483Example: summary: Default AdminRemoveUserFromGroup 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminRemoveUserFromGroup484Example: summary: Default AdminRemoveUserFromGroup 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminRemoveUserFromGroup485Example: summary: Default AdminRemoveUserFromGroup 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminRemoveUserFromGroupRequest" examples: AdminRemoveUserFromGroupRequestExample: summary: Default AdminRemoveUserFromGroup request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool GroupName: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminRemoveUserFromGroup summary: Amazon Cognito Admin Remove User from Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminResetUserPassword: post: operationId: AdminResetUserPassword description:Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. 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.
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.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminResetUserPasswordResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminResetUserPassword480Example: summary: Default AdminResetUserPassword 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminResetUserPassword481Example: summary: Default AdminResetUserPassword 481 response x-microcks-default: true value: example "482": description: UnexpectedLambdaException content: application/json: schema: $ref: "#/components/schemas/UnexpectedLambdaException" examples: AdminResetUserPassword482Example: summary: Default AdminResetUserPassword 482 response x-microcks-default: true value: example "483": description: UserLambdaValidationException content: application/json: schema: $ref: "#/components/schemas/UserLambdaValidationException" examples: AdminResetUserPassword483Example: summary: Default AdminResetUserPassword 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminResetUserPassword484Example: summary: Default AdminResetUserPassword 484 response x-microcks-default: true value: example "485": description: InvalidLambdaResponseException content: application/json: schema: $ref: "#/components/schemas/InvalidLambdaResponseException" examples: AdminResetUserPassword485Example: summary: Default AdminResetUserPassword 485 response x-microcks-default: true value: example "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminResetUserPassword486Example: summary: Default AdminResetUserPassword 486 response x-microcks-default: true value: example "487": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: AdminResetUserPassword487Example: summary: Default AdminResetUserPassword 487 response x-microcks-default: true value: example "488": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminResetUserPassword488Example: summary: Default AdminResetUserPassword 488 response x-microcks-default: true value: example "489": description: InvalidSmsRoleAccessPolicyException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleAccessPolicyException" examples: AdminResetUserPassword489Example: summary: Default AdminResetUserPassword 489 response x-microcks-default: true value: example "490": description: InvalidEmailRoleAccessPolicyException content: application/json: schema: $ref: "#/components/schemas/InvalidEmailRoleAccessPolicyException" examples: AdminResetUserPassword490Example: summary: Default AdminResetUserPassword 490 response x-microcks-default: true value: example "491": description: InvalidSmsRoleTrustRelationshipException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleTrustRelationshipException" examples: AdminResetUserPassword491Example: summary: Default AdminResetUserPassword 491 response x-microcks-default: true value: example "492": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminResetUserPassword492Example: summary: Default AdminResetUserPassword 492 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminResetUserPasswordRequest" examples: AdminResetUserPasswordRequestExample: summary: Default AdminResetUserPassword request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool ClientMetadata: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminResetUserPassword summary: Amazon Cognito Admin Reset User Password x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge: post: operationId: AdminRespondToAuthChallenge description:Responds to an authentication challenge, 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 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.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminRespondToAuthChallengeResponse" examples: AdminRespondToAuthChallenge200Example: summary: Default AdminRespondToAuthChallenge 200 response x-microcks-default: true value: ChallengeName: my-user-pool Session: example-value ChallengeParameters: example-value AuthenticationResult: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminRespondToAuthChallenge480Example: summary: Default AdminRespondToAuthChallenge 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminRespondToAuthChallenge481Example: summary: Default AdminRespondToAuthChallenge 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminRespondToAuthChallenge482Example: summary: Default AdminRespondToAuthChallenge 482 response x-microcks-default: true value: example "483": description: CodeMismatchException content: application/json: schema: $ref: "#/components/schemas/CodeMismatchException" examples: AdminRespondToAuthChallenge483Example: summary: Default AdminRespondToAuthChallenge 483 response x-microcks-default: true value: example "484": description: ExpiredCodeException content: application/json: schema: $ref: "#/components/schemas/ExpiredCodeException" examples: AdminRespondToAuthChallenge484Example: summary: Default AdminRespondToAuthChallenge 484 response x-microcks-default: true value: example "485": description: UnexpectedLambdaException content: application/json: schema: $ref: "#/components/schemas/UnexpectedLambdaException" examples: AdminRespondToAuthChallenge485Example: summary: Default AdminRespondToAuthChallenge 485 response x-microcks-default: true value: example "486": description: InvalidPasswordException content: application/json: schema: $ref: "#/components/schemas/InvalidPasswordException" examples: AdminRespondToAuthChallenge486Example: summary: Default AdminRespondToAuthChallenge 486 response x-microcks-default: true value: example "487": description: UserLambdaValidationException content: application/json: schema: $ref: "#/components/schemas/UserLambdaValidationException" examples: AdminRespondToAuthChallenge487Example: summary: Default AdminRespondToAuthChallenge 487 response x-microcks-default: true value: example "488": description: InvalidLambdaResponseException content: application/json: schema: $ref: "#/components/schemas/InvalidLambdaResponseException" examples: AdminRespondToAuthChallenge488Example: summary: Default AdminRespondToAuthChallenge 488 response x-microcks-default: true value: example "489": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminRespondToAuthChallenge489Example: summary: Default AdminRespondToAuthChallenge 489 response x-microcks-default: true value: example "490": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: AdminRespondToAuthChallenge490Example: summary: Default AdminRespondToAuthChallenge 490 response x-microcks-default: true value: example "491": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminRespondToAuthChallenge491Example: summary: Default AdminRespondToAuthChallenge 491 response x-microcks-default: true value: example "492": description: MFAMethodNotFoundException content: application/json: schema: $ref: "#/components/schemas/MFAMethodNotFoundException" examples: AdminRespondToAuthChallenge492Example: summary: Default AdminRespondToAuthChallenge 492 response x-microcks-default: true value: example "493": description: InvalidSmsRoleAccessPolicyException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleAccessPolicyException" examples: AdminRespondToAuthChallenge493Example: summary: Default AdminRespondToAuthChallenge 493 response x-microcks-default: true value: example "494": description: InvalidSmsRoleTrustRelationshipException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleTrustRelationshipException" examples: AdminRespondToAuthChallenge494Example: summary: Default AdminRespondToAuthChallenge 494 response x-microcks-default: true value: example "495": description: AliasExistsException content: application/json: schema: $ref: "#/components/schemas/AliasExistsException" examples: AdminRespondToAuthChallenge495Example: summary: Default AdminRespondToAuthChallenge 495 response x-microcks-default: true value: example "496": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: AdminRespondToAuthChallenge496Example: summary: Default AdminRespondToAuthChallenge 496 response x-microcks-default: true value: example "497": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminRespondToAuthChallenge497Example: summary: Default AdminRespondToAuthChallenge 497 response x-microcks-default: true value: example "498": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: AdminRespondToAuthChallenge498Example: summary: Default AdminRespondToAuthChallenge 498 response x-microcks-default: true value: example "499": description: SoftwareTokenMFANotFoundException content: application/json: schema: $ref: "#/components/schemas/SoftwareTokenMFANotFoundException" examples: AdminRespondToAuthChallenge499Example: summary: Default AdminRespondToAuthChallenge 499 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminRespondToAuthChallengeRequest" examples: AdminRespondToAuthChallengeRequestExample: summary: Default AdminRespondToAuthChallenge request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientId: us-east-1_AbCdEfGhI ChallengeName: my-user-pool ChallengeResponses: example-value Session: example-value AnalyticsMetadata: example-value ContextData: example-value ClientMetadata: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminRespondToAuthChallenge summary: Amazon Cognito Admin Respond to Auth Challenge x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserMFAPreference: post: operationId: AdminSetUserMFAPreference description: 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. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminSetUserMFAPreferenceResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminSetUserMFAPreference480Example: summary: Default AdminSetUserMFAPreference 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminSetUserMFAPreference481Example: summary: Default AdminSetUserMFAPreference 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminSetUserMFAPreference482Example: summary: Default AdminSetUserMFAPreference 482 response x-microcks-default: true value: example "483": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: AdminSetUserMFAPreference483Example: summary: Default AdminSetUserMFAPreference 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminSetUserMFAPreference484Example: summary: Default AdminSetUserMFAPreference 484 response x-microcks-default: true value: example "485": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: AdminSetUserMFAPreference485Example: summary: Default AdminSetUserMFAPreference 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminSetUserMFAPreference486Example: summary: Default AdminSetUserMFAPreference 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminSetUserMFAPreferenceRequest" examples: AdminSetUserMFAPreferenceRequestExample: summary: Default AdminSetUserMFAPreference request x-microcks-default: true value: SMSMfaSettings: example-value SoftwareTokenMfaSettings: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... Username: my-user-pool UserPoolId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminSetUserMFAPreference summary: Amazon Cognito Admin Set User M F a Preference x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminSetUserPassword: post: operationId: AdminSetUserPassword description:Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status
enters the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED
challenge. If the user doesn't sign in before it expires, the user won't be able to sign in, and an administrator must reset their password.
Once the user has set a new password, or
the password is permanent, the user status is set to Confirmed.
Updates the device status as an administrator.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminUpdateDeviceStatusResponse" "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminUpdateDeviceStatus480Example: summary: Default AdminUpdateDeviceStatus 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminUpdateDeviceStatus481Example: summary: Default AdminUpdateDeviceStatus 481 response x-microcks-default: true value: example "482": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: AdminUpdateDeviceStatus482Example: summary: Default AdminUpdateDeviceStatus 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminUpdateDeviceStatus483Example: summary: Default AdminUpdateDeviceStatus 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminUpdateDeviceStatus484Example: summary: Default AdminUpdateDeviceStatus 484 response x-microcks-default: true value: example "485": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminUpdateDeviceStatus485Example: summary: Default AdminUpdateDeviceStatus 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminUpdateDeviceStatus486Example: summary: Default AdminUpdateDeviceStatus 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminUpdateDeviceStatusRequest" examples: AdminUpdateDeviceStatusRequestExample: summary: Default AdminUpdateDeviceStatus request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool DeviceKey: example-value DeviceRememberedStatus: CONFIRMED parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminUpdateDeviceStatus summary: Amazon Cognito Admin Update Device Status x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUpdateUserAttributes: post: operationId: AdminUpdateUserAttributes description:Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the
custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
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.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminUpdateUserAttributesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminUpdateUserAttributes480Example: summary: Default AdminUpdateUserAttributes 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminUpdateUserAttributes481Example: summary: Default AdminUpdateUserAttributes 481 response x-microcks-default: true value: example "482": description: UnexpectedLambdaException content: application/json: schema: $ref: "#/components/schemas/UnexpectedLambdaException" examples: AdminUpdateUserAttributes482Example: summary: Default AdminUpdateUserAttributes 482 response x-microcks-default: true value: example "483": description: UserLambdaValidationException content: application/json: schema: $ref: "#/components/schemas/UserLambdaValidationException" examples: AdminUpdateUserAttributes483Example: summary: Default AdminUpdateUserAttributes 483 response x-microcks-default: true value: example "484": description: InvalidLambdaResponseException content: application/json: schema: $ref: "#/components/schemas/InvalidLambdaResponseException" examples: AdminUpdateUserAttributes484Example: summary: Default AdminUpdateUserAttributes 484 response x-microcks-default: true value: example "485": description: AliasExistsException content: application/json: schema: $ref: "#/components/schemas/AliasExistsException" examples: AdminUpdateUserAttributes485Example: summary: Default AdminUpdateUserAttributes 485 response x-microcks-default: true value: example "486": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminUpdateUserAttributes486Example: summary: Default AdminUpdateUserAttributes 486 response x-microcks-default: true value: example "487": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminUpdateUserAttributes487Example: summary: Default AdminUpdateUserAttributes 487 response x-microcks-default: true value: example "488": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminUpdateUserAttributes488Example: summary: Default AdminUpdateUserAttributes 488 response x-microcks-default: true value: example "489": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminUpdateUserAttributes489Example: summary: Default AdminUpdateUserAttributes 489 response x-microcks-default: true value: example "490": description: InvalidSmsRoleAccessPolicyException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleAccessPolicyException" examples: AdminUpdateUserAttributes490Example: summary: Default AdminUpdateUserAttributes 490 response x-microcks-default: true value: example "491": description: InvalidEmailRoleAccessPolicyException content: application/json: schema: $ref: "#/components/schemas/InvalidEmailRoleAccessPolicyException" examples: AdminUpdateUserAttributes491Example: summary: Default AdminUpdateUserAttributes 491 response x-microcks-default: true value: example "492": description: InvalidSmsRoleTrustRelationshipException content: application/json: schema: $ref: "#/components/schemas/InvalidSmsRoleTrustRelationshipException" examples: AdminUpdateUserAttributes492Example: summary: Default AdminUpdateUserAttributes 492 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminUpdateUserAttributesRequest" examples: AdminUpdateUserAttributesRequestExample: summary: Default AdminUpdateUserAttributes request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool UserAttributes: example-value ClientMetadata: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminUpdateUserAttributes summary: Amazon Cognito Admin Update User Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminUserGlobalSignOut: post: operationId: AdminUserGlobalSignOut description:Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that
Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can
still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AdminUserGlobalSignOutResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: AdminUserGlobalSignOut480Example: summary: Default AdminUserGlobalSignOut 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: AdminUserGlobalSignOut481Example: summary: Default AdminUserGlobalSignOut 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: AdminUserGlobalSignOut482Example: summary: Default AdminUserGlobalSignOut 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: AdminUserGlobalSignOut483Example: summary: Default AdminUserGlobalSignOut 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: AdminUserGlobalSignOut484Example: summary: Default AdminUserGlobalSignOut 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: AdminUserGlobalSignOut485Example: summary: Default AdminUserGlobalSignOut 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/AdminUserGlobalSignOutRequest" examples: AdminUserGlobalSignOutRequestExample: summary: Default AdminUserGlobalSignOut request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.AdminUserGlobalSignOut summary: Amazon Cognito Admin User Global Sign Out x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.AssociateSoftwareToken: post: operationId: AssociateSoftwareToken description: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. 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.
Creates a new group in the specified user pool.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateGroupResponse" examples: CreateGroup200Example: summary: Default CreateGroup 200 response x-microcks-default: true value: Group: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: CreateGroup480Example: summary: Default CreateGroup 480 response x-microcks-default: true value: example "481": description: GroupExistsException content: application/json: schema: $ref: "#/components/schemas/GroupExistsException" examples: CreateGroup481Example: summary: Default CreateGroup 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateGroup482Example: summary: Default CreateGroup 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateGroup483Example: summary: Default CreateGroup 483 response x-microcks-default: true value: example "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: CreateGroup484Example: summary: Default CreateGroup 484 response x-microcks-default: true value: example "485": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: CreateGroup485Example: summary: Default CreateGroup 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: CreateGroup486Example: summary: Default CreateGroup 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateGroupRequest" examples: CreateGroupRequestExample: summary: Default CreateGroup request x-microcks-default: true value: GroupName: my-user-pool UserPoolId: us-east-1_AbCdEfGhI Description: example-value RoleArn: arn:aws:cognito-idp:us-east-1:123456789:userpool/us-east-1_AbCdEfGhI Precedence: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateGroup summary: Amazon Cognito Create Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateIdentityProvider: post: operationId: CreateIdentityProvider description: Creates an IdP for a user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateIdentityProviderResponse" examples: CreateIdentityProvider200Example: summary: Default CreateIdentityProvider 200 response x-microcks-default: true value: IdentityProvider: us-east-1_AbCdEfGhI "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: CreateIdentityProvider480Example: summary: Default CreateIdentityProvider 480 response x-microcks-default: true value: example "481": description: DuplicateProviderException content: application/json: schema: $ref: "#/components/schemas/DuplicateProviderException" examples: CreateIdentityProvider481Example: summary: Default CreateIdentityProvider 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateIdentityProvider482Example: summary: Default CreateIdentityProvider 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: CreateIdentityProvider483Example: summary: Default CreateIdentityProvider 483 response x-microcks-default: true value: example "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateIdentityProvider484Example: summary: Default CreateIdentityProvider 484 response x-microcks-default: true value: example "485": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: CreateIdentityProvider485Example: summary: Default CreateIdentityProvider 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: CreateIdentityProvider486Example: summary: Default CreateIdentityProvider 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateIdentityProviderRequest" examples: CreateIdentityProviderRequestExample: summary: Default CreateIdentityProvider request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ProviderName: my-user-pool ProviderType: us-east-1_AbCdEfGhI ProviderDetails: us-east-1_AbCdEfGhI AttributeMapping: example-value IdpIdentifiers: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateIdentityProvider summary: Amazon Cognito Create Identity Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateResourceServer: post: operationId: CreateResourceServer description: Creates a new OAuth2.0 resource server and defines custom scopes within it. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateResourceServerResponse" examples: CreateResourceServer200Example: summary: Default CreateResourceServer 200 response x-microcks-default: true value: ResourceServer: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: CreateResourceServer480Example: summary: Default CreateResourceServer 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateResourceServer481Example: summary: Default CreateResourceServer 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: CreateResourceServer482Example: summary: Default CreateResourceServer 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateResourceServer483Example: summary: Default CreateResourceServer 483 response x-microcks-default: true value: example "484": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: CreateResourceServer484Example: summary: Default CreateResourceServer 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: CreateResourceServer485Example: summary: Default CreateResourceServer 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateResourceServerRequest" examples: CreateResourceServerRequestExample: summary: Default CreateResourceServer request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Identifier: us-east-1_AbCdEfGhI Name: my-user-pool Scopes: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateResourceServer summary: Amazon Cognito Create Resource Server x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserImportJob: post: operationId: CreateUserImportJob description: Creates the user import job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateUserImportJobResponse" examples: CreateUserImportJob200Example: summary: Default CreateUserImportJob 200 response x-microcks-default: true value: UserImportJob: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateUserImportJob480Example: summary: Default CreateUserImportJob 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: CreateUserImportJob481Example: summary: Default CreateUserImportJob 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateUserImportJob482Example: summary: Default CreateUserImportJob 482 response x-microcks-default: true value: example "483": description: PreconditionNotMetException content: application/json: schema: $ref: "#/components/schemas/PreconditionNotMetException" examples: CreateUserImportJob483Example: summary: Default CreateUserImportJob 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: CreateUserImportJob484Example: summary: Default CreateUserImportJob 484 response x-microcks-default: true value: example "485": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: CreateUserImportJob485Example: summary: Default CreateUserImportJob 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: CreateUserImportJob486Example: summary: Default CreateUserImportJob 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateUserImportJobRequest" examples: CreateUserImportJobRequestExample: summary: Default CreateUserImportJob request x-microcks-default: true value: JobName: my-user-pool UserPoolId: us-east-1_AbCdEfGhI CloudWatchLogsRoleArn: arn:aws:cognito-idp:us-east-1:123456789:userpool/us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateUserImportJob summary: Amazon Cognito Create User Import Job x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPool: post: operationId: CreateUserPool description:Creates a new Amazon Cognito user pool and sets the password policy for the pool.
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.
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateUserPoolClientResponse" examples: CreateUserPoolClient200Example: summary: Default CreateUserPoolClient 200 response x-microcks-default: true value: UserPoolClient: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: CreateUserPoolClient480Example: summary: Default CreateUserPoolClient 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateUserPoolClient481Example: summary: Default CreateUserPoolClient 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: CreateUserPoolClient482Example: summary: Default CreateUserPoolClient 482 response x-microcks-default: true value: example "483": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: CreateUserPoolClient483Example: summary: Default CreateUserPoolClient 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: CreateUserPoolClient484Example: summary: Default CreateUserPoolClient 484 response x-microcks-default: true value: example "485": description: ScopeDoesNotExistException content: application/json: schema: $ref: "#/components/schemas/ScopeDoesNotExistException" examples: CreateUserPoolClient485Example: summary: Default CreateUserPoolClient 485 response x-microcks-default: true value: example "486": description: InvalidOAuthFlowException content: application/json: schema: $ref: "#/components/schemas/InvalidOAuthFlowException" examples: CreateUserPoolClient486Example: summary: Default CreateUserPoolClient 486 response x-microcks-default: true value: example "487": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: CreateUserPoolClient487Example: summary: Default CreateUserPoolClient 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateUserPoolClientRequest" examples: CreateUserPoolClientRequestExample: summary: Default CreateUserPoolClient request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientName: my-user-pool GenerateSecret: example-value RefreshTokenValidity: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... AccessTokenValidity: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... IdTokenValidity: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... TokenValidityUnits: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... ReadAttributes: example-value WriteAttributes: example-value ExplicitAuthFlows: example-value SupportedIdentityProviders: us-east-1_AbCdEfGhI CallbackURLs: example-value LogoutURLs: example-value DefaultRedirectURI: example-value AllowedOAuthFlows: example-value AllowedOAuthScopes: example-value AllowedOAuthFlowsUserPoolClient: example-value AnalyticsConfiguration: example-value PreventUserExistenceErrors: example-value EnableTokenRevocation: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... EnablePropagateAdditionalUserContextData: example-value AuthSessionValidity: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateUserPoolClient summary: Amazon Cognito Create User Pool Client x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPoolDomain: post: operationId: CreateUserPoolDomain description: Creates a new domain for a user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateUserPoolDomainResponse" examples: CreateUserPoolDomain200Example: summary: Default CreateUserPoolDomain 200 response x-microcks-default: true value: CloudFrontDomain: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: CreateUserPoolDomain480Example: summary: Default CreateUserPoolDomain 480 response x-microcks-default: true value: example "481": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: CreateUserPoolDomain481Example: summary: Default CreateUserPoolDomain 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateUserPoolDomain482Example: summary: Default CreateUserPoolDomain 482 response x-microcks-default: true value: example "483": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: CreateUserPoolDomain483Example: summary: Default CreateUserPoolDomain 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: CreateUserPoolDomain484Example: summary: Default CreateUserPoolDomain 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/CreateUserPoolDomainRequest" examples: CreateUserPoolDomainRequestExample: summary: Default CreateUserPoolDomain request x-microcks-default: true value: Domain: example-value UserPoolId: us-east-1_AbCdEfGhI CustomDomainConfig: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.CreateUserPoolDomain summary: Amazon Cognito Create User Pool Domain x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteGroup: post: operationId: DeleteGroup description:Deletes a group.
Calling this action requires developer credentials.
responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteGroup480Example: summary: Default DeleteGroup 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteGroup481Example: summary: Default DeleteGroup 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteGroup482Example: summary: Default DeleteGroup 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteGroup483Example: summary: Default DeleteGroup 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteGroup484Example: summary: Default DeleteGroup 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteGroupRequest" examples: DeleteGroupRequestExample: summary: Default DeleteGroup request x-microcks-default: true value: GroupName: my-user-pool UserPoolId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteGroup summary: Amazon Cognito Delete Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteIdentityProvider: post: operationId: DeleteIdentityProvider description: Deletes an IdP for a user pool. responses: "200": description: Success "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteIdentityProvider480Example: summary: Default DeleteIdentityProvider 480 response x-microcks-default: true value: example "481": description: UnsupportedIdentityProviderException content: application/json: schema: $ref: "#/components/schemas/UnsupportedIdentityProviderException" examples: DeleteIdentityProvider481Example: summary: Default DeleteIdentityProvider 481 response x-microcks-default: true value: example "482": description: ConcurrentModificationException content: application/json: schema: $ref: "#/components/schemas/ConcurrentModificationException" examples: DeleteIdentityProvider482Example: summary: Default DeleteIdentityProvider 482 response x-microcks-default: true value: example "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteIdentityProvider483Example: summary: Default DeleteIdentityProvider 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteIdentityProvider484Example: summary: Default DeleteIdentityProvider 484 response x-microcks-default: true value: example "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteIdentityProvider485Example: summary: Default DeleteIdentityProvider 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteIdentityProvider486Example: summary: Default DeleteIdentityProvider 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteIdentityProviderRequest" examples: DeleteIdentityProviderRequestExample: summary: Default DeleteIdentityProvider request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ProviderName: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteIdentityProvider summary: Amazon Cognito Delete Identity Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteResourceServer: post: operationId: DeleteResourceServer description: Deletes a resource server. responses: "200": description: Success "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteResourceServer480Example: summary: Default DeleteResourceServer 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteResourceServer481Example: summary: Default DeleteResourceServer 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteResourceServer482Example: summary: Default DeleteResourceServer 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteResourceServer483Example: summary: Default DeleteResourceServer 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteResourceServer484Example: summary: Default DeleteResourceServer 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteResourceServerRequest" examples: DeleteResourceServerRequestExample: summary: Default DeleteResourceServer request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Identifier: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteResourceServer summary: Amazon Cognito Delete Resource Server x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUser: post: operationId: DeleteUser description: Allows a user to delete himself or herself. responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteUser480Example: summary: Default DeleteUser 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteUser481Example: summary: Default DeleteUser 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteUser482Example: summary: Default DeleteUser 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteUser483Example: summary: Default DeleteUser 483 response x-microcks-default: true value: example "484": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: DeleteUser484Example: summary: Default DeleteUser 484 response x-microcks-default: true value: example "485": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: DeleteUser485Example: summary: Default DeleteUser 485 response x-microcks-default: true value: example "486": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: DeleteUser486Example: summary: Default DeleteUser 486 response x-microcks-default: true value: example "487": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteUser487Example: summary: Default DeleteUser 487 response x-microcks-default: true value: example "488": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeleteUser488Example: summary: Default DeleteUser 488 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteUserRequest" examples: DeleteUserRequestExample: summary: Default DeleteUser request x-microcks-default: true value: AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteUser summary: Amazon Cognito Delete User x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserAttributes: post: operationId: DeleteUserAttributes description: Deletes the attributes for a user. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteUserAttributesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteUserAttributes480Example: summary: Default DeleteUserAttributes 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteUserAttributes481Example: summary: Default DeleteUserAttributes 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteUserAttributes482Example: summary: Default DeleteUserAttributes 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteUserAttributes483Example: summary: Default DeleteUserAttributes 483 response x-microcks-default: true value: example "484": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: DeleteUserAttributes484Example: summary: Default DeleteUserAttributes 484 response x-microcks-default: true value: example "485": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: DeleteUserAttributes485Example: summary: Default DeleteUserAttributes 485 response x-microcks-default: true value: example "486": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: DeleteUserAttributes486Example: summary: Default DeleteUserAttributes 486 response x-microcks-default: true value: example "487": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteUserAttributes487Example: summary: Default DeleteUserAttributes 487 response x-microcks-default: true value: example "488": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: DeleteUserAttributes488Example: summary: Default DeleteUserAttributes 488 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteUserAttributesRequest" examples: DeleteUserAttributesRequestExample: summary: Default DeleteUserAttributes request x-microcks-default: true value: UserAttributeNames: my-user-pool AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteUserAttributes summary: Amazon Cognito Delete User Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPool: post: operationId: DeleteUserPool description: Deletes the specified Amazon Cognito user pool. responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteUserPool480Example: summary: Default DeleteUserPool 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteUserPool481Example: summary: Default DeleteUserPool 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteUserPool482Example: summary: Default DeleteUserPool 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteUserPool483Example: summary: Default DeleteUserPool 483 response x-microcks-default: true value: example "484": description: UserImportInProgressException content: application/json: schema: $ref: "#/components/schemas/UserImportInProgressException" examples: DeleteUserPool484Example: summary: Default DeleteUserPool 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteUserPool485Example: summary: Default DeleteUserPool 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteUserPoolRequest" examples: DeleteUserPoolRequestExample: summary: Default DeleteUserPool 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.DeleteUserPool summary: Amazon Cognito Delete User Pool x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolClient: post: operationId: DeleteUserPoolClient description: Allows the developer to delete the user pool client. responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteUserPoolClient480Example: summary: Default DeleteUserPoolClient 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteUserPoolClient481Example: summary: Default DeleteUserPoolClient 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DeleteUserPoolClient482Example: summary: Default DeleteUserPoolClient 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteUserPoolClient483Example: summary: Default DeleteUserPoolClient 483 response x-microcks-default: true value: example "484": description: ConcurrentModificationException content: application/json: schema: $ref: "#/components/schemas/ConcurrentModificationException" examples: DeleteUserPoolClient484Example: summary: Default DeleteUserPoolClient 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteUserPoolClient485Example: summary: Default DeleteUserPoolClient 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteUserPoolClientRequest" examples: DeleteUserPoolClientRequestExample: summary: Default DeleteUserPoolClient request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteUserPoolClient summary: Amazon Cognito Delete User Pool Client x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DeleteUserPoolDomain: post: operationId: DeleteUserPoolDomain description: Deletes a domain for a user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteUserPoolDomainResponse" "480": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DeleteUserPoolDomain480Example: summary: Default DeleteUserPoolDomain 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteUserPoolDomain481Example: summary: Default DeleteUserPoolDomain 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteUserPoolDomain482Example: summary: Default DeleteUserPoolDomain 482 response x-microcks-default: true value: example "483": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DeleteUserPoolDomain483Example: summary: Default DeleteUserPoolDomain 483 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DeleteUserPoolDomainRequest" examples: DeleteUserPoolDomainRequestExample: summary: Default DeleteUserPoolDomain request x-microcks-default: true value: Domain: example-value UserPoolId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DeleteUserPoolDomain summary: Amazon Cognito Delete User Pool Domain x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeIdentityProvider: post: operationId: DescribeIdentityProvider description: Gets information about a specific IdP. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeIdentityProviderResponse" examples: DescribeIdentityProvider200Example: summary: Default DescribeIdentityProvider 200 response x-microcks-default: true value: IdentityProvider: us-east-1_AbCdEfGhI "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DescribeIdentityProvider480Example: summary: Default DescribeIdentityProvider 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeIdentityProvider481Example: summary: Default DescribeIdentityProvider 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DescribeIdentityProvider482Example: summary: Default DescribeIdentityProvider 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeIdentityProvider483Example: summary: Default DescribeIdentityProvider 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DescribeIdentityProvider484Example: summary: Default DescribeIdentityProvider 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeIdentityProviderRequest" examples: DescribeIdentityProviderRequestExample: summary: Default DescribeIdentityProvider request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ProviderName: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DescribeIdentityProvider summary: Amazon Cognito Describe Identity Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeResourceServer: post: operationId: DescribeResourceServer description: Describes a resource server. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeResourceServerResponse" examples: DescribeResourceServer200Example: summary: Default DescribeResourceServer 200 response x-microcks-default: true value: ResourceServer: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DescribeResourceServer480Example: summary: Default DescribeResourceServer 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeResourceServer481Example: summary: Default DescribeResourceServer 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DescribeResourceServer482Example: summary: Default DescribeResourceServer 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeResourceServer483Example: summary: Default DescribeResourceServer 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DescribeResourceServer484Example: summary: Default DescribeResourceServer 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeResourceServerRequest" examples: DescribeResourceServerRequestExample: summary: Default DescribeResourceServer request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Identifier: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DescribeResourceServer summary: Amazon Cognito Describe Resource Server x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeRiskConfiguration: post: operationId: DescribeRiskConfiguration description: Describes the risk configuration. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeRiskConfigurationResponse" examples: DescribeRiskConfiguration200Example: summary: Default DescribeRiskConfiguration 200 response x-microcks-default: true value: RiskConfiguration: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeRiskConfiguration480Example: summary: Default DescribeRiskConfiguration 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DescribeRiskConfiguration481Example: summary: Default DescribeRiskConfiguration 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeRiskConfiguration482Example: summary: Default DescribeRiskConfiguration 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DescribeRiskConfiguration483Example: summary: Default DescribeRiskConfiguration 483 response x-microcks-default: true value: example "484": description: UserPoolAddOnNotEnabledException content: application/json: schema: $ref: "#/components/schemas/UserPoolAddOnNotEnabledException" examples: DescribeRiskConfiguration484Example: summary: Default DescribeRiskConfiguration 484 response x-microcks-default: true value: example "485": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DescribeRiskConfiguration485Example: summary: Default DescribeRiskConfiguration 485 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeRiskConfigurationRequest" examples: DescribeRiskConfigurationRequestExample: summary: Default DescribeRiskConfiguration request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DescribeRiskConfiguration summary: Amazon Cognito Describe Risk Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserImportJob: post: operationId: DescribeUserImportJob description: Describes the user import job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeUserImportJobResponse" examples: DescribeUserImportJob200Example: summary: Default DescribeUserImportJob 200 response x-microcks-default: true value: UserImportJob: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeUserImportJob480Example: summary: Default DescribeUserImportJob 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DescribeUserImportJob481Example: summary: Default DescribeUserImportJob 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeUserImportJob482Example: summary: Default DescribeUserImportJob 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DescribeUserImportJob483Example: summary: Default DescribeUserImportJob 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DescribeUserImportJob484Example: summary: Default DescribeUserImportJob 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeUserImportJobRequest" examples: DescribeUserImportJobRequestExample: summary: Default DescribeUserImportJob request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI JobId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DescribeUserImportJob summary: Amazon Cognito Describe User Import Job x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPool: 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 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolClient: post: operationId: DescribeUserPoolClient description: Client method for returning the configuration information and metadata of the specified user pool app client. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeUserPoolClientResponse" examples: DescribeUserPoolClient200Example: summary: Default DescribeUserPoolClient 200 response x-microcks-default: true value: UserPoolClient: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeUserPoolClient480Example: summary: Default DescribeUserPoolClient 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DescribeUserPoolClient481Example: summary: Default DescribeUserPoolClient 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: DescribeUserPoolClient482Example: summary: Default DescribeUserPoolClient 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DescribeUserPoolClient483Example: summary: Default DescribeUserPoolClient 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DescribeUserPoolClient484Example: summary: Default DescribeUserPoolClient 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeUserPoolClientRequest" examples: DescribeUserPoolClientRequestExample: summary: Default DescribeUserPoolClient request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DescribeUserPoolClient summary: Amazon Cognito Describe User Pool Client x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.DescribeUserPoolDomain: post: operationId: DescribeUserPoolDomain description: Gets information about a domain. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeUserPoolDomainResponse" examples: DescribeUserPoolDomain200Example: summary: Default DescribeUserPoolDomain 200 response x-microcks-default: true value: DomainDescription: example-value "480": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: DescribeUserPoolDomain480Example: summary: Default DescribeUserPoolDomain 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DescribeUserPoolDomain481Example: summary: Default DescribeUserPoolDomain 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeUserPoolDomain482Example: summary: Default DescribeUserPoolDomain 482 response x-microcks-default: true value: example "483": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: DescribeUserPoolDomain483Example: summary: Default DescribeUserPoolDomain 483 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/DescribeUserPoolDomainRequest" examples: DescribeUserPoolDomainRequestExample: summary: Default DescribeUserPoolDomain request x-microcks-default: true value: Domain: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.DescribeUserPoolDomain summary: Amazon Cognito Describe User Pool Domain x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ForgetDevice: post: operationId: ForgetDevice description: Forgets the specified device. responses: "200": description: Success "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ForgetDevice480Example: summary: Default ForgetDevice 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ForgetDevice481Example: summary: Default ForgetDevice 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ForgetDevice482Example: summary: Default ForgetDevice 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ForgetDevice483Example: summary: Default ForgetDevice 483 response x-microcks-default: true value: example "484": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: ForgetDevice484Example: summary: Default ForgetDevice 484 response x-microcks-default: true value: example "485": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: ForgetDevice485Example: summary: Default ForgetDevice 485 response x-microcks-default: true value: example "486": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: ForgetDevice486Example: summary: Default ForgetDevice 486 response x-microcks-default: true value: example "487": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: ForgetDevice487Example: summary: Default ForgetDevice 487 response x-microcks-default: true value: example "488": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ForgetDevice488Example: summary: Default ForgetDevice 488 response x-microcks-default: true value: example "489": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: ForgetDevice489Example: summary: Default ForgetDevice 489 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ForgetDeviceRequest" examples: ForgetDeviceRequestExample: summary: Default ForgetDevice request x-microcks-default: true value: AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... DeviceKey: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ForgetDevice summary: Amazon Cognito Forget Device x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ForgotPassword: post: operationId: ForgotPassword description: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. If neither a
verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
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.
Gets a group.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetGroupResponse" examples: GetGroup200Example: summary: Default GetGroup 200 response x-microcks-default: true value: Group: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: GetGroup480Example: summary: Default GetGroup 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: GetGroup481Example: summary: Default GetGroup 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: GetGroup482Example: summary: Default GetGroup 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: GetGroup483Example: summary: Default GetGroup 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: GetGroup484Example: summary: Default GetGroup 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetGroupRequest" examples: GetGroupRequestExample: summary: Default GetGroup request x-microcks-default: true value: GroupName: my-user-pool UserPoolId: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.GetGroup summary: Amazon Cognito Get Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.GetIdentityProviderByIdentifier: post: operationId: GetIdentityProviderByIdentifier description: Gets the specified IdP. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetIdentityProviderByIdentifierResponse" examples: GetIdentityProviderByIdentifier200Example: summary: Default GetIdentityProviderByIdentifier 200 response x-microcks-default: true value: IdentityProvider: us-east-1_AbCdEfGhI "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: GetIdentityProviderByIdentifier480Example: summary: Default GetIdentityProviderByIdentifier 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: GetIdentityProviderByIdentifier481Example: summary: Default GetIdentityProviderByIdentifier 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: GetIdentityProviderByIdentifier482Example: summary: Default GetIdentityProviderByIdentifier 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: GetIdentityProviderByIdentifier483Example: summary: Default GetIdentityProviderByIdentifier 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: GetIdentityProviderByIdentifier484Example: summary: Default GetIdentityProviderByIdentifier 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/GetIdentityProviderByIdentifierRequest" examples: GetIdentityProviderByIdentifierRequestExample: summary: Default GetIdentityProviderByIdentifier request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI IdpIdentifier: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.GetIdentityProviderByIdentifier summary: Amazon Cognito Get Identity Provider by Identifier x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.GetSigningCertificate: post: operationId: GetSigningCertificate description: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.
clientId is ALL), then that information is returned. If nothing is present, then an empty shape is
returned.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetUICustomizationResponse"
examples:
GetUICustomization200Example:
summary: Default GetUICustomization 200 response
x-microcks-default: true
value:
UICustomization: example-value
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
GetUICustomization480Example:
summary: Default GetUICustomization 480 response
x-microcks-default: true
value: example
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
GetUICustomization481Example:
summary: Default GetUICustomization 481 response
x-microcks-default: true
value: example
"482":
description: NotAuthorizedException
content:
application/json:
schema:
$ref: "#/components/schemas/NotAuthorizedException"
examples:
GetUICustomization482Example:
summary: Default GetUICustomization 482 response
x-microcks-default: true
value: example
"483":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
GetUICustomization483Example:
summary: Default GetUICustomization 483 response
x-microcks-default: true
value: example
"484":
description: InternalErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalErrorException"
examples:
GetUICustomization484Example:
summary: Default GetUICustomization 484 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GetUICustomizationRequest"
examples:
GetUICustomizationRequestExample:
summary: Default GetUICustomization request
x-microcks-default: true
value:
UserPoolId: us-east-1_AbCdEfGhI
ClientId: us-east-1_AbCdEfGhI
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSCognitoIdentityProviderService.GetUICustomization
summary: Amazon Cognito Get U I Customization
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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"
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUser:
post:
operationId: GetUser
description: Gets the user attributes and metadata for a user.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetUserResponse"
examples:
GetUser200Example:
summary: Default GetUser 200 response
x-microcks-default: true
value:
Username: my-user-pool
UserAttributes: example-value
MFAOptions: example-value
PreferredMfaSetting: example-value
UserMFASettingList: example-value
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
GetUser480Example:
summary: Default GetUser 480 response
x-microcks-default: true
value: example
"481":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
GetUser481Example:
summary: Default GetUser 481 response
x-microcks-default: true
value: example
"482":
description: NotAuthorizedException
content:
application/json:
schema:
$ref: "#/components/schemas/NotAuthorizedException"
examples:
GetUser482Example:
summary: Default GetUser 482 response
x-microcks-default: true
value: example
"483":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
examples:
GetUser483Example:
summary: Default GetUser 483 response
x-microcks-default: true
value: example
"484":
description: PasswordResetRequiredException
content:
application/json:
schema:
$ref: "#/components/schemas/PasswordResetRequiredException"
examples:
GetUser484Example:
summary: Default GetUser 484 response
x-microcks-default: true
value: example
"485":
description: UserNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/UserNotFoundException"
examples:
GetUser485Example:
summary: Default GetUser 485 response
x-microcks-default: true
value: example
"486":
description: UserNotConfirmedException
content:
application/json:
schema:
$ref: "#/components/schemas/UserNotConfirmedException"
examples:
GetUser486Example:
summary: Default GetUser 486 response
x-microcks-default: true
value: example
"487":
description: InternalErrorException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalErrorException"
examples:
GetUser487Example:
summary: Default GetUser 487 response
x-microcks-default: true
value: example
"488":
description: ForbiddenException
content:
application/json:
schema:
$ref: "#/components/schemas/ForbiddenException"
examples:
GetUser488Example:
summary: Default GetUser 488 response
x-microcks-default: true
value: example
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/GetUserRequest"
examples:
GetUserRequestExample:
summary: Default GetUser request
x-microcks-default: true
value:
AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSCognitoIdentityProviderService.GetUser
summary: Amazon Cognito Get User
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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"
/#X-Amz-Target=AWSCognitoIdentityProviderService.GetUserAttributeVerificationCode:
post:
operationId: GetUserAttributeVerificationCode
description: Generates a user attribute verification code for the specified attribute name. Sends a message to a user with a code that they must return in a VerifyUserAttribute request.
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.
Initiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
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.
Lists the groups associated with a user pool.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListGroupsResponse" examples: ListGroups200Example: summary: Default ListGroups 200 response x-microcks-default: true value: Groups: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListGroups480Example: summary: Default ListGroups 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListGroups481Example: summary: Default ListGroups 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListGroups482Example: summary: Default ListGroups 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListGroups483Example: summary: Default ListGroups 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListGroups484Example: summary: Default ListGroups 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListGroupsRequest" examples: ListGroupsRequestExample: summary: Default ListGroups request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Limit: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: Limit in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListGroups summary: Amazon Cognito List Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListIdentityProviders: post: operationId: ListIdentityProviders description: Lists information about all IdPs for a user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListIdentityProvidersResponse" examples: ListIdentityProviders200Example: summary: Default ListIdentityProviders 200 response x-microcks-default: true value: Providers: us-east-1_AbCdEfGhI NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListIdentityProviders480Example: summary: Default ListIdentityProviders 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListIdentityProviders481Example: summary: Default ListIdentityProviders 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListIdentityProviders482Example: summary: Default ListIdentityProviders 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListIdentityProviders483Example: summary: Default ListIdentityProviders 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListIdentityProviders484Example: summary: Default ListIdentityProviders 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListIdentityProvidersRequest" examples: ListIdentityProvidersRequestExample: summary: Default ListIdentityProviders request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI MaxResults: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListIdentityProviders summary: Amazon Cognito List Identity Providers x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListResourceServers: post: operationId: ListResourceServers description: Lists the resource servers for a user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListResourceServersResponse" examples: ListResourceServers200Example: summary: Default ListResourceServers 200 response x-microcks-default: true value: ResourceServers: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListResourceServers480Example: summary: Default ListResourceServers 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListResourceServers481Example: summary: Default ListResourceServers 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListResourceServers482Example: summary: Default ListResourceServers 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListResourceServers483Example: summary: Default ListResourceServers 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListResourceServers484Example: summary: Default ListResourceServers 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListResourceServersRequest" examples: ListResourceServersRequestExample: summary: Default ListResourceServers request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI MaxResults: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListResourceServers summary: Amazon Cognito List Resource Servers x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListTagsForResource: post: operationId: ListTagsForResource description:Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: Tags: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: example "481": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: example "483": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListTagsForResource483Example: summary: Default ListTagsForResource 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListTagsForResource484Example: summary: Default ListTagsForResource 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceRequest" examples: ListTagsForResourceRequestExample: summary: Default ListTagsForResource request x-microcks-default: true value: ResourceArn: arn:aws:cognito-idp:us-east-1:123456789:userpool/us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListTagsForResource summary: Amazon Cognito List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserImportJobs: post: operationId: ListUserImportJobs description: Lists the user import jobs. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListUserImportJobsResponse" examples: ListUserImportJobs200Example: summary: Default ListUserImportJobs 200 response x-microcks-default: true value: UserImportJobs: example-value PaginationToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListUserImportJobs480Example: summary: Default ListUserImportJobs 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListUserImportJobs481Example: summary: Default ListUserImportJobs 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListUserImportJobs482Example: summary: Default ListUserImportJobs 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListUserImportJobs483Example: summary: Default ListUserImportJobs 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListUserImportJobs484Example: summary: Default ListUserImportJobs 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListUserImportJobsRequest" examples: ListUserImportJobsRequestExample: summary: Default ListUserImportJobs request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI MaxResults: example-value PaginationToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListUserImportJobs summary: Amazon Cognito List User Import Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPoolClients: post: operationId: ListUserPoolClients description: Lists the clients that have been created for the specified user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListUserPoolClientsResponse" examples: ListUserPoolClients200Example: summary: Default ListUserPoolClients 200 response x-microcks-default: true value: UserPoolClients: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListUserPoolClients480Example: summary: Default ListUserPoolClients 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListUserPoolClients481Example: summary: Default ListUserPoolClients 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListUserPoolClients482Example: summary: Default ListUserPoolClients 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListUserPoolClients483Example: summary: Default ListUserPoolClients 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListUserPoolClients484Example: summary: Default ListUserPoolClients 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListUserPoolClientsRequest" examples: ListUserPoolClientsRequestExample: summary: Default ListUserPoolClients request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI MaxResults: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListUserPoolClients summary: Amazon Cognito List User Pool Clients x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUserPools: post: operationId: ListUserPools description: Lists the user pools associated with an Amazon Web Services account. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListUserPoolsResponse" examples: ListUserPools200Example: summary: Default ListUserPools 200 response x-microcks-default: true value: UserPools: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListUserPools480Example: summary: Default ListUserPools 480 response x-microcks-default: true value: example "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListUserPools481Example: summary: Default ListUserPools 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListUserPools482Example: summary: Default ListUserPools 482 response x-microcks-default: true value: example "483": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListUserPools483Example: summary: Default ListUserPools 483 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListUserPoolsRequest" examples: ListUserPoolsRequestExample: summary: Default ListUserPools request x-microcks-default: true value: NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... MaxResults: example-value parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListUserPools summary: Amazon Cognito List User Pools x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUsers: post: operationId: ListUsers description: Lists the users in the Amazon Cognito user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListUsersResponse" examples: ListUsers200Example: summary: Default ListUsers 200 response x-microcks-default: true value: Users: example-value PaginationToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListUsers480Example: summary: Default ListUsers 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListUsers481Example: summary: Default ListUsers 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListUsers482Example: summary: Default ListUsers 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListUsers483Example: summary: Default ListUsers 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListUsers484Example: summary: Default ListUsers 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListUsersRequest" examples: ListUsersRequestExample: summary: Default ListUsers request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI AttributesToGet: example-value Limit: example-value PaginationToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... Filter: example-value parameters: - name: Limit in: query schema: type: string description: Pagination limit required: false - name: PaginationToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListUsers summary: Amazon Cognito List Users x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ListUsersInGroup: post: operationId: ListUsersInGroup description:Lists the users in the specified group.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListUsersInGroupResponse" examples: ListUsersInGroup200Example: summary: Default ListUsersInGroup 200 response x-microcks-default: true value: Users: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ListUsersInGroup480Example: summary: Default ListUsersInGroup 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListUsersInGroup481Example: summary: Default ListUsersInGroup 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: ListUsersInGroup482Example: summary: Default ListUsersInGroup 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: ListUsersInGroup483Example: summary: Default ListUsersInGroup 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: ListUsersInGroup484Example: summary: Default ListUsersInGroup 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ListUsersInGroupRequest" examples: ListUsersInGroupRequestExample: summary: Default ListUsersInGroup request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI GroupName: my-user-pool Limit: example-value NextToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... parameters: - name: Limit in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.ListUsersInGroup summary: Amazon Cognito List Users in Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.ResendConfirmationCode: post: operationId: ResendConfirmationCode description:Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
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.
Responds to the authentication challenge.
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.
Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration
types.
To activate Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
Sets the user interface (UI) customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a
specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration is used for every
client that has no previously set UI customization. If you specify UI customization settings for a particular client, it will no longer return to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
Sets the user pool multi-factor authentication (MFA) configuration.
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.
Registers the user in the specified user pool and creates a user name, password, and user attributes.
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.
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two
versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test
for one user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an Identity and Access Management policy, you can constrain permissions for user pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TagResourceResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: example "481": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: example "483": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: TagResource483Example: summary: Default TagResource 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: TagResource484Example: summary: Default TagResource 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/TagResourceRequest" examples: TagResourceRequestExample: summary: Default TagResource request x-microcks-default: true value: ResourceArn: arn:aws:cognito-idp:us-east-1:123456789:userpool/us-east-1_AbCdEfGhI Tags: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.TagResource summary: Amazon Cognito Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UntagResource: post: operationId: UntagResource description: Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: example "481": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: example "483": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UntagResource483Example: summary: Default UntagResource 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UntagResource484Example: summary: Default UntagResource 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UntagResourceRequest" examples: UntagResourceRequestExample: summary: Default UntagResource request x-microcks-default: true value: ResourceArn: arn:aws:cognito-idp:us-east-1:123456789:userpool/us-east-1_AbCdEfGhI TagKeys: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UntagResource summary: Amazon Cognito Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateAuthEventFeedback: post: operationId: UpdateAuthEventFeedback description: Provides the feedback for an authentication event, whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAuthEventFeedbackResponse" "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateAuthEventFeedback480Example: summary: Default UpdateAuthEventFeedback 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateAuthEventFeedback481Example: summary: Default UpdateAuthEventFeedback 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateAuthEventFeedback482Example: summary: Default UpdateAuthEventFeedback 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UpdateAuthEventFeedback483Example: summary: Default UpdateAuthEventFeedback 483 response x-microcks-default: true value: example "484": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: UpdateAuthEventFeedback484Example: summary: Default UpdateAuthEventFeedback 484 response x-microcks-default: true value: example "485": description: UserPoolAddOnNotEnabledException content: application/json: schema: $ref: "#/components/schemas/UserPoolAddOnNotEnabledException" examples: UpdateAuthEventFeedback485Example: summary: Default UpdateAuthEventFeedback 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UpdateAuthEventFeedback486Example: summary: Default UpdateAuthEventFeedback 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateAuthEventFeedbackRequest" examples: UpdateAuthEventFeedbackRequestExample: summary: Default UpdateAuthEventFeedback request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI Username: my-user-pool EventId: us-east-1_AbCdEfGhI FeedbackToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... FeedbackValue: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UpdateAuthEventFeedback summary: Amazon Cognito Update Auth Event Feedback x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateDeviceStatus: post: operationId: UpdateDeviceStatus description: Updates the device status. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateDeviceStatusResponse" "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateDeviceStatus480Example: summary: Default UpdateDeviceStatus 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateDeviceStatus481Example: summary: Default UpdateDeviceStatus 481 response x-microcks-default: true value: example "482": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UpdateDeviceStatus482Example: summary: Default UpdateDeviceStatus 482 response x-microcks-default: true value: example "483": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: UpdateDeviceStatus483Example: summary: Default UpdateDeviceStatus 483 response x-microcks-default: true value: example "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateDeviceStatus484Example: summary: Default UpdateDeviceStatus 484 response x-microcks-default: true value: example "485": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: UpdateDeviceStatus485Example: summary: Default UpdateDeviceStatus 485 response x-microcks-default: true value: example "486": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: UpdateDeviceStatus486Example: summary: Default UpdateDeviceStatus 486 response x-microcks-default: true value: example "487": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: UpdateDeviceStatus487Example: summary: Default UpdateDeviceStatus 487 response x-microcks-default: true value: example "488": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UpdateDeviceStatus488Example: summary: Default UpdateDeviceStatus 488 response x-microcks-default: true value: example "489": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: UpdateDeviceStatus489Example: summary: Default UpdateDeviceStatus 489 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateDeviceStatusRequest" examples: UpdateDeviceStatusRequestExample: summary: Default UpdateDeviceStatus request x-microcks-default: true value: AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... DeviceKey: example-value DeviceRememberedStatus: CONFIRMED parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UpdateDeviceStatus summary: Amazon Cognito Update Device Status x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateGroup: post: operationId: UpdateGroup description:Updates the specified group with the specified attributes.
Calling this action requires developer credentials.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateGroupResponse" examples: UpdateGroup200Example: summary: Default UpdateGroup 200 response x-microcks-default: true value: Group: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateGroup480Example: summary: Default UpdateGroup 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateGroup481Example: summary: Default UpdateGroup 481 response x-microcks-default: true value: example "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateGroup482Example: summary: Default UpdateGroup 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UpdateGroup483Example: summary: Default UpdateGroup 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UpdateGroup484Example: summary: Default UpdateGroup 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateGroupRequest" examples: UpdateGroupRequestExample: summary: Default UpdateGroup request x-microcks-default: true value: GroupName: my-user-pool UserPoolId: us-east-1_AbCdEfGhI Description: example-value RoleArn: arn:aws:cognito-idp:us-east-1:123456789:userpool/us-east-1_AbCdEfGhI Precedence: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UpdateGroup summary: Amazon Cognito Update Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateIdentityProvider: post: operationId: UpdateIdentityProvider description: Updates IdP information for a user pool. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateIdentityProviderResponse" examples: UpdateIdentityProvider200Example: summary: Default UpdateIdentityProvider 200 response x-microcks-default: true value: IdentityProvider: us-east-1_AbCdEfGhI "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateIdentityProvider480Example: summary: Default UpdateIdentityProvider 480 response x-microcks-default: true value: example "481": description: UnsupportedIdentityProviderException content: application/json: schema: $ref: "#/components/schemas/UnsupportedIdentityProviderException" examples: UpdateIdentityProvider481Example: summary: Default UpdateIdentityProvider 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateIdentityProvider482Example: summary: Default UpdateIdentityProvider 482 response x-microcks-default: true value: example "483": description: ConcurrentModificationException content: application/json: schema: $ref: "#/components/schemas/ConcurrentModificationException" examples: UpdateIdentityProvider483Example: summary: Default UpdateIdentityProvider 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UpdateIdentityProvider484Example: summary: Default UpdateIdentityProvider 484 response x-microcks-default: true value: example "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateIdentityProvider485Example: summary: Default UpdateIdentityProvider 485 response x-microcks-default: true value: example "486": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UpdateIdentityProvider486Example: summary: Default UpdateIdentityProvider 486 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateIdentityProviderRequest" examples: UpdateIdentityProviderRequestExample: summary: Default UpdateIdentityProvider request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ProviderName: my-user-pool ProviderDetails: us-east-1_AbCdEfGhI AttributeMapping: example-value IdpIdentifiers: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UpdateIdentityProvider summary: Amazon Cognito Update Identity Provider x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateResourceServer: post: operationId: UpdateResourceServer description:Updates the name and scopes of resource server. All other fields are read-only.
If you don't provide a value for an attribute, it is set to the default value.
Allows a user to update a specific attribute (one at a time).
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.
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.
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateUserPoolClientResponse" examples: UpdateUserPoolClient200Example: summary: Default UpdateUserPoolClient 200 response x-microcks-default: true value: UserPoolClient: example-value "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateUserPoolClient480Example: summary: Default UpdateUserPoolClient 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateUserPoolClient481Example: summary: Default UpdateUserPoolClient 481 response x-microcks-default: true value: example "482": description: ConcurrentModificationException content: application/json: schema: $ref: "#/components/schemas/ConcurrentModificationException" examples: UpdateUserPoolClient482Example: summary: Default UpdateUserPoolClient 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateUserPoolClient483Example: summary: Default UpdateUserPoolClient 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UpdateUserPoolClient484Example: summary: Default UpdateUserPoolClient 484 response x-microcks-default: true value: example "485": description: ScopeDoesNotExistException content: application/json: schema: $ref: "#/components/schemas/ScopeDoesNotExistException" examples: UpdateUserPoolClient485Example: summary: Default UpdateUserPoolClient 485 response x-microcks-default: true value: example "486": description: InvalidOAuthFlowException content: application/json: schema: $ref: "#/components/schemas/InvalidOAuthFlowException" examples: UpdateUserPoolClient486Example: summary: Default UpdateUserPoolClient 486 response x-microcks-default: true value: example "487": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UpdateUserPoolClient487Example: summary: Default UpdateUserPoolClient 487 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateUserPoolClientRequest" examples: UpdateUserPoolClientRequestExample: summary: Default UpdateUserPoolClient request x-microcks-default: true value: UserPoolId: us-east-1_AbCdEfGhI ClientId: us-east-1_AbCdEfGhI ClientName: my-user-pool RefreshTokenValidity: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... AccessTokenValidity: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... IdTokenValidity: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... TokenValidityUnits: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... ReadAttributes: example-value WriteAttributes: example-value ExplicitAuthFlows: example-value SupportedIdentityProviders: us-east-1_AbCdEfGhI CallbackURLs: example-value LogoutURLs: example-value DefaultRedirectURI: example-value AllowedOAuthFlows: example-value AllowedOAuthScopes: example-value AllowedOAuthFlowsUserPoolClient: example-value AnalyticsConfiguration: example-value PreventUserExistenceErrors: example-value EnableTokenRevocation: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... EnablePropagateAdditionalUserContextData: example-value AuthSessionValidity: us-east-1_AbCdEfGhI parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UpdateUserPoolClient summary: Amazon Cognito Update User Pool Client x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateUserPoolDomain: post: operationId: UpdateUserPoolDomain description:Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.
You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.
A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.
Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.
However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.
When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.
After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateUserPoolDomainResponse" examples: UpdateUserPoolDomain200Example: summary: Default UpdateUserPoolDomain 200 response x-microcks-default: true value: CloudFrontDomain: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateUserPoolDomain480Example: summary: Default UpdateUserPoolDomain 480 response x-microcks-default: true value: example "481": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: UpdateUserPoolDomain481Example: summary: Default UpdateUserPoolDomain 481 response x-microcks-default: true value: example "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateUserPoolDomain482Example: summary: Default UpdateUserPoolDomain 482 response x-microcks-default: true value: example "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: UpdateUserPoolDomain483Example: summary: Default UpdateUserPoolDomain 483 response x-microcks-default: true value: example "484": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: UpdateUserPoolDomain484Example: summary: Default UpdateUserPoolDomain 484 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/UpdateUserPoolDomainRequest" examples: UpdateUserPoolDomainRequestExample: summary: Default UpdateUserPoolDomain request x-microcks-default: true value: Domain: example-value UserPoolId: us-east-1_AbCdEfGhI CustomDomainConfig: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.UpdateUserPoolDomain summary: Amazon Cognito Update User Pool Domain x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.VerifySoftwareToken: post: operationId: VerifySoftwareToken description: Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/VerifySoftwareTokenResponse" examples: VerifySoftwareToken200Example: summary: Default VerifySoftwareToken 200 response x-microcks-default: true value: Status: CONFIRMED Session: example-value "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: VerifySoftwareToken480Example: summary: Default VerifySoftwareToken 480 response x-microcks-default: true value: example "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: VerifySoftwareToken481Example: summary: Default VerifySoftwareToken 481 response x-microcks-default: true value: example "482": description: InvalidUserPoolConfigurationException content: application/json: schema: $ref: "#/components/schemas/InvalidUserPoolConfigurationException" examples: VerifySoftwareToken482Example: summary: Default VerifySoftwareToken 482 response x-microcks-default: true value: example "483": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: VerifySoftwareToken483Example: summary: Default VerifySoftwareToken 483 response x-microcks-default: true value: example "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: VerifySoftwareToken484Example: summary: Default VerifySoftwareToken 484 response x-microcks-default: true value: example "485": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: VerifySoftwareToken485Example: summary: Default VerifySoftwareToken 485 response x-microcks-default: true value: example "486": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: VerifySoftwareToken486Example: summary: Default VerifySoftwareToken 486 response x-microcks-default: true value: example "487": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: VerifySoftwareToken487Example: summary: Default VerifySoftwareToken 487 response x-microcks-default: true value: example "488": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: VerifySoftwareToken488Example: summary: Default VerifySoftwareToken 488 response x-microcks-default: true value: example "489": description: EnableSoftwareTokenMFAException content: application/json: schema: $ref: "#/components/schemas/EnableSoftwareTokenMFAException" examples: VerifySoftwareToken489Example: summary: Default VerifySoftwareToken 489 response x-microcks-default: true value: example "490": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: VerifySoftwareToken490Example: summary: Default VerifySoftwareToken 490 response x-microcks-default: true value: example "491": description: SoftwareTokenMFANotFoundException content: application/json: schema: $ref: "#/components/schemas/SoftwareTokenMFANotFoundException" examples: VerifySoftwareToken491Example: summary: Default VerifySoftwareToken 491 response x-microcks-default: true value: example "492": description: CodeMismatchException content: application/json: schema: $ref: "#/components/schemas/CodeMismatchException" examples: VerifySoftwareToken492Example: summary: Default VerifySoftwareToken 492 response x-microcks-default: true value: example "493": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: VerifySoftwareToken493Example: summary: Default VerifySoftwareToken 493 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/VerifySoftwareTokenRequest" examples: VerifySoftwareTokenRequestExample: summary: Default VerifySoftwareToken request x-microcks-default: true value: AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... Session: example-value UserCode: example-value FriendlyDeviceName: my-user-pool parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.VerifySoftwareToken summary: Amazon Cognito Verify Software Token x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" /#X-Amz-Target=AWSCognitoIdentityProviderService.VerifyUserAttribute: post: operationId: VerifyUserAttribute description:Verifies the specified user attributes in the user pool.
If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/VerifyUserAttributeResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: VerifyUserAttribute480Example: summary: Default VerifyUserAttribute 480 response x-microcks-default: true value: example "481": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: VerifyUserAttribute481Example: summary: Default VerifyUserAttribute 481 response x-microcks-default: true value: example "482": description: CodeMismatchException content: application/json: schema: $ref: "#/components/schemas/CodeMismatchException" examples: VerifyUserAttribute482Example: summary: Default VerifyUserAttribute 482 response x-microcks-default: true value: example "483": description: ExpiredCodeException content: application/json: schema: $ref: "#/components/schemas/ExpiredCodeException" examples: VerifyUserAttribute483Example: summary: Default VerifyUserAttribute 483 response x-microcks-default: true value: example "484": description: NotAuthorizedException content: application/json: schema: $ref: "#/components/schemas/NotAuthorizedException" examples: VerifyUserAttribute484Example: summary: Default VerifyUserAttribute 484 response x-microcks-default: true value: example "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" examples: VerifyUserAttribute485Example: summary: Default VerifyUserAttribute 485 response x-microcks-default: true value: example "486": description: LimitExceededException content: application/json: schema: $ref: "#/components/schemas/LimitExceededException" examples: VerifyUserAttribute486Example: summary: Default VerifyUserAttribute 486 response x-microcks-default: true value: example "487": description: PasswordResetRequiredException content: application/json: schema: $ref: "#/components/schemas/PasswordResetRequiredException" examples: VerifyUserAttribute487Example: summary: Default VerifyUserAttribute 487 response x-microcks-default: true value: example "488": description: UserNotFoundException content: application/json: schema: $ref: "#/components/schemas/UserNotFoundException" examples: VerifyUserAttribute488Example: summary: Default VerifyUserAttribute 488 response x-microcks-default: true value: example "489": description: UserNotConfirmedException content: application/json: schema: $ref: "#/components/schemas/UserNotConfirmedException" examples: VerifyUserAttribute489Example: summary: Default VerifyUserAttribute 489 response x-microcks-default: true value: example "490": description: InternalErrorException content: application/json: schema: $ref: "#/components/schemas/InternalErrorException" examples: VerifyUserAttribute490Example: summary: Default VerifyUserAttribute 490 response x-microcks-default: true value: example "491": description: AliasExistsException content: application/json: schema: $ref: "#/components/schemas/AliasExistsException" examples: VerifyUserAttribute491Example: summary: Default VerifyUserAttribute 491 response x-microcks-default: true value: example "492": description: ForbiddenException content: application/json: schema: $ref: "#/components/schemas/ForbiddenException" examples: VerifyUserAttribute492Example: summary: Default VerifyUserAttribute 492 response x-microcks-default: true value: example requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/VerifyUserAttributeRequest" examples: VerifyUserAttributeRequestExample: summary: Default VerifyUserAttribute request x-microcks-default: true value: AccessToken: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9... AttributeName: my-user-pool Code: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSCognitoIdentityProviderService.VerifyUserAttribute summary: Amazon Cognito Verify User Attribute x-microcks-operation: delay: 0 dispatcher: FALLBACK 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" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential 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-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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 schemas: AddCustomAttributesResponse: type: object properties: {} description: Represents the response from the server for the request to add custom attributes. AddCustomAttributesRequest: type: object required: - UserPoolId - CustomAttributes title: AddCustomAttributesRequest properties: UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID for the user pool where you want to add custom attributes. CustomAttributes: allOf: - $ref: "#/components/schemas/CustomAttributesListType" - description: An array of custom attributes, such as Mutable and Name. description: Represents the request to add custom attributes. ResourceNotFoundException: {} InvalidParameterException: {} TooManyRequestsException: {} NotAuthorizedException: {} UserImportInProgressException: {} InternalErrorException: {} AdminAddUserToGroupRequest: type: object required: - UserPoolId - Username - GroupName title: AdminAddUserToGroupRequest properties: UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID for the user pool. Username: allOf: - $ref: "#/components/schemas/UsernameType" - description: The username for the user. GroupName: allOf: - $ref: "#/components/schemas/GroupNameType" - description: The group name. UserNotFoundException: {} AdminConfirmSignUpResponse: type: object properties: {} description: Represents the response from the server for the request to confirm registration. AdminConfirmSignUpRequest: type: object required: - UserPoolId - Username title: AdminConfirmSignUpRequest properties: UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID for which you want to confirm user registration. Username: allOf: - $ref: "#/components/schemas/UsernameType" - description: The user name for which you want to confirm user registration. ClientMetadata: allOf: - $ref: "#/components/schemas/ClientMetadataType" - description: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, remember 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 use Amazon Cognito to provide sensitive information.
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.
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.
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data isn't persisted.
TemporaryPassword: allOf: - $ref: "#/components/schemas/PasswordType" - description:The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
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.
This parameter isn't required. If you don't specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration
limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND"
for the MessageAction parameter.
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, the API
call will migrate 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.
RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to SUPPRESS to
suppress sending the message. You can specify only one value.
DesiredDeliveryMediums:
allOf:
- $ref: "#/components/schemas/DeliveryMediumListType"
- description: 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.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: 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, remember 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 use Amazon Cognito to provide sensitive information.
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.
enabled.
UserStatus:
allOf:
- $ref: "#/components/schemas/UserStatusType"
- description: The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
SMS_MFA and SOFTWARE_TOKEN_MFA.
description: Represents the response from the server from the request to get the specified user as an administrator.
AdminGetUserRequest:
type: object
required:
- UserPoolId
- Username
title: AdminGetUserRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool where you want to get information about the user.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name of the user you want to retrieve.
description: Represents the request to get the specified user as an administrator.
AdminInitiateAuthResponse:
type: object
properties:
ChallengeName:
allOf:
- $ref: "#/components/schemas/ChallengeNameType"
- description: "The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth response if you must pass another challenge.
MFA_SETUP: If MFA is required, users who don't have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up
at least one MFA type to continue to authenticate.
SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA
for time-based one-time password (TOTP) software token MFA.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side
SRP calculations.
CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens
are issued.
DEVICE_SRP_AUTH: If device tracking was activated in your user pool and the previous challenges were passed, this challenge is returned so that
Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful first login. Respond to this challenge with NEW_PASSWORD
and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You can also set values for attributes that aren't required by your user pool and
that your app client can write. For more information, see AdminRespondToAuthChallenge.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In AdminRespondToAuthChallenge, set a value
for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional
attributes.
MFA_SETUP: For users who are required to set up an MFA factor before they can sign in. The MFA types activated for the user pool will be
listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken,
and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP to complete sign-in. To set up
SMS MFA, users will need help from an administrator to add a phone number to their account and then call InitiateAuth again to restart sign-in.
AdminInitiateAuth or AdminRespondToAuthChallenge API call
determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next
AdminRespondToAuthChallenge API call.
ChallengeParameters:
allOf:
- $ref: "#/components/schemas/ChallengeParametersType"
- description: The challenge parameters. These are returned to you in the AdminInitiateAuth response if you must pass another challenge. The responses in this parameter
should be used to compute inputs to the next call (AdminRespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if
applicable).
The value of the USER_ID_FOR_SRP attribute is the user's actual username, not an alias (such as email address or phone number), even if you specified an
alias in your call to AdminInitiateAuth. This happens because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME
attribute can't be an alias.
ChallengeName, ChallengeParameters, and Session are returned.
description: Initiates the authentication response, as an administrator.
AdminInitiateAuthRequest:
type: object
required:
- UserPoolId
- ClientId
- AuthFlow
title: AdminInitiateAuthRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The ID of the Amazon Cognito user pool.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The app client ID.
AuthFlow:
allOf:
- $ref: "#/components/schemas/AuthFlowType"
- description: "The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH will take in a valid refresh
token and return new tokens.
USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure Remote Password (SRP) protocol variables
to be used for next challenge execution.
ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge
or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN:
Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
ADMIN_USER_PASSWORD_AUTH:
Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of
using the SRP process to verify passwords.
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_SRP_AUTH: USERNAME (required), SRP_A (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 ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app
client is configured with client secret), PASSWORD (required), 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).
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
Verify auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
AdminInitiateAuth calls.
ContextData:
allOf:
- $ref: "#/components/schemas/ContextDataType"
- description: 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.
description: Initiates the authorization request, as an administrator.
MFAMethodNotFoundException: {}
PasswordResetRequiredException: {}
UserNotConfirmedException: {}
AdminLinkProviderForUserResponse:
type: object
properties: {}
AdminLinkProviderForUserRequest:
type: object
required:
- UserPoolId
- DestinationUser
- SourceUser
title: AdminLinkProviderForUserRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/StringType"
- description: The user pool ID for the user pool.
DestinationUser:
allOf:
- $ref: "#/components/schemas/ProviderUserIdentifierType"
- description: The existing user in the user pool that you want to assign to the external IdP user account. This user can be a native (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.
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 SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you want to link SAML users based on the subject of the SAML
assertion, you should map the subject to a claim through the SAML IdP and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName
to Cognito_Subject, Amazon Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
EventID, EventType, CreationDate, EventRisk, and EventResponse.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKey"
- description: A pagination token.
AdminListUserAuthEventsRequest:
type: object
required:
- UserPoolId
- Username
title: AdminListUserAuthEventsRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user pool username or an alias.
MaxResults:
allOf:
- $ref: "#/components/schemas/QueryLimitType"
- description: 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.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKey"
- description: A pagination token.
UserPoolAddOnNotEnabledException: {}
AdminRemoveUserFromGroupRequest:
type: object
required:
- UserPoolId
- Username
- GroupName
title: AdminRemoveUserFromGroupRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The username for the user.
GroupName:
allOf:
- $ref: "#/components/schemas/GroupNameType"
- description: The group name.
AdminResetUserPasswordResponse:
type: object
properties: {}
description: Represents the response from the server to reset a user password as an administrator.
AdminResetUserPasswordRequest:
type: object
required:
- UserPoolId
- Username
title: AdminResetUserPasswordRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool where you want to reset the user's password.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name of the user whose password you want to reset.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: 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 AdminResetUserPassword 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 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, remember 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 use Amazon Cognito to provide sensitive information.
RespondToAuthChallenge API call.
ChallengeParameters:
allOf:
- $ref: "#/components/schemas/ChallengeParametersType"
- description: The challenge parameters. For more information, see AdminInitiateAuth.
AuthenticationResult:
allOf:
- $ref: "#/components/schemas/AuthenticationResultType"
- description: The result returned by the server in response to the authentication request.
description: Responds to the authentication challenge, as an administrator.
AdminRespondToAuthChallengeRequest:
type: object
required:
- UserPoolId
- ClientId
- ChallengeName
title: AdminRespondToAuthChallengeRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The ID of the Amazon Cognito user pool.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The app client ID.
ChallengeName:
allOf:
- $ref: "#/components/schemas/ChallengeNameType"
- description: The challenge name. For more information, see AdminInitiateAuth.
ChallengeResponses:
allOf:
- $ref: "#/components/schemas/ChallengeResponsesType"
- description: "The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SMS_MFA: SMS_MFA_CODE,
USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE,
PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).
PASSWORD_VERIFIER
requires DEVICE_KEY when signing in with a remembered device.
ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH
(if app client is configured with client secret).
NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app
client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth response, add
a userAttributes.attributename parameter. 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 AdminRespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the
requiredAttributes parameter, then use the AdminUpdateUserAttributes API operation to modify the value of any additional attributes.
MFA_SETUP
requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
The value of the
USERNAME attribute must be the user's actual username, not an alias (such as an email address or phone number). To make this simpler, the AdminInitiateAuth response
includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an alias in your call to AdminInitiateAuth.
InitiateAuth or RespondToAuthChallenge API call
determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next
RespondToAuthChallenge API call.
AnalyticsMetadata:
allOf:
- $ref: "#/components/schemas/AnalyticsMetadataType"
- description: The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
ContextData:
allOf:
- $ref: "#/components/schemas/ContextDataType"
- description: 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.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: "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, remember 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 use Amazon Cognito to provide sensitive information.
True if the password is permanent, False if it is temporary."
AdminSetUserSettingsResponse:
type: object
properties: {}
description: Represents the response from the server to set user settings as an administrator.
AdminSetUserSettingsRequest:
type: object
required:
- UserPoolId
- Username
- MFAOptions
title: AdminSetUserSettingsRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The ID of the user pool that contains the user whose options you're setting.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name of the user whose options you're setting.
MFAOptions:
allOf:
- $ref: "#/components/schemas/MFAOptionListType"
- description: You can use this parameter only to set an SMS configuration that uses SMS for delivery.
description: You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
AdminUpdateAuthEventFeedbackResponse:
type: object
properties: {}
AdminUpdateAuthEventFeedbackRequest:
type: object
required:
- UserPoolId
- Username
- EventId
- FeedbackValue
title: AdminUpdateAuthEventFeedbackRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user pool username.
EventId:
allOf:
- $ref: "#/components/schemas/EventIdType"
- description: The authentication event ID.
FeedbackValue:
allOf:
- $ref: "#/components/schemas/FeedbackValueType"
- description: The authentication event feedback value.
AdminUpdateDeviceStatusResponse:
type: object
properties: {}
description: The status response to the request to update the device, as an administrator.
AdminUpdateDeviceStatusRequest:
type: object
required:
- UserPoolId
- Username
- DeviceKey
title: AdminUpdateDeviceStatusRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name.
DeviceKey:
allOf:
- $ref: "#/components/schemas/DeviceKeyType"
- description: The device key.
DeviceRememberedStatus:
allOf:
- $ref: "#/components/schemas/DeviceRememberedStatusType"
- description: The status indicating whether a device has been remembered or not.
description: The request to update the device status, as an administrator.
AdminUpdateUserAttributesResponse:
type: object
properties: {}
description: Represents the response from the server for the request to update user attributes as an administrator.
AdminUpdateUserAttributesRequest:
type: object
required:
- UserPoolId
- Username
- UserAttributes
title: AdminUpdateUserAttributesRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool where you want to update user attributes.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name of the user for whom you want to update user attributes.
UserAttributes:
allOf:
- $ref: "#/components/schemas/AttributeListType"
- description: 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 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.
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, remember 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 use Amazon Cognito to provide sensitive information.
ConfirmForgotPassword calls.
UserContextData:
allOf:
- $ref: "#/components/schemas/UserContextDataType"
- description: 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.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: 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, remember 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 use Amazon Cognito to provide sensitive information.
False. If this parameter is set to True and the
phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user
being confirmed. If set to False, the API will throw an AliasExistsException error.
AnalyticsMetadata:
allOf:
- $ref: "#/components/schemas/AnalyticsMetadataType"
- description: The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
UserContextData:
allOf:
- $ref: "#/components/schemas/UserContextDataType"
- description: 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.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: 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, remember 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 use Amazon Cognito to provide sensitive information.
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.
The IdP details. The following list describes the provider detail keys for each IdP type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
authorize_scopes
For OpenID Connect (OIDC) providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if
Amazon Cognito didn't discover them at the oidc_issuer URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
https://my-weather-api.example.com.
Name:
allOf:
- $ref: "#/components/schemas/ResourceServerNameType"
- description: A friendly name for the resource server.
Scopes:
allOf:
- $ref: "#/components/schemas/ResourceServerScopeListType"
- description: A list of scopes. Each scope is a key-value map with the keys name and description.
CreateUserImportJobResponse:
type: object
properties:
UserImportJob:
allOf:
- $ref: "#/components/schemas/UserImportJobType"
- description: The job object that represents the user import job.
description: Represents the response from the server to the request to create the user import job.
CreateUserImportJobRequest:
type: object
required:
- JobName
- UserPoolId
- CloudWatchLogsRoleArn
title: CreateUserImportJobRequest
properties:
JobName:
allOf:
- $ref: "#/components/schemas/UserImportJobNameType"
- description: The job name for the user import job.
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool that the users are being imported into.
CloudWatchLogsRoleArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The role ARN for the Amazon CloudWatch Logs Logging role for the user import job.
description: Represents the request to create the user import job.
CreateUserPoolResponse:
type: object
properties:
UserPool:
allOf:
- $ref: "#/components/schemas/UserPoolType"
- description: A container for the user pool details.
description: Represents the response from the server for the request to create a user pool.
CreateUserPoolRequest:
type: object
required:
- PoolName
title: CreateUserPoolRequest
properties:
PoolName:
allOf:
- $ref: "#/components/schemas/UserPoolNameType"
- description: A string used to name the user pool.
Policies:
allOf:
- $ref: "#/components/schemas/UserPoolPolicyType"
- description: The policies associated with the new user pool.
DeletionProtection:
allOf:
- $ref: "#/components/schemas/DeletionProtectionType"
- description: 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.
The Lambda trigger configuration information for the new user pool.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the CLI, see add-permission .
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.
DeviceConfiguration:
allOf:
- $ref: "#/components/schemas/DeviceConfigurationType"
- description: 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.
Schema:
allOf:
- $ref: "#/components/schemas/SchemaAttributesListType"
- description: An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
UserPoolAddOns:
allOf:
- $ref: "#/components/schemas/UserPoolAddOnsType"
- description: Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
UsernameConfiguration:
allOf:
- $ref: "#/components/schemas/UsernameConfigurationType"
- description: Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either
"username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
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 create a user pool.
UserPoolTaggingException: {}
CreateUserPoolClientResponse:
type: object
properties:
UserPoolClient:
allOf:
- $ref: "#/components/schemas/UserPoolClientType"
- description: The user pool client that was just created.
description: Represents the response from the server to create a user pool client.
CreateUserPoolClientRequest:
type: object
required:
- UserPoolId
- ClientName
title: CreateUserPoolClientRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool where you want to create a user pool client.
ClientName:
allOf:
- $ref: "#/components/schemas/ClientNameType"
- description: The client name for the user pool client you would like to create.
GenerateSecret:
allOf:
- $ref: "#/components/schemas/GenerateSecret"
- description: Boolean to specify whether you want to generate a secret for the user pool client being created.
RefreshTokenValidity:
allOf:
- $ref: "#/components/schemas/RefreshTokenValidityType"
- description: 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.
AccessTokenValidity: allOf: - $ref: "#/components/schemas/AccessTokenValidityType" - description: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.
IdTokenValidity: allOf: - $ref: "#/components/schemas/IdTokenValidityType" - description: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 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 ID tokens are valid for one hour.
TokenValidityUnits: allOf: - $ref: "#/components/schemas/TokenValidityUnitsType" - description: The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours. ReadAttributes: allOf: - $ref: "#/components/schemas/ClientPermissionListType" - description: The read attributes. WriteAttributes: allOf: - $ref: "#/components/schemas/ClientPermissionListType" - description:The user pool attributes that the app client can write to.
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.
ExplicitAuthFlows: allOf: - $ref: "#/components/schemas/ExplicitAuthFlowsListType" - description: "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_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.
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."
CallbackURLs:
allOf:
- $ref: "#/components/schemas/CallbackURLsListType"
- description: A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
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.
LogoutURLs: allOf: - $ref: "#/components/schemas/LogoutURLsListType" - description: A list of allowed logout URLs for the IdPs. DefaultRedirectURI: allOf: - $ref: "#/components/schemas/RedirectUrlType" - description:The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
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.
AllowedOAuthFlows: allOf: - $ref: "#/components/schemas/OAuthFlowsType" - description:The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
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.
AllowedOAuthFlowsUserPoolClient:
allOf:
- $ref: "#/components/schemas/BooleanType"
- description: Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
AnalyticsConfiguration:
allOf:
- $ref: "#/components/schemas/AnalyticsConfigurationType"
- description: 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 only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
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.
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.
EnablePropagateAdditionalUserContextData: allOf: - $ref: "#/components/schemas/WrappedBooleanType" - description: 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 activateEnablePropagateAdditionalUserContextData in an app client that has a client secret.
AuthSessionValidity:
allOf:
- $ref: "#/components/schemas/AuthSessionValidityType"
- description: 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.
description: Represents the request to create a user pool client.
ScopeDoesNotExistException: {}
InvalidOAuthFlowException: {}
CreateUserPoolDomainResponse:
type: object
properties:
CloudFrontDomain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
CreateUserPoolDomainRequest:
type: object
required:
- Domain
- UserPoolId
title: CreateUserPoolDomainRequest
properties:
Domain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The domain string. 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.
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
CustomDomainConfig:
allOf:
- $ref: "#/components/schemas/CustomDomainConfigType"
- description: The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
DeleteGroupRequest: type: object required: - GroupName - UserPoolId title: DeleteGroupRequest properties: GroupName: allOf: - $ref: "#/components/schemas/GroupNameType" - description: The name of the group. UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID for the user pool. DeleteIdentityProviderRequest: type: object required: - UserPoolId - ProviderName title: DeleteIdentityProviderRequest properties: UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID. ProviderName: allOf: - $ref: "#/components/schemas/ProviderNameType" - description: The IdP name. UnsupportedIdentityProviderException: {} DeleteResourceServerRequest: type: object required: - UserPoolId - Identifier title: DeleteResourceServerRequest properties: UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID for the user pool that hosts the resource server. Identifier: allOf: - $ref: "#/components/schemas/ResourceServerIdentifierType" - description: The identifier for the resource server. DeleteUserRequest: type: object required: - AccessToken title: DeleteUserRequest properties: AccessToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: A valid access token that Amazon Cognito issued to the user whose user profile you want to delete. description: Represents the request to delete a user. DeleteUserAttributesResponse: type: object properties: {} description: Represents the response from the server to delete user attributes. DeleteUserAttributesRequest: type: object required: - UserAttributeNames - AccessToken title: DeleteUserAttributesRequest properties: UserAttributeNames: allOf: - $ref: "#/components/schemas/AttributeNameListType" - description:An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prependattach the custom: prefix to the
front of the attribute name.
auth.example.com. For Amazon Cognito prefix domains, this is the prefix
alone, such as auth.
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
DescribeIdentityProviderResponse:
type: object
required:
- IdentityProvider
properties:
IdentityProvider:
allOf:
- $ref: "#/components/schemas/IdentityProviderType"
- description: The identity provider details.
DescribeIdentityProviderRequest:
type: object
required:
- UserPoolId
- ProviderName
title: DescribeIdentityProviderRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
ProviderName:
allOf:
- $ref: "#/components/schemas/ProviderNameType"
- description: The IdP name.
DescribeResourceServerResponse:
type: object
required:
- ResourceServer
properties:
ResourceServer:
allOf:
- $ref: "#/components/schemas/ResourceServerType"
- description: The resource server.
DescribeResourceServerRequest:
type: object
required:
- UserPoolId
- Identifier
title: DescribeResourceServerRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool that hosts the resource server.
Identifier:
allOf:
- $ref: "#/components/schemas/ResourceServerIdentifierType"
- description: The identifier for the resource server
DescribeRiskConfigurationResponse:
type: object
required:
- RiskConfiguration
properties:
RiskConfiguration:
allOf:
- $ref: "#/components/schemas/RiskConfigurationType"
- description: The risk configuration.
DescribeRiskConfigurationRequest:
type: object
required:
- UserPoolId
title: DescribeRiskConfigurationRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The app client ID.
DescribeUserImportJobResponse:
type: object
properties:
UserImportJob:
allOf:
- $ref: "#/components/schemas/UserImportJobType"
- description: The job object that represents the user import job.
description: Represents the response from the server to the request to describe the user import job.
DescribeUserImportJobRequest:
type: object
required:
- UserPoolId
- JobId
title: DescribeUserImportJobRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool that the users are being imported into.
JobId:
allOf:
- $ref: "#/components/schemas/UserImportJobIdType"
- description: The job ID for the user import job.
description: Represents the request to describe the user import job.
DescribeUserPoolResponse:
type: object
properties:
UserPool:
allOf:
- $ref: "#/components/schemas/UserPoolType"
- description: The container of metadata returned by the server to describe the pool.
description: Represents the response to describe the user pool.
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.
DescribeUserPoolClientResponse:
type: object
properties:
UserPoolClient:
allOf:
- $ref: "#/components/schemas/UserPoolClientType"
- description: The user pool client from a server response to describe the user pool client.
description: Represents the response from the server from a request to describe the user pool client.
DescribeUserPoolClientRequest:
type: object
required:
- UserPoolId
- ClientId
title: DescribeUserPoolClientRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool you want to describe.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The app client ID of the app associated with the user pool.
description: Represents the request to describe a user pool client.
DescribeUserPoolDomainResponse:
type: object
properties:
DomainDescription:
allOf:
- $ref: "#/components/schemas/DomainDescriptionType"
- description: A domain description object containing information about the domain.
DescribeUserPoolDomainRequest:
type: object
required:
- Domain
title: DescribeUserPoolDomainRequest
properties:
Domain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The domain string. 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.
ForgetDeviceRequest:
type: object
required:
- DeviceKey
title: ForgetDeviceRequest
properties:
AccessToken:
allOf:
- $ref: "#/components/schemas/TokenModelType"
- description: A valid access token that Amazon Cognito issued to the user whose registered device you want to forget.
DeviceKey:
allOf:
- $ref: "#/components/schemas/DeviceKeyType"
- description: The device key.
description: Represents the request to forget the device.
ForgotPasswordResponse:
type: object
properties:
CodeDeliveryDetails:
allOf:
- $ref: "#/components/schemas/CodeDeliveryDetailsType"
- description: The code delivery details returned by the server in response to the request to reset a password.
description: The response from Amazon Cognito to a request to reset a password.
ForgotPasswordRequest:
type: object
required:
- ClientId
- Username
title: ForgotPasswordRequest
properties:
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The ID of the client associated with the user pool.
SecretHash:
allOf:
- $ref: "#/components/schemas/SecretHashType"
- description: 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.
UserContextData:
allOf:
- $ref: "#/components/schemas/UserContextDataType"
- description: 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.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name of the user for whom you want to enter a code to reset a forgotten password.
AnalyticsMetadata:
allOf:
- $ref: "#/components/schemas/AnalyticsMetadataType"
- description: The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: "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, remember 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 use Amazon Cognito to provide sensitive information.
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
SMS_MFA and SOFTWARE_TOKEN_MFA.
description: Represents the response from the server from the request to get information about the user.
GetUserRequest:
type: object
required:
- AccessToken
title: GetUserRequest
properties:
AccessToken:
allOf:
- $ref: "#/components/schemas/TokenModelType"
- description: A non-expired access token for the user whose information you want to query.
description: Represents the request to get information about the user.
GetUserAttributeVerificationCodeResponse:
type: object
properties:
CodeDeliveryDetails:
allOf:
- $ref: "#/components/schemas/CodeDeliveryDetailsType"
- description: The code delivery details returned by the server in response to the request to get the user attribute verification code.
description: The verification code response returned by the server response to get the user attribute verification code.
GetUserAttributeVerificationCodeRequest:
type: object
required:
- AccessToken
- AttributeName
title: GetUserAttributeVerificationCodeRequest
properties:
AccessToken:
allOf:
- $ref: "#/components/schemas/TokenModelType"
- description: A non-expired access token for the user whose attribute verification code you want to generate.
AttributeName:
allOf:
- $ref: "#/components/schemas/AttributeNameType"
- description: The attribute name returned by the server response to get the user attribute verification code.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger.
When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides
the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the
clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
The multi-factor authentication (MFA) configuration. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
The name of the challenge that you're responding to with this call. This name is returned in the AdminInitiateAuth response if you must pass another challenge.
Valid values include the following:
All of the following challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.
SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
PASSWORD_VERIFIER: Next challenge is to supply
PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
CUSTOM_CHALLENGE:
This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
DEVICE_SRP_AUTH: If device
tracking was activated on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DEVICE_PASSWORD_VERIFIER:
Similar to PASSWORD_VERIFIER, but for devices only.
NEW_PASSWORD_REQUIRED: For users who are required to change their passwords after successful
first login.
Respond to this challenge with NEW_PASSWORD and any required attributes that Amazon Cognito returned in the requiredAttributes parameter. You
can also set values for attributes that aren't required by your user pool and that your app client can write. For more information, see RespondToAuthChallenge.
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.
MFA_SETUP: For users who are required to setup an MFA factor before they can sign in. The MFA types activated for the user
pool will be listed in the challenge parameters MFA_CAN_SETUP value.
To set up software token MFA, use the session returned here from InitiateAuth as an
input to AssociateSoftwareToken. Use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge with challenge name MFA_SETUP
to complete sign-in. To set up SMS MFA, an administrator should help the user to add a phone number to their account, and then the user should call InitiateAuth again to restart
sign-in.
RespondToAuthChallenge API call.
ChallengeParameters:
allOf:
- $ref: "#/components/schemas/ChallengeParametersType"
- description: The challenge parameters. These are returned in the InitiateAuth response if you must pass another challenge. The responses in this parameter should be used to
compute inputs to the next call (RespondToAuthChallenge).
All challenges require USERNAME and SECRET_HASH (if applicable).
ChallengeName, ChallengeParameters, and Session are returned.
description: Initiates the authentication response.
InitiateAuthRequest:
type: object
required:
- AuthFlow
- ClientId
title: InitiateAuthRequest
properties:
AuthFlow:
allOf:
- $ref: "#/components/schemas/AuthFlowType"
- description: "The authentication flow for this call to run. The API action will depend on this value. For example:
REFRESH_TOKEN_AUTH takes in a valid refresh
token and returns new tokens.
USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge
execution.
USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns the next challenge or tokens.
Valid values include:
USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
REFRESH_TOKEN_AUTH/REFRESH_TOKEN:
Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.
CUSTOM_AUTH: Custom authentication flow.
USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration
Lambda if it doesn't find the user name in the user pool.
ADMIN_NO_SRP_AUTH isn't a valid value.
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_SRP_AUTH: USERNAME (required), SRP_A (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).
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 InitiateAuth 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 InitiateAuth 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 InitiateAuth 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
Verify auth challenge
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
InitiateAuth calls.
UserContextData:
allOf:
- $ref: "#/components/schemas/UserContextDataType"
- description: 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.
description: Initiates the authentication request.
ListDevicesResponse:
type: object
properties:
Devices:
allOf:
- $ref: "#/components/schemas/DeviceListType"
- description: The devices returned in the list devices response.
PaginationToken:
allOf:
- $ref: "#/components/schemas/SearchPaginationTokenType"
- description: The pagination token for the list device response.
description: Represents the response to list devices.
ListDevicesRequest:
type: object
required:
- AccessToken
title: ListDevicesRequest
properties:
AccessToken:
allOf:
- $ref: "#/components/schemas/TokenModelType"
- description: A valid access token that Amazon Cognito issued to the user whose list of devices you want to view.
Limit:
allOf:
- $ref: "#/components/schemas/QueryLimitType"
- description: The limit of the device request.
PaginationToken:
allOf:
- $ref: "#/components/schemas/SearchPaginationTokenType"
- description: The pagination token for the list request.
description: Represents the request to list the devices.
ListGroupsResponse:
type: object
properties:
Groups:
allOf:
- $ref: "#/components/schemas/GroupListType"
- description: The group objects for the groups.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKey"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
ListGroupsRequest:
type: object
required:
- UserPoolId
title: ListGroupsRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool.
Limit:
allOf:
- $ref: "#/components/schemas/QueryLimitType"
- description: The limit of the request to list groups.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKey"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
ListIdentityProvidersResponse:
type: object
required:
- Providers
properties:
Providers:
allOf:
- $ref: "#/components/schemas/ProvidersListType"
- description: A list of IdP objects.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: A pagination token.
ListIdentityProvidersRequest:
type: object
required:
- UserPoolId
title: ListIdentityProvidersRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
MaxResults:
allOf:
- $ref: "#/components/schemas/ListProvidersLimitType"
- description: The maximum number of IdPs to return.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: A pagination token.
ListResourceServersResponse:
type: object
required:
- ResourceServers
properties:
ResourceServers:
allOf:
- $ref: "#/components/schemas/ResourceServersListType"
- description: The resource servers.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: A pagination token.
ListResourceServersRequest:
type: object
required:
- UserPoolId
title: ListResourceServersRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool.
MaxResults:
allOf:
- $ref: "#/components/schemas/ListResourceServersLimitType"
- description: The maximum number of resource servers to return.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: A pagination token.
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: "#/components/schemas/UserPoolTagsType"
- description: The tags that are assigned to the user pool.
ListTagsForResourceRequest:
type: object
required:
- ResourceArn
title: ListTagsForResourceRequest
properties:
ResourceArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
ListUserImportJobsResponse:
type: object
properties:
UserImportJobs:
allOf:
- $ref: "#/components/schemas/UserImportJobsListType"
- description: The user import jobs.
PaginationToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: An identifier that can be used to return the next set of user import jobs in the list.
description: Represents the response from the server to the request to list the user import jobs.
ListUserImportJobsRequest:
type: object
required:
- UserPoolId
- MaxResults
title: ListUserImportJobsRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool that the users are being imported into.
MaxResults:
allOf:
- $ref: "#/components/schemas/PoolQueryLimitType"
- description: The maximum number of import jobs you want the request to return.
PaginationToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.
description: Represents the request to list the user import jobs.
ListUserPoolClientsResponse:
type: object
properties:
UserPoolClients:
allOf:
- $ref: "#/components/schemas/UserPoolClientListType"
- description: The user pool clients in the response that lists user pool clients.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKey"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
description: Represents the response from the server that lists user pool clients.
ListUserPoolClientsRequest:
type: object
required:
- UserPoolId
title: ListUserPoolClientsRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool where you want to list user pool clients.
MaxResults:
allOf:
- $ref: "#/components/schemas/QueryLimit"
- description: The maximum number of results you want the request to return when listing the user pool clients.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKey"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
description: Represents the request to list the user pool clients.
ListUserPoolsResponse:
type: object
properties:
UserPools:
allOf:
- $ref: "#/components/schemas/UserPoolListType"
- description: The user pools from the response to list users.
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
description: Represents the response to list user pools.
ListUserPoolsRequest:
type: object
required:
- MaxResults
title: ListUserPoolsRequest
properties:
NextToken:
allOf:
- $ref: "#/components/schemas/PaginationKeyType"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
MaxResults:
allOf:
- $ref: "#/components/schemas/PoolQueryLimitType"
- description: The maximum number of results you want the request to return when listing the user pools.
description: Represents the request to list user pools.
ListUsersResponse:
type: object
properties:
Users:
allOf:
- $ref: "#/components/schemas/UsersListType"
- description: The users returned in the request to list users.
PaginationToken:
allOf:
- $ref: "#/components/schemas/SearchPaginationTokenType"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
description: The response from the request to list users.
ListUsersRequest:
type: object
required:
- UserPoolId
title: ListUsersRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool on which the search should be performed.
AttributesToGet:
allOf:
- $ref: "#/components/schemas/SearchedAttributeNamesListType"
- description: An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Limit:
allOf:
- $ref: "#/components/schemas/QueryLimitType"
- description: Maximum number of users to be returned.
PaginationToken:
allOf:
- $ref: "#/components/schemas/SearchPaginationTokenType"
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Filter:
allOf:
- $ref: "#/components/schemas/UserFilterType"
- description: "A filter string of the form \"AttributeName Filter-Type \"AttributeValue\"\". Quotation marks within the filter string must be escaped using the backslash
(\\) character. For example, \"family_name = \\\"Reddy\\\"\".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use ^=, for example,
\"given_name ^= \\\"Jon\\\"\".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty,
ListUsers returns all users in the user pool.
You can only search for the following standard attributes:
username (case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status (called Status in the Console) (case-insensitive)
status
(called Enabled in the Console) (case-sensitive)
sub
Custom attributes aren't searchable.
You can also list
users with a client-side filter. The server-side filter matches no more than one attribute. For an advanced search, use a client-side filter with the --query parameter of the
list-users action in the CLI. When you use a client-side filter, ListUsers returns a paginated list of zero or more users. You can receive multiple pages in a row with zero results.
Repeat the query with each pagination token that is returned until you receive a null pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface User Guide.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
" description: Represents the request to list users. ListUsersInGroupResponse: type: object properties: Users: allOf: - $ref: "#/components/schemas/UsersListType" - description: The users returned in the request to list users. NextToken: allOf: - $ref: "#/components/schemas/PaginationKey" - description: An identifier that you can use in a later request to return the next set of items in the list. ListUsersInGroupRequest: type: object required: - UserPoolId - GroupName title: ListUsersInGroupRequest properties: UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The user pool ID for the user pool. GroupName: allOf: - $ref: "#/components/schemas/GroupNameType" - description: The name of the group. Limit: allOf: - $ref: "#/components/schemas/QueryLimitType" - description: The limit of the request to list users. NextToken: allOf: - $ref: "#/components/schemas/PaginationKey" - description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. ResendConfirmationCodeResponse: type: object properties: CodeDeliveryDetails: allOf: - $ref: "#/components/schemas/CodeDeliveryDetailsType" - description: The code delivery details returned by the server in response to the request to resend the confirmation code. description: The response from the server when Amazon Cognito makes the request to resend a confirmation code. ResendConfirmationCodeRequest: type: object required: - ClientId - Username title: ResendConfirmationCodeRequest properties: ClientId: allOf: - $ref: "#/components/schemas/ClientIdType" - description: The ID of the client associated with the user pool. SecretHash: allOf: - $ref: "#/components/schemas/SecretHashType" - description: 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. UserContextData: allOf: - $ref: "#/components/schemas/UserContextDataType" - description: 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. Username: allOf: - $ref: "#/components/schemas/UsernameType" - description: Theusername attribute of the user to whom you want to resend a confirmation code.
AnalyticsMetadata:
allOf:
- $ref: "#/components/schemas/AnalyticsMetadataType"
- description: The Amazon Pinpoint analytics metadata that contributes to your metrics for ResendConfirmationCode calls.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When
Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the
data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in Lambda, you can process the clientMetadata value to
enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
RespondToAuthChallenge API call.
ChallengeParameters:
allOf:
- $ref: "#/components/schemas/ChallengeParametersType"
- description: The challenge parameters. For more information, see InitiateAuth.
AuthenticationResult:
allOf:
- $ref: "#/components/schemas/AuthenticationResultType"
- description: The result returned by the server in response to the request to respond to the authentication challenge.
description: The response to respond to the authentication challenge.
RespondToAuthChallengeRequest:
type: object
required:
- ClientId
- ChallengeName
title: RespondToAuthChallengeRequest
properties:
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The app client ID.
ChallengeName:
allOf:
- $ref: "#/components/schemas/ChallengeNameType"
- description: The challenge name. For more information, see InitiateAuth.
ADMIN_NO_SRP_AUTH isn't a valid value.
InitiateAuth or RespondToAuthChallenge API call determines
that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge
API call.
ChallengeResponses:
allOf:
- $ref: "#/components/schemas/ChallengeResponsesType"
- description: "The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
SECRET_HASH (if app client is configured
with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).
SMS_MFA: SMS_MFA_CODE, USERNAME.
PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.
NEW_PASSWORD_REQUIRED: NEW_PASSWORD,
USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes
in the InitiateAuth response, add a userAttributes.attributename parameter. 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: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
DEVICE_PASSWORD_VERIFIER
requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
MFA_SETUP requires USERNAME, plus you must use
the session value returned by VerifySoftwareToken in the Session parameter.
RespondToAuthChallenge calls.
UserContextData:
allOf:
- $ref: "#/components/schemas/UserContextDataType"
- description: 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.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions
to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre
token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload,
which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge
request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk
configuration is applied to all the clients in the userPool.
Otherwise, ClientId is mapped to the client. When the client ID isn't null, the user pool configuration
is overridden and the risk configuration for the client is used instead.
The MFA configuration. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all
users to sign in.
OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
OFF MFA won't be used for any users.
ON MFA is required for all users to sign in.
OPTIONAL MFA will
be required only for individual users who have an MFA factor activated.
username.
description: The response from the server for a registration request.
SignUpRequest:
type: object
required:
- ClientId
- Username
- Password
title: SignUpRequest
properties:
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The ID of the client associated with the user pool.
SecretHash:
allOf:
- $ref: "#/components/schemas/SecretHashType"
- description: 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.
Username:
allOf:
- $ref: "#/components/schemas/UsernameType"
- description: The user name of the user you want to register.
Password:
allOf:
- $ref: "#/components/schemas/PasswordType"
- description: The password of the user you want to register.
UserAttributes:
allOf:
- $ref: "#/components/schemas/AttributeListType"
- description: An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
SignUp calls.
UserContextData:
allOf:
- $ref: "#/components/schemas/UserContextDataType"
- description: 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.
ClientMetadata:
allOf:
- $ref: "#/components/schemas/ClientMetadataType"
- description: "A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions
to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and
post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in Lambda, you can process the clientMetadata
value to enhance your workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
cognito:roles and cognito:preferred_role claims in the token.
Precedence:
allOf:
- $ref: "#/components/schemas/PrecedenceType"
- description: The new precedence value for the group. For more information about this parameter, see CreateGroup.
UpdateIdentityProviderResponse:
type: object
required:
- IdentityProvider
properties:
IdentityProvider:
allOf:
- $ref: "#/components/schemas/IdentityProviderType"
- description: The identity provider details.
UpdateIdentityProviderRequest:
type: object
required:
- UserPoolId
- ProviderName
title: UpdateIdentityProviderRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
ProviderName:
allOf:
- $ref: "#/components/schemas/ProviderNameType"
- description: The IdP name.
ProviderDetails:
allOf:
- $ref: "#/components/schemas/ProviderDetailsType"
- description: The IdP details to be updated, such as MetadataURL and MetadataFile.
AttributeMapping:
allOf:
- $ref: "#/components/schemas/AttributeMappingType"
- description: The IdP attribute mapping to be changed.
IdpIdentifiers:
allOf:
- $ref: "#/components/schemas/IdpIdentifiersListType"
- description: A list of IdP identifiers.
UpdateResourceServerResponse:
type: object
required:
- ResourceServer
properties:
ResourceServer:
allOf:
- $ref: "#/components/schemas/ResourceServerType"
- description: The resource server.
UpdateResourceServerRequest:
type: object
required:
- UserPoolId
- Identifier
- Name
title: UpdateResourceServerRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool.
Identifier:
allOf:
- $ref: "#/components/schemas/ResourceServerIdentifierType"
- description: The identifier for the resource server.
Name:
allOf:
- $ref: "#/components/schemas/ResourceServerNameType"
- description: The name of the resource server.
Scopes:
allOf:
- $ref: "#/components/schemas/ResourceServerScopeListType"
- description: The scope values to be set for the resource server.
UpdateUserAttributesResponse:
type: object
properties:
CodeDeliveryDetailsList:
allOf:
- $ref: "#/components/schemas/CodeDeliveryDetailsListType"
- description: The code delivery details list from the server for the request to update user attributes.
description: Represents the response from the server for the request to update user attributes.
UpdateUserAttributesRequest:
type: object
required:
- UserAttributes
- AccessToken
title: UpdateUserAttributesRequest
properties:
UserAttributes:
allOf:
- $ref: "#/components/schemas/AttributeListType"
- description: An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
If you have set an attribute to require verification before Amazon Cognito updates its value, this request doesn’t immediately update the value of that attribute. After your user receives and responds to a verification message to verify the new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages with the original attribute value until they verify the new value.
AccessToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: A valid access token that Amazon Cognito issued to the user whose user attributes you want to update. ClientMetadata: allOf: - $ref: "#/components/schemas/ClientMetadataType" - description:A map of custom key-value pairs that you can provide as input for any custom workflows that this action initiates.
You create custom workflows by assigning Lambda
functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon
Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that
you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in Lambda, you can process the clientMetadata value to enhance your
workflow for your specific needs.
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.
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.
UpdateUserPoolClientResponse:
type: object
properties:
UserPoolClient:
allOf:
- $ref: "#/components/schemas/UserPoolClientType"
- description: The user pool client value from the response from the server when you request to update the user pool client.
description: Represents the response from the server to the request to update the user pool client.
UpdateUserPoolClientRequest:
type: object
required:
- UserPoolId
- ClientId
title: UpdateUserPoolClientRequest
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool where you want to update the user pool client.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The ID of the client associated with the user pool.
ClientName:
allOf:
- $ref: "#/components/schemas/ClientNameType"
- description: The client name from the update user pool client request.
RefreshTokenValidity:
allOf:
- $ref: "#/components/schemas/RefreshTokenValidityType"
- description: 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.
AccessTokenValidity: allOf: - $ref: "#/components/schemas/AccessTokenValidityType" - description: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.
IdTokenValidity: allOf: - $ref: "#/components/schemas/IdTokenValidityType" - description: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 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 ID tokens are valid for one hour.
TokenValidityUnits: allOf: - $ref: "#/components/schemas/TokenValidityUnitsType" - description: The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours. ReadAttributes: allOf: - $ref: "#/components/schemas/ClientPermissionListType" - description: The read-only attributes of the user pool. WriteAttributes: allOf: - $ref: "#/components/schemas/ClientPermissionListType" - description: The writeable attributes of the user pool. ExplicitAuthFlows: allOf: - $ref: "#/components/schemas/ExplicitAuthFlowsListType" - description: "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_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.
COGNITO, Facebook, Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC providers."
CallbackURLs:
allOf:
- $ref: "#/components/schemas/CallbackURLsListType"
- description: A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
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.
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
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.
The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
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.
AllowedOAuthFlowsUserPoolClient:
allOf:
- $ref: "#/components/schemas/BooleanType"
- description: Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
AnalyticsConfiguration:
allOf:
- $ref: "#/components/schemas/AnalyticsConfigurationType"
- description: The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
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.
EnablePropagateAdditionalUserContextData in an app client that has a client secret.
AuthSessionValidity:
allOf:
- $ref: "#/components/schemas/AuthSessionValidityType"
- description: 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.
description: Represents the request to update the user pool client.
UpdateUserPoolDomainResponse:
type: object
properties:
CloudFrontDomain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
description: The UpdateUserPoolDomain response output.
UpdateUserPoolDomainRequest:
type: object
required:
- Domain
- UserPoolId
- CustomDomainConfig
title: UpdateUserPoolDomainRequest
properties:
Domain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
UserPoolId: allOf: - $ref: "#/components/schemas/UserPoolIdType" - description: The ID of the user pool that is associated with the custom domain whose certificate you're updating. CustomDomainConfig: allOf: - $ref: "#/components/schemas/CustomDomainConfigType" - description: The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM. description: The UpdateUserPoolDomain request input. VerifySoftwareTokenResponse: type: object properties: Status: allOf: - $ref: "#/components/schemas/VerifySoftwareTokenResponseType" - description: The status of the verify software token. Session: allOf: - $ref: "#/components/schemas/SessionType" - description: The session that should be passed both ways in challenge-response calls to the service. VerifySoftwareTokenRequest: type: object required: - UserCode title: VerifySoftwareTokenRequest properties: AccessToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: A valid access token that Amazon Cognito issued to the user whose software token you want to verify. Session: allOf: - $ref: "#/components/schemas/SessionType" - description: The session that should be passed both ways in challenge-response calls to the service. UserCode: allOf: - $ref: "#/components/schemas/SoftwareTokenMFAUserCodeType" - description: The one- time password computed using the secret code returned by AssociateSoftwareToken. FriendlyDeviceName: allOf: - $ref: "#/components/schemas/StringType" - description: The friendly device name. EnableSoftwareTokenMFAException: {} VerifyUserAttributeResponse: type: object properties: {} description: A container representing the response from the server from the request to verify user attributes. VerifyUserAttributeRequest: type: object required: - AccessToken - AttributeName - Code title: VerifyUserAttributeRequest properties: AccessToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify. AttributeName: allOf: - $ref: "#/components/schemas/AttributeNameType" - description: The attribute name in the request to verify user attributes. Code: allOf: - $ref: "#/components/schemas/ConfirmationCodeType" - description: The verification code in the request to verify user attributes. description: Represents the request to verify user attributes. AWSAccountIdType: type: string AccessTokenValidityType: type: integer minimum: 1 maximum: 86400 RecoveryMechanismsType: type: array items: $ref: "#/components/schemas/RecoveryOptionType" minItems: 1 maxItems: 2 AccountRecoverySettingType: type: object properties: RecoveryMechanisms: allOf: - $ref: "#/components/schemas/RecoveryMechanismsType" - description: The list ofRecoveryOptionTypes.
description: The data type for AccountRecoverySetting.
AccountTakeoverActionNotifyType:
type: boolean
AccountTakeoverEventActionType:
type: string
enum:
- BLOCK
- MFA_IF_CONFIGURED
- MFA_REQUIRED
- NO_ACTION
AccountTakeoverActionType:
type: object
required:
- Notify
- EventAction
properties:
Notify:
allOf:
- $ref: "#/components/schemas/AccountTakeoverActionNotifyType"
- description: Flag specifying whether to send a notification.
EventAction:
allOf:
- $ref: "#/components/schemas/AccountTakeoverEventActionType"
- description: The action to take in response to the account takeover action. Valid values are as follows:
BLOCK Choosing this action will block the
request.
MFA_IF_CONFIGURED Present an MFA challenge if user has configured it, else allow the request.
MFA_REQUIRED
Present an MFA challenge if user has configured it, else block the request.
NO_ACTION Allow the user to sign in.
From parameter.
BlockEmail:
allOf:
- $ref: "#/components/schemas/NotifyEmailType"
- description: Email template used when a detected risk event is blocked.
NoActionEmail:
allOf:
- $ref: "#/components/schemas/NotifyEmailType"
- description: The email template used when a detected risk event is allowed.
MfaEmail:
allOf:
- $ref: "#/components/schemas/NotifyEmailType"
- description: The multi-factor authentication (MFA) email template used when MFA is challenged as part of a detected risk.
description: The notify configuration type.
AccountTakeoverRiskConfigurationType:
type: object
required:
- Actions
properties:
NotifyConfiguration:
allOf:
- $ref: "#/components/schemas/NotifyConfigurationType"
- description: The notify configuration used to construct email notifications.
Actions:
allOf:
- $ref: "#/components/schemas/AccountTakeoverActionsType"
- description: Account takeover risk configuration actions.
description: Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
UserPoolIdType:
type: string
pattern: "[\\w-]+_[0-9a-zA-Z]+"
minLength: 1
maxLength: 55
CustomAttributesListType:
type: array
items:
$ref: "#/components/schemas/SchemaAttributeType"
minItems: 1
maxItems: 25
UsernameType:
type: string
pattern: "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
minLength: 1
maxLength: 128
format: password
GroupNameType:
type: string
pattern: "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
minLength: 1
maxLength: 128
ClientMetadataType:
type: object
additionalProperties:
$ref: "#/components/schemas/StringType"
BooleanType:
type: boolean
AdminCreateUserUnusedAccountValidityDaysType:
type: integer
minimum: 0
maximum: 365
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.
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. AttributeListType: type: array items: $ref: "#/components/schemas/AttributeType" PasswordType: type: string pattern: "[\\S]+" maxLength: 256 format: password ForceAliasCreation: type: boolean MessageActionType: type: string enum: - RESEND - SUPPRESS DeliveryMediumListType: type: array items: $ref: "#/components/schemas/DeliveryMediumType" UserType: type: object properties: Username: allOf: - $ref: "#/components/schemas/UsernameType" - description: The user name of the user you want to describe. Attributes: allOf: - $ref: "#/components/schemas/AttributeListType" - description: A container with information about the user type attributes. UserCreateDate: allOf: - $ref: "#/components/schemas/DateType" - description: The creation date of the user. UserLastModifiedDate: allOf: - $ref: "#/components/schemas/DateType" - description: The last modified date of the user. Enabled: allOf: - $ref: "#/components/schemas/BooleanType" - description: Specifies whether the user is enabled. UserStatus: allOf: - $ref: "#/components/schemas/UserStatusType" - description:The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
ARCHIVED - User is no longer active.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
NameID.
ProviderAttributeValue:
allOf:
- $ref: "#/components/schemas/StringType"
- description: The value of the provider attribute to link to, such as xxxxx_account.
description: A container for information about an IdP for a user pool.
DeviceKeyType:
type: string
pattern: "[\\w-]+_[0-9a-f-]+"
minLength: 1
maxLength: 55
DeviceType:
type: object
properties:
DeviceKey:
allOf:
- $ref: "#/components/schemas/DeviceKeyType"
- description: The device key.
DeviceAttributes:
allOf:
- $ref: "#/components/schemas/AttributeListType"
- description: The device attributes.
DeviceCreateDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The creation date of the device.
DeviceLastModifiedDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The last modified date of the device.
DeviceLastAuthenticatedDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the device was last authenticated.
description: The device type.
DateType:
type: string
format: date-time
UserStatusType:
type: string
enum:
- UNCONFIRMED
- CONFIRMED
- ARCHIVED
- COMPROMISED
- UNKNOWN
- RESET_REQUIRED
- FORCE_CHANGE_PASSWORD
MFAOptionListType:
type: array
items:
$ref: "#/components/schemas/MFAOptionType"
UserMFASettingListType:
type: array
items:
$ref: "#/components/schemas/StringType"
ClientIdType:
type: string
pattern: "[\\w+]+"
minLength: 1
maxLength: 128
format: password
AuthFlowType:
type: string
enum:
- USER_SRP_AUTH
- REFRESH_TOKEN_AUTH
- REFRESH_TOKEN
- CUSTOM_AUTH
- ADMIN_NO_SRP_AUTH
- USER_PASSWORD_AUTH
- ADMIN_USER_PASSWORD_AUTH
AuthParametersType:
type: object
additionalProperties:
$ref: "#/components/schemas/StringType"
AnalyticsMetadataType:
type: object
properties:
AnalyticsEndpointId:
allOf:
- $ref: "#/components/schemas/StringType"
- description: The endpoint ID.
description: An Amazon Pinpoint analytics endpoint.
An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
ContextDataType: type: object required: - IpAddress - ServerName - ServerPath - HttpHeaders properties: IpAddress: allOf: - $ref: "#/components/schemas/StringType" - description: The source IP address of your user's device. ServerName: allOf: - $ref: "#/components/schemas/StringType" - description: Your server endpoint where this API is invoked. ServerPath: allOf: - $ref: "#/components/schemas/StringType" - description: Your server path where this API is invoked. HttpHeaders: allOf: - $ref: "#/components/schemas/HttpHeaderList" - description: HttpHeaders received on your server in same order. EncodedData: allOf: - $ref: "#/components/schemas/StringType" - description: Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests. description: Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. ChallengeNameType: type: string enum: - SMS_MFA - SOFTWARE_TOKEN_MFA - SELECT_MFA_TYPE - MFA_SETUP - PASSWORD_VERIFIER - CUSTOM_CHALLENGE - DEVICE_SRP_AUTH - DEVICE_PASSWORD_VERIFIER - ADMIN_NO_SRP_AUTH - NEW_PASSWORD_REQUIRED SessionType: type: string minLength: 20 maxLength: 2048 ChallengeParametersType: type: object additionalProperties: $ref: "#/components/schemas/StringType" AuthenticationResultType: type: object properties: AccessToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: A valid access token that Amazon Cognito issued to the user who you want to authenticate. ExpiresIn: allOf: - $ref: "#/components/schemas/IntegerType" - description: The expiration period of the authentication result in seconds. TokenType: allOf: - $ref: "#/components/schemas/StringType" - description: The token type. RefreshToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: The refresh token. IdToken: allOf: - $ref: "#/components/schemas/TokenModelType" - description: The ID token. NewDeviceMetadata: allOf: - $ref: "#/components/schemas/NewDeviceMetadataType" - description: The new device metadata from an authentication result. description: The authentication result. QueryLimitType: type: integer minimum: 0 maximum: 60 SearchPaginationTokenType: type: string pattern: "[\\S]+" minLength: 1 DeviceListType: type: array items: $ref: "#/components/schemas/DeviceType" PaginationKey: type: string pattern: "[\\S]+" minLength: 1 GroupListType: type: array items: $ref: "#/components/schemas/GroupType" AuthEventsType: type: array items: $ref: "#/components/schemas/AuthEventType" ChallengeResponsesType: type: object additionalProperties: $ref: "#/components/schemas/StringType" SMSMfaSettingsType: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/BooleanType" - description: Specifies whether SMS text message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. PreferredMfa: allOf: - $ref: "#/components/schemas/BooleanType" - description: Specifies whether SMS is the preferred MFA method. description: The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool. SoftwareTokenMfaSettingsType: type: object properties: Enabled: allOf: - $ref: "#/components/schemas/BooleanType" - description: Specifies whether software token MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. PreferredMfa: allOf: - $ref: "#/components/schemas/BooleanType" - description: Specifies whether software token MFA is the preferred MFA method. description: The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool. EventIdType: type: string pattern: "[\\w+-]+" minLength: 1 maxLength: 50 FeedbackValueType: type: string enum: - Valid - Invalid DeviceRememberedStatusType: type: string enum: - remembered - not_remembered AdvancedSecurityModeType: type: string enum: - OFF - AUDIT - ENFORCED AliasAttributeType: type: string enum: - phone_number - email - preferred_username AliasAttributesListType: type: array items: $ref: "#/components/schemas/AliasAttributeType" HexStringType: type: string pattern: ^[0-9a-fA-F]+$ ArnType: type: string pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)? minLength: 20 maxLength: 2048 AnalyticsConfigurationType: type: object properties: ApplicationId: allOf: - $ref: "#/components/schemas/HexStringType" - description: The application ID for an Amazon Pinpoint application. ApplicationArn: allOf: - $ref: "#/components/schemas/ArnType" - description: The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares. RoleArn: allOf: - $ref: "#/components/schemas/ArnType" - description: The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics. ExternalId: allOf: - $ref: "#/components/schemas/StringType" - description: The external ID. UserDataShared: allOf: - $ref: "#/components/schemas/BooleanType" - description: IfUserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
description: The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpointisn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
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 ornull 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 IdP details. The following list describes the provider detail keys for each IdP type.
For Google and Login with Amazon:
client_id
client_secret
authorize_scopes
For Facebook:
client_id
client_secret
authorize_scopes
api_version
For Sign in with Apple:
client_id
team_id
key_id
private_key
You can submit a private_key when you add or update an IdP. Describe operations don't return the private key.
authorize_scopes
For OIDC providers:
client_id
client_secret
attributes_request_method
oidc_issuer
authorize_scopes
The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer
URL.
authorize_url
token_url
attributes_url
jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
attributes_url_add_attributes
For SAML providers:
MetadataFile or MetadataURL
IDPSignout optional
.csv file.
CreationDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date the user import job was created.
StartDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the user import job was started.
CompletionDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date when the user import job was completed.
Status:
allOf:
- $ref: "#/components/schemas/UserImportJobStatusType"
- description: The status of the user import job. One of the following:
Created - The job was created but not started.
Pending - A transition state. You have started the job, but it has not begun importing users yet.
InProgress - The job has started, and users
are being imported.
Stopping - You have stopped the job, but the job has not stopped importing users yet.
Stopped - You
have stopped the job, and the job has stopped importing users.
Succeeded - The job has completed successfully.
Failed -
The job has stopped due to an error.
Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was
deleted, and the job can't be started.
seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter.
The default AccessTokenValidity time unit is hours."
IdToken:
allOf:
- $ref: "#/components/schemas/TimeUnitsType"
- description: A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter.
The default IdTokenValidity time unit is hours.
RefreshToken:
allOf:
- $ref: "#/components/schemas/TimeUnitsType"
- description: A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity
parameter. The default RefreshTokenValidity time unit is days.
description: The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.
ExplicitAuthFlowsListType:
type: array
items:
$ref: "#/components/schemas/ExplicitAuthFlowsType"
SupportedIdentityProvidersListType:
type: array
items:
$ref: "#/components/schemas/ProviderNameType"
LogoutURLsListType:
type: array
items:
$ref: "#/components/schemas/RedirectUrlType"
minItems: 0
maxItems: 100
OAuthFlowsType:
type: array
items:
$ref: "#/components/schemas/OAuthFlowType"
minItems: 0
maxItems: 3
ScopeListType:
type: array
items:
$ref: "#/components/schemas/ScopeType"
maxItems: 50
PreventUserExistenceErrorTypes:
type: string
enum:
- LEGACY
- ENABLED
WrappedBooleanType:
type: boolean
UserPoolClientType:
type: object
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID for the user pool client.
ClientName:
allOf:
- $ref: "#/components/schemas/ClientNameType"
- description: The client name from the user pool request of the client type.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The ID of the client associated with the user pool.
ClientSecret:
allOf:
- $ref: "#/components/schemas/ClientSecretType"
- description: The client secret from the user pool request of the client type.
LastModifiedDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date the user pool client was last modified.
CreationDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The date the user pool client was created.
RefreshTokenValidity:
allOf:
- $ref: "#/components/schemas/RefreshTokenValidityType"
- description: 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.
AccessTokenValidity: allOf: - $ref: "#/components/schemas/AccessTokenValidityType" - description: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.
IdTokenValidity: allOf: - $ref: "#/components/schemas/IdTokenValidityType" - description: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 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 ID tokens are valid for one hour.
TokenValidityUnits: allOf: - $ref: "#/components/schemas/TokenValidityUnitsType" - description: "The time units used to specify the token validity times of each token type: ID, access, and refresh." ReadAttributes: allOf: - $ref: "#/components/schemas/ClientPermissionListType" - description: The Read-only attributes. WriteAttributes: allOf: - $ref: "#/components/schemas/ClientPermissionListType" - description: The writeable attributes. ExplicitAuthFlows: allOf: - $ref: "#/components/schemas/ExplicitAuthFlowsListType" - description: "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_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.
COGNITO, Facebook, Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC providers."
CallbackURLs:
allOf:
- $ref: "#/components/schemas/CallbackURLsListType"
- description: A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
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.
LogoutURLs: allOf: - $ref: "#/components/schemas/LogoutURLsListType" - description: A list of allowed logout URLs for the IdPs. DefaultRedirectURI: allOf: - $ref: "#/components/schemas/RedirectUrlType" - description:The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
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.
AllowedOAuthFlows: allOf: - $ref: "#/components/schemas/OAuthFlowsType" - description:The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
phone, email, openid, and profile.
Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
AllowedOAuthFlowsUserPoolClient:
allOf:
- $ref: "#/components/schemas/BooleanType"
- description: Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
AnalyticsConfiguration:
allOf:
- $ref: "#/components/schemas/AnalyticsConfigurationType"
- description: The Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData
parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in
Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and
AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more
information about propagation of user context data, see Adding
user device and session data to API requests.
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.
description: Contains information about a user pool client.
DomainType:
type: string
pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
minLength: 1
maxLength: 63
CustomDomainConfigType:
type: object
required:
- CertificateArn
properties:
CertificateArn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
description: The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
UserPoolNameType:
type: string
pattern: "[\\w\\s+=,.@-]+"
minLength: 1
maxLength: 128
UserPoolPolicyType:
type: object
properties:
PasswordPolicy:
allOf:
- $ref: "#/components/schemas/PasswordPolicyType"
- description: The password policy.
description: The policy associated with a user pool.
DeletionProtectionType:
type: string
enum:
- ACTIVE
- INACTIVE
LambdaConfigType:
type: object
properties:
PreSignUp:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: A pre-registration Lambda trigger.
CustomMessage:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: A custom Message Lambda trigger.
PostConfirmation:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: A post-confirmation Lambda trigger.
PreAuthentication:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: A pre-authentication Lambda trigger.
PostAuthentication:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: A post-authentication Lambda trigger.
DefineAuthChallenge:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: Defines the authentication challenge.
CreateAuthChallenge:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: Creates an authentication challenge.
VerifyAuthChallengeResponse:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: Verifies the authentication challenge response.
PreTokenGeneration:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: A Lambda trigger that is invoked before token generation.
UserMigration:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The user migration Lambda config type.
CustomSMSSender:
allOf:
- $ref: "#/components/schemas/CustomSMSLambdaVersionConfigType"
- description: A custom SMS sender Lambda trigger.
CustomEmailSender:
allOf:
- $ref: "#/components/schemas/CustomEmailLambdaVersionConfigType"
- description: A custom email sender Lambda trigger.
KMSKeyID:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary
passwords sent to CustomEmailSender and CustomSMSSender.
description: Specifies the configuration for Lambda triggers.
VerifiedAttributesListType:
type: array
items:
$ref: "#/components/schemas/VerifiedAttributeType"
UsernameAttributesListType:
type: array
items:
$ref: "#/components/schemas/UsernameAttributeType"
SmsVerificationMessageType:
type: string
pattern: .*\{####\}.*
minLength: 6
maxLength: 140
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
EmailVerificationSubjectType:
type: string
pattern: "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+"
minLength: 1
maxLength: 140
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.
UserPoolMfaType:
type: string
enum:
- OFF
- ON
- OPTIONAL
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.
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.
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.
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. UserPoolTagsType: type: object additionalProperties: $ref: "#/components/schemas/TagValueType" SchemaAttributesListType: type: array items: $ref: "#/components/schemas/SchemaAttributeType" minItems: 1 maxItems: 50 UserPoolAddOnsType: type: object required: - AdvancedSecurityMode properties: AdvancedSecurityMode: allOf: - $ref: "#/components/schemas/AdvancedSecurityModeType" - description: The advanced security mode. description: The user pool add-ons type. UsernameConfigurationType: type: object required: - CaseSensitive properties: CaseSensitive: allOf: - $ref: "#/components/schemas/WrappedBooleanType" - description:Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
Valid values include:
Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as
“UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False,
users can sign in using either "username" or "Username". This option also enables both preferred_username and email alias to be case insensitive, in addition to
the username attribute.
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: Can be one of the following values:
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 required when you're initially creating a user pool.
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.
The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email
configuration.
Domain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The domain prefix, if the user pool has a domain associated with it.
CustomDomain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application.
An example of a custom domain name might be auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
AdminCreateUserConfig: allOf: - $ref: "#/components/schemas/AdminCreateUserConfigType" - description: The configuration forAdminCreateUser requests.
UserPoolAddOns:
allOf:
- $ref: "#/components/schemas/UserPoolAddOnsType"
- description: The user pool add-ons.
UsernameConfiguration:
allOf:
- $ref: "#/components/schemas/UsernameConfigurationType"
- description: Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either
"username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
Arn:
allOf:
- $ref: "#/components/schemas/ArnType"
- description: The Amazon Resource Name (ARN) for the user pool.
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: A container for information about the user pool.
CustomAttributeNameType:
type: string
pattern: "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
minLength: 1
maxLength: 20
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: You should use WriteAttributes
in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.
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,
DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to
true. 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 Specifying Identity Provider Attribute Mappings for Your User
Pool.
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.
CustomSMSSenderLambdaVersionType:
type: string
enum:
- V1_0
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.
DefaultEmailOptionType:
type: string
enum:
- CONFIRM_WITH_LINK
- CONFIRM_WITH_CODE
ProviderNameType:
type: string
pattern: "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
minLength: 1
maxLength: 32
RiskConfigurationType:
type: object
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
ClientId:
allOf:
- $ref: "#/components/schemas/ClientIdType"
- description: The app client ID.
CompromisedCredentialsRiskConfiguration:
allOf:
- $ref: "#/components/schemas/CompromisedCredentialsRiskConfigurationType"
- description: The compromised credentials risk configuration object, including the EventFilter and the EventAction.
AccountTakeoverRiskConfiguration:
allOf:
- $ref: "#/components/schemas/AccountTakeoverRiskConfigurationType"
- description: The account takeover risk configuration object, including the NotifyConfiguration object and Actions to take if there is an account takeover.
RiskExceptionConfiguration:
allOf:
- $ref: "#/components/schemas/RiskExceptionConfigurationType"
- description: The configuration to override the risk decision.
LastModifiedDate:
allOf:
- $ref: "#/components/schemas/DateType"
- description: The last modified date.
description: The risk configuration type.
UserImportJobIdType:
type: string
pattern: import-[0-9a-zA-Z-]+
minLength: 1
maxLength: 55
DomainDescriptionType:
type: object
properties:
UserPoolId:
allOf:
- $ref: "#/components/schemas/UserPoolIdType"
- description: The user pool ID.
AWSAccountId:
allOf:
- $ref: "#/components/schemas/AWSAccountIdType"
- description: The Amazon Web Services ID for the user pool owner.
Domain:
allOf:
- $ref: "#/components/schemas/DomainType"
- description: The domain string. 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.
S3Bucket:
allOf:
- $ref: "#/components/schemas/S3BucketType"
- description: The Amazon S3 bucket where the static files for this domain are stored.
CloudFrontDistribution:
allOf:
- $ref: "#/components/schemas/StringType"
- description: The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
Version:
allOf:
- $ref: "#/components/schemas/DomainVersionType"
- description: The app version.
Status:
allOf:
- $ref: "#/components/schemas/DomainStatusType"
- description: The domain status.
CustomDomainConfig:
allOf:
- $ref: "#/components/schemas/CustomDomainConfigType"
- description: The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
description: A container for information about a domain.
S3BucketType:
type: string
pattern: ^[0-9A-Za-z\.\-_]*(?SMS delivery medium value.
AttributeName:
allOf:
- $ref: "#/components/schemas/AttributeNameType"
- description: The attribute name of the MFA option type. The only valid value is phone_number.
description: " This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token
MFA configurations."
NotifyEmailType:
type: object
required:
- Subject
properties:
Subject:
allOf:
- $ref: "#/components/schemas/EmailNotificationSubjectType"
- description: The email subject.
HtmlBody:
allOf:
- $ref: "#/components/schemas/EmailNotificationBodyType"
- description: The email HTML body.
TextBody:
allOf:
- $ref: "#/components/schemas/EmailNotificationBodyType"
- description: The email text body.
description: The notify email type.
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.
OAuthFlowType:
type: string
enum:
- code
- implicit
- client_credentials
PasswordPolicyMinLengthType:
type: integer
minimum: 6
maximum: 99
TemporaryPasswordValidityDaysType:
type: integer
minimum: 0
maximum: 365
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.