Amazon Cognito · JSON Structure

Cognito Idp Get User Response Structure

Represents the response from the server from the request to get information about the user.

Type: object Properties: 5 Required: 2
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

GetUserResponse is a JSON Structure definition published by Amazon Cognito, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Username UserAttributes MFAOptions PreferredMfaSetting UserMFASettingList

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name of the user you want to retrieve from the get user request."
        }
      ]
    },
    "UserAttributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributeListType"
        },
        {
          "description": "<p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
        }
      ]
    },
    "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>."
        }
      ]
    }
  },
  "required": [
    "Username",
    "UserAttributes"
  ],
  "description": "Represents the response from the server from the request to get information about the user.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-get-user-response-structure.json",
  "name": "GetUserResponse"
}