Auth0 · Schema

UserIdentitySchema

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name Type Description
connection string Name of the connection containing this identity.
user_id string Unique identifier of the user user for this identity.
provider object
isSocial boolean Whether this identity is from a social provider (true) or not (false).
access_token string IDP access token returned only if scope read:user_idp_tokens is defined.
access_token_secret string IDP access token secret returned only if scope read:user_idp_tokens is defined.
refresh_token string IDP refresh token returned only if scope read:user_idp_tokens is defined.
profileData object
View JSON Schema on GitHub

JSON Schema

auth0-useridentityschema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserIdentitySchema",
  "title": "UserIdentitySchema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "type": "string",
      "description": "Name of the connection containing this identity."
    },
    "user_id": {
      "type": "string",
      "description": "Unique identifier of the user user for this identity."
    },
    "provider": {
      "$ref": "#/components/schemas/UserIdentityProviderEnum"
    },
    "isSocial": {
      "type": "boolean",
      "description": "Whether this identity is from a social provider (true) or not (false)."
    },
    "access_token": {
      "type": "string",
      "description": "IDP access token returned only if scope read:user_idp_tokens is defined."
    },
    "access_token_secret": {
      "type": "string",
      "description": "IDP access token secret returned only if scope read:user_idp_tokens is defined."
    },
    "refresh_token": {
      "type": "string",
      "description": "IDP refresh token returned only if scope read:user_idp_tokens is defined."
    },
    "profileData": {
      "$ref": "#/components/schemas/UserProfileData"
    }
  }
}