Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.AdminGetUser 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.AdminGetUser 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://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: cognito-identity
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-identity-2014-06-30.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://cognito-identity.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity multi-region endpoint
- url: https://cognito-identity.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity multi-region endpoint
- url: http://cognito-identity.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-identity.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.AdminGetUser'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.AdminGetUser:
    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: AdminGetUser
      description: <p>Gets the specified user by user name in a user pool as an administrator. Works on any user.</p> <p>Calling this action requires developer credentials.</p>
      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
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.AdminGetUser'
components:
  schemas:
    ResourceNotFoundException: {}
    AttributeType:
      type: object
      required:
      - Name
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/AttributeNameType'
          - description: The name of the attribute.
        Value:
          allOf:
          - $ref: '#/components/schemas/AttributeValueType'
          - description: The value of the attribute.
      description: Specifies whether the attribute is standard or custom.
    AttributeNameType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
      minLength: 1
      maxLength: 32
    UserNotFoundException: {}
    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.
    DeliveryMediumType:
      type: string
      enum:
      - SMS
      - EMAIL
    AttributeListType:
      type: array
      items:
        $ref: '#/components/schemas/AttributeType'
    DateType:
      type: string
      format: date-time
    InvalidParameterException: {}
    TooManyRequestsException: {}
    InternalErrorException: {}
    MFAOptionListType:
      type: array
      items:
        $ref: '#/components/schemas/MFAOptionType'
    StringType:
      type: string
    NotAuthorizedException: {}
    UserStatusType:
      type: string
      enum:
      - UNCONFIRMED
      - CONFIRMED
      - ARCHIVED
      - COMPROMISED
      - UNKNOWN
      - RESET_REQUIRED
      - FORCE_CHANGE_PASSWORD
    UserPoolIdType:
      type: string
      pattern: '[\w-]+_[0-9a-zA-Z]+'
      minLength: 1
      maxLength: 55
    BooleanType:
      type: boolean
    UserMFASettingListType:
      type: array
      items:
        $ref: '#/components/schemas/StringType'
    UsernameType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}]+'
      minLength: 1
      maxLength: 128
      format: password
    AdminGetUserResponse:
      type: object
      required:
      - Username
      properties:
        Username:
          allOf:
          - $ref: '#/components/schemas/UsernameType'
          - description: The user name of the user about whom you're receiving information.
        UserAttributes:
          allOf:
          - $ref: '#/components/schemas/AttributeListType'
          - description: An array of name-value pairs representing user attributes.
        UserCreateDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The date the user was created.
        UserLastModifiedDate:
          allOf:
          - $ref: '#/components/schemas/DateType'
          - description: The date the user was last modified.
        Enabled:
          allOf:
          - $ref: '#/components/schemas/BooleanType'
          - description: Indicates that the status is <code>enabled</code>.
        UserStatus:
          allOf:
          - $ref: '#/components/schemas/UserStatusType'
          - description: <p>The user status. Can be one of the following:</p> <ul> <li> <p>UNCONFIRMED - User has been created but not confirmed.</p> </li> <li> <p>CONFIRMED - User has been confirmed.</p> </li> <li> <p>ARCHIVED - User is no longer active.</p> </li> <li> <p>UNKNOWN - User status isn't known.</p> </li> <li> <p>RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.</p> </li> <li> <p>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. </p> </li> </ul>
        MFAOptions:
          allOf:
          - $ref: '#/components/schemas/MFAOptionListType'
          - description: ' <i>This response parameter is no longer supported.</i> It provides information only about SMS MFA configurations. It doesn''t provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.'
        PreferredMfaSetting:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The user's preferred MFA setting.
        UserMFASettingList:
          allOf:
          - $ref: '#/components/schemas/UserMFASettingListType'
          - description: The MFA options that are activated for the user. The possible values in this list are <code>SMS_MFA</code> and <code>SOFTWARE_TOKEN_MFA</code>.
      description: Represents the response from the server from the request to get the specified user as an administrator.
    AttributeValueType:
      type: string
      maxLength: 2048
      format: password
    MFAOptionType:
      type: object
      properties:
        DeliveryMedium:
          allOf:
          - $ref: '#/components/schemas/DeliveryMediumType'
          - description: The delivery medium to send the MFA code. You can use this parameter to set only the <code>SMS</code> delivery medium value.
        AttributeName:
          allOf:
          - $ref: '#/components/schemas/AttributeNameType'
          - description: The attribute name of the MFA option type. The only valid value is <code>phone_number</code>.
      description: ' <i>This data type is no longer supported.</i> Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.'
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/cognito-identity/
x-hasEquivalentPaths: true