Auth0 · Schema

UpdateUserRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
blocked	boolean	Whether this user was blocked by an administrator (true) or not (false).
email_verified	boolean	Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless `verify_email` is set to true.
email	stringnull	Email address of this user.
phone_number	stringnull	The user's phone number (following the E.164 recommendation).
phone_verified	boolean	Whether this phone number has been verified (true) or not (false).
user_metadata	object	User metadata to which this user has read/write access.
app_metadata	object	User metadata to which this user has read-only access.
given_name	stringnull	Given name/first name/forename of this user.
family_name	stringnull	Family name/last name/surname of this user.
name	stringnull	Name of this user.
nickname	stringnull	Preferred nickname or alias of this user.
picture	stringnull	URL to picture, photo, or avatar of this user.
verify_email	boolean	Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter.
verify_phone_number	boolean	Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number for SMS connections.
password	stringnull	New password for this user. Only valid for database connections.
connection	string	Name of the connection to target for this user update.
client_id	string	Auth0 client ID. Only valid when updating email address.
username	stringnull	The user's username. Only valid if the connection requires a username.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateUserRequestContent",
  "title": "UpdateUserRequestContent",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "blocked": {
      "type": "boolean",
      "description": "Whether this user was blocked by an administrator (true) or not (false).",
      "default": false
    },
    "email_verified": {
      "type": "boolean",
      "description": "Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless `verify_email` is set to true.",
      "default": false
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "Email address of this user.",
      "default": "[email protected]",
      "format": "email"
    },
    "phone_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's phone number (following the E.164 recommendation).",
      "default": "+199999999999999",
      "pattern": "^\\+[0-9]{1,15}$"
    },
    "phone_verified": {
      "type": "boolean",
      "description": "Whether this phone number has been verified (true) or not (false).",
      "default": false
    },
    "user_metadata": {
      "$ref": "#/components/schemas/UserMetadata",
      "description": "User metadata to which this user has read/write access."
    },
    "app_metadata": {
      "$ref": "#/components/schemas/AppMetadata",
      "description": "User metadata to which this user has read-only access."
    },
    "given_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Given name/first name/forename of this user.",
      "default": "John",
      "minLength": 1,
      "maxLength": 150
    },
    "family_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Family name/last name/surname of this user.",
      "default": "Doe",
      "minLength": 1,
      "maxLength": 150
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Name of this user.",
      "default": "John Doe",
      "minLength": 1,
      "maxLength": 300
    },
    "nickname": {
      "type": [
        "string",
        "null"
      ],
      "description": "Preferred nickname or alias of this user.",
      "default": "Johnny",
      "minLength": 1,
      "maxLength": 300
    },
    "picture": {
      "type": [
        "string",
        "null"
      ],
      "description": "URL to picture, photo, or avatar of this user.",
      "default": "https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png",
      "format": "strict-uri"
    },
    "verify_email": {
      "type": "boolean",
      "description": "Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter.",
      "default": false
    },
    "verify_phone_number": {
      "type": "boolean",
      "description": "Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number for SMS connections.",
      "default": false
    },
    "password": {
      "type": [
        "string",
        "null"
      ],
      "description": "New password for this user. Only valid for database connections.",
      "default": "secret",
      "minLength": 1
    },
    "connection": {
      "type": "string",
      "description": "Name of the connection to target for this user update.",
      "default": "Initial-Connection",
      "minLength": 1
    },
    "client_id": {
      "type": "string",
      "description": "Auth0 client ID. Only valid when updating email address.",
      "default": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
      "minLength": 1
    },
    "username": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's username. Only valid if the connection requires a username.",
      "default": "johndoe",
      "minLength": 1,
      "maxLength": 128
    }
  }
}