Auth0 · Schema

GetUserResponseContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
user_id	string	ID of the user which can be used when interacting with other APIs.
email	string	Email address of this user.
email_verified	boolean	Whether this email address is verified (true) or unverified (false).
username	string	Username of this user.
phone_number	string	Phone number for this user. Follows the E.164 recommendation.
phone_verified	boolean	Whether this phone number has been verified (true) or not (false).
created_at	object
updated_at	object
identities	array	Array of user identity objects when accounts are linked.
app_metadata	object
user_metadata	object
picture	string	URL to picture, photo, or avatar of this user.
name	string	Name of this user.
nickname	string	Preferred nickname or alias of this user.
multifactor	array	List of multi-factor authentication providers with which this user has enrolled.
last_ip	string	Last IP address from which this user logged in.
last_login	object
logins_count	integer	Total number of logins this user has performed.
blocked	boolean	Whether this user was blocked by an administrator (true) or is not (false).
given_name	string	Given name/first name/forename of this user.
family_name	string	Family name/last name/surname of this user.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetUserResponseContent",
  "title": "GetUserResponseContent",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "user_id": {
      "type": "string",
      "description": "ID of the user which can be used when interacting with other APIs.",
      "default": "auth0|507f1f77bcf86cd799439020"
    },
    "email": {
      "type": "string",
      "description": "Email address of this user.",
      "default": "[email protected]",
      "format": "email"
    },
    "email_verified": {
      "type": "boolean",
      "description": "Whether this email address is verified (true) or unverified (false).",
      "default": false
    },
    "username": {
      "type": "string",
      "description": "Username of this user.",
      "default": "johndoe"
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number for this user. Follows the <a href=\"https://en.wikipedia.org/wiki/E.164\">E.164 recommendation</a>.",
      "default": "+199999999999999"
    },
    "phone_verified": {
      "type": "boolean",
      "description": "Whether this phone number has been verified (true) or not (false).",
      "default": false
    },
    "created_at": {
      "$ref": "#/components/schemas/UserDateSchema"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UserDateSchema"
    },
    "identities": {
      "type": "array",
      "description": "Array of user identity objects when accounts are linked.",
      "items": {
        "$ref": "#/components/schemas/UserIdentitySchema"
      }
    },
    "app_metadata": {
      "$ref": "#/components/schemas/UserAppMetadataSchema"
    },
    "user_metadata": {
      "$ref": "#/components/schemas/UserMetadataSchema"
    },
    "picture": {
      "type": "string",
      "description": "URL to picture, photo, or avatar of this user."
    },
    "name": {
      "type": "string",
      "description": "Name of this user."
    },
    "nickname": {
      "type": "string",
      "description": "Preferred nickname or alias of this user."
    },
    "multifactor": {
      "type": "array",
      "description": "List of multi-factor authentication providers with which this user has enrolled.",
      "items": {
        "type": "string"
      }
    },
    "last_ip": {
      "type": "string",
      "description": "Last IP address from which this user logged in."
    },
    "last_login": {
      "$ref": "#/components/schemas/UserDateSchema"
    },
    "logins_count": {
      "type": "integer",
      "description": "Total number of logins this user has performed."
    },
    "blocked": {
      "type": "boolean",
      "description": "Whether this user was blocked by an administrator (true) or is not (false)."
    },
    "given_name": {
      "type": "string",
      "description": "Given name/first name/forename of this user."
    },
    "family_name": {
      "type": "string",
      "description": "Family name/last name/surname of this user."
    }
  }
}