Auth0 · Schema

UserIdentity

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
connection	string	Connection name of this identity.
user_id	object	user_id of this identity.
provider	string	Type of identity provider.
profileData	object
isSocial	boolean	Whether the identity provider is a social provider (true) or not (false).
access_token	string	IDP access token returned 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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserIdentity",
  "title": "UserIdentity",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "provider",
    "user_id",
    "connection"
  ],
  "properties": {
    "connection": {
      "type": "string",
      "description": "Connection name of this identity.",
      "default": "twitter"
    },
    "user_id": {
      "$ref": "#/components/schemas/UserId",
      "description": "user_id of this identity."
    },
    "provider": {
      "type": "string",
      "description": "Type of identity provider.",
      "default": "twitter"
    },
    "profileData": {
      "$ref": "#/components/schemas/UserProfileData"
    },
    "isSocial": {
      "type": "boolean",
      "description": "Whether the identity provider is a social provider (true) or not (false)."
    },
    "access_token": {
      "type": "string",
      "description": "IDP access token returned 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."
    }
  }
}