Auth0 · Schema

CreateUserRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
email	string	The user's email.
phone_number	string	The user's phone number (following the E.164 recommendation).
user_metadata	object
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). User will receive a verification email after creation if `email_verified` is false or not specified
phone_verified	boolean	Whether this phone number has been verified (true) or not (false).
app_metadata	object
given_name	string	The user's given name(s).
family_name	string	The user's family name(s).
name	string	The user's full name.
nickname	string	The user's nickname.
picture	string	A URI pointing to the user's picture.
user_id	string	The external user's id provided by the identity provider.
connection	string	Name of the connection this user should be created in.
password	string	Initial password for this user. Only valid for auth0 connection strategy.
verify_email	boolean	Whether the user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter.
username	string	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/CreateUserRequestContent",
  "title": "CreateUserRequestContent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "connection"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "The user's email.",
      "default": "[email protected]",
      "format": "email"
    },
    "phone_number": {
      "type": "string",
      "description": "The user's phone number (following the E.164 recommendation).",
      "default": "+199999999999999",
      "pattern": "^\\+[0-9]{1,15}$"
    },
    "user_metadata": {
      "$ref": "#/components/schemas/UserMetadata"
    },
    "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). User will receive a verification email after creation if `email_verified` is false or not specified",
      "default": false
    },
    "phone_verified": {
      "type": "boolean",
      "description": "Whether this phone number has been verified (true) or not (false).",
      "default": false
    },
    "app_metadata": {
      "$ref": "#/components/schemas/AppMetadata"
    },
    "given_name": {
      "type": "string",
      "description": "The user's given name(s).",
      "default": "John",
      "minLength": 1,
      "maxLength": 150
    },
    "family_name": {
      "type": "string",
      "description": "The user's family name(s).",
      "default": "Doe",
      "minLength": 1,
      "maxLength": 150
    },
    "name": {
      "type": "string",
      "description": "The user's full name.",
      "default": "John Doe",
      "minLength": 1,
      "maxLength": 300
    },
    "nickname": {
      "type": "string",
      "description": "The user's nickname.",
      "default": "Johnny",
      "minLength": 1,
      "maxLength": 300
    },
    "picture": {
      "type": "string",
      "description": "A URI pointing to the user's picture.",
      "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"
    },
    "user_id": {
      "type": "string",
      "description": "The external user's id provided by the identity provider.",
      "default": "abc",
      "minLength": 0,
      "maxLength": 255,
      "pattern": "^\\S*$"
    },
    "connection": {
      "type": "string",
      "description": "Name of the connection this user should be created in.",
      "default": "Initial-Connection",
      "minLength": 1
    },
    "password": {
      "type": "string",
      "description": "Initial password for this user. Only valid for auth0 connection strategy.",
      "default": "secret",
      "minLength": 1
    },
    "verify_email": {
      "type": "boolean",
      "description": "Whether the user will receive a verification email after creation (true) or no email (false). Overrides behavior of `email_verified` parameter.",
      "default": false
    },
    "username": {
      "type": "string",
      "description": "The user's username. Only valid if the connection requires a username.",
      "default": "johndoe",
      "minLength": 1,
      "maxLength": 128
    }
  }
}