@itentialopensource/adapter-aws_cognito_identity_provider

{ "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 <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/what-is-amazon-cognito.html\">Amazon Cognito Documentation</a>.", "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" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserImportInProgressException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserImportInProgressException" } } } }, "485": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCustomAttributesRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AddCustomAttributes" ] } } ] }, "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" } } } }, "481": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "485": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminAddUserToGroupRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminAddUserToGroup" ] } } ] }, "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" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "UnexpectedLambdaException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnexpectedLambdaException" } } } }, "483": { "description": "UserLambdaValidationException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLambdaValidationException" } } } }, "484": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "485": { "description": "TooManyFailedAttemptsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyFailedAttemptsException" } } } }, "486": { "description": "InvalidLambdaResponseException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidLambdaResponseException" } } } }, "487": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "488": { "description": "LimitExceededException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LimitExceededException" } } } }, "489": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "490": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminConfirmSignUpRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminConfirmSignUp" ] } } ] }, "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 <code>MessageAction</code> isn't set, the default is to send a welcome message via email or phone (SMS). <note> 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 <a href=\"https://console.aws.amazon.com/pinpoint/home/\">Amazon Pinpoint</a>. 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 <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html\">sandbox mode</a> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html\"> SMS message settings for Amazon Cognito user pools</a> in the Amazon Cognito Developer Guide. </note> 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 <code>AdminCreateUser</code> with <code>SUPPRESS</code> for the <code>MessageAction</code> parameter, and Amazon Cognito won't send any email. In either case, the user will be in the <code>FORCE_CHANGE_PASSWORD</code> state until they sign in and change their password. <code>AdminCreateUser</code> requires developer credentials.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCreateUserResponse" } } } }, "480": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "483": { "description": "UsernameExistsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsernameExistsException" } } } }, "484": { "description": "InvalidPasswordException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidPasswordException" } } } }, "485": { "description": "CodeDeliveryFailureException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeDeliveryFailureException" } } } }, "486": { "description": "UnexpectedLambdaException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnexpectedLambdaException" } } } }, "487": { "description": "UserLambdaValidationException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLambdaValidationException" } } } }, "488": { "description": "InvalidLambdaResponseException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidLambdaResponseException" } } } }, "489": { "description": "PreconditionNotMetException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreconditionNotMetException" } } } }, "490": { "description": "InvalidSmsRoleAccessPolicyException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidSmsRoleAccessPolicyException" } } } }, "491": { "description": "InvalidSmsRoleTrustRelationshipException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidSmsRoleTrustRelationshipException" } } } }, "492": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "493": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "494": { "description": "UnsupportedUserStateException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnsupportedUserStateException" } } } }, "495": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminCreateUserRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminCreateUser" ] } } ] }, "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.AdminDeleteUser": { "post": { "operationId": "AdminDeleteUser", "description": "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" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "485": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDeleteUserRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminDeleteUser" ] } } ] }, "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" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "485": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDeleteUserAttributesRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminDeleteUserAttributes" ] } } ] }, "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 <code>DestinationUser</code>, the user must create a new user account. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html\">AdminLinkProviderForUser</a>. This action is enabled only for admin access and requires developer credentials. The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. To deactivate a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>. The <code>ProviderAttributeValue</code> must be the name that is used in the user pool for the user. The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social IdPs. The <code>ProviderAttributeValue</code> 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 <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code> must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked using <code> AdminLinkProviderForUser</code> call. (If the linking was done with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDisableProviderForUserResponse" } } } }, "480": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "485": { "description": "AliasExistsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AliasExistsException" } } } }, "486": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDisableProviderForUserRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminDisableProviderForUser" ] } } ] }, "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.AdminDisableUser": { "post": { "operationId": "AdminDisableUser", "description": "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 <code>GetUser</code> and <code>ListUsers</code> API requests. You must make this API request with Amazon Web Services credentials that have <code>cognito-idp:AdminDisableUser</code> permissions.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDisableUserResponse" } } } }, "480": { "description": "ResourceNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundException" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "485": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminDisableUserRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminDisableUser" ] } } ] }, "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.AdminEnableUser": { "post": { "operationId": "AdminEnableUser", "description": "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" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "483": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "484": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "485": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminEnableUserRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminEnableUser" ] } } ] }, "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" } } } }, "481": { "description": "InvalidParameterException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidParameterException" } } } }, "482": { "description": "InvalidUserPoolConfigurationException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidUserPoolConfigurationException" } } } }, "483": { "description": "TooManyRequestsException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequestsException" } } } }, "484": { "description": "NotAuthorizedException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotAuthorizedException" } } } }, "485": { "description": "UserNotFoundException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotFoundException" } } } }, "486": { "description": "InternalErrorException", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalErrorException" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminForgetDeviceRequest" } } } }, "parameters": [ { "name": "X-Amz-Target", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "AWSCognitoIdentityProviderService.AdminForgetDevice" ] } } ] }, "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" } } } }, "480": {