Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.VerifySoftwareToken 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.VerifySoftwareToken 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.VerifySoftwareToken'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.VerifySoftwareToken:
    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: VerifySoftwareToken
      description: <p>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.</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/VerifySoftwareTokenResponse'
              examples:
                VerifySoftwareToken200Example:
                  summary: Default VerifySoftwareToken 200 response
                  x-microcks-default: true
                  value:
                    Status: example
                    Session: example
        '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'
      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
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.VerifySoftwareToken'
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: {}
    InvalidUserPoolConfigurationException: {}
    SoftwareTokenMFAUserCodeType:
      type: string
      pattern: '[0-9]+'
      minLength: 6
      maxLength: 6
    ForbiddenException: {}
    InvalidParameterException: {}
    EnableSoftwareTokenMFAException: {}
    TokenModelType:
      type: string
      pattern: '[A-Za-z0-9-_=.]+'
      format: password
    UserNotFoundException: {}
    StringType:
      type: string
      minLength: 0
      maxLength: 131072
    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.
    SessionType:
      type: string
      minLength: 20
      maxLength: 2048
    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 <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssociateSoftwareToken.html">AssociateSoftwareToken</a>.
        FriendlyDeviceName:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The friendly device name.
    PasswordResetRequiredException: {}
    VerifySoftwareTokenResponseType:
      type: string
      enum:
      - SUCCESS
      - ERROR
    SoftwareTokenMFANotFoundException: {}
    NotAuthorizedException: {}
    InternalErrorException: {}
    UserNotConfirmedException: {}
    TooManyRequestsException: {}
    CodeMismatchException: {}
  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