Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.VerifyUserAttribute API

openapi: 3.0.0
info:
  version: '2014-06-30'
  x-release: v4
  title: 'Amazon Cognito Identity #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.AddCustomAttributes #X Amz Target=AWSCognitoIdentityProviderService.VerifyUserAttribute API'
  description: <fullname>Amazon Cognito Federated Identities</fullname> <p>Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p> <p>Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p> <p>For a description of the authentication flow from the Amazon Cognito Developer Guide see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Authentication Flow</a>.</p> <p>For more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html">Amazon Cognito Federated Identities</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: cognito-identity
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://cognito-identity.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity multi-region endpoint
- url: https://cognito-identity.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity multi-region endpoint
- url: http://cognito-identity.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-identity.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.VerifyUserAttribute'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.VerifyUserAttribute:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: VerifyUserAttribute
      description: <p>Verifies the specified user attributes in the user pool.</p> <p> 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 <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserAttributeUpdateSettingsType.html"> UserAttributeUpdateSettingsType</a>. </p> <note> <p>Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a>.</p> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyUserAttributeResponse'
              examples:
                VerifyUserAttribute200Example:
                  summary: Default VerifyUserAttribute 200 response
                  x-microcks-default: true
                  value: {}
        '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'
      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
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.VerifyUserAttribute'
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-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    ResourceNotFoundException: {}
    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.
    AttributeNameType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
      minLength: 1
      maxLength: 32
    ForbiddenException: {}
    InvalidParameterException: {}
    VerifyUserAttributeResponse:
      type: object
      properties: {}
      description: A container representing the response from the server from the request to verify user attributes.
    ConfirmationCodeType:
      type: string
      pattern: '[\S]+'
      minLength: 1
      maxLength: 2048
    TokenModelType:
      type: string
      pattern: '[A-Za-z0-9-_=.]+'
      format: password
    UserNotFoundException: {}
    LimitExceededException: {}
    PasswordResetRequiredException: {}
    NotAuthorizedException: {}
    InternalErrorException: {}
    ExpiredCodeException: {}
    UserNotConfirmedException: {}
    TooManyRequestsException: {}
    CodeMismatchException: {}
    AliasExistsException: {}
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/cognito-identity/
x-hasEquivalentPaths: true