Amazon Cognito · Schema

SignUpResponse

The response from the server for a registration request.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserConfirmed object
CodeDeliveryDetails object
UserSub object
View JSON Schema on GitHub

JSON Schema

user-pools-sign-up-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-sign-up-response-schema.json",
  "title": "SignUpResponse",
  "description": "The response from the server for a registration request.",
  "type": "object",
  "properties": {
    "UserConfirmed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanType"
        },
        {
          "description": "A response from the server indicating that a user registration has been confirmed."
        }
      ]
    },
    "CodeDeliveryDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CodeDeliveryDetailsType"
        },
        {
          "description": "The code delivery details returned by the server response to the user registration request."
        }
      ]
    },
    "UserSub": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StringType"
        },
        {
          "description": "The UUID of the authenticated user. This isn't the same as <code>username</code>."
        }
      ]
    }
  },
  "required": [
    "UserConfirmed",
    "UserSub"
  ]
}