WorkOS · Schema

UserObject

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
id string Your application's user identifier, which will be stored as an [`external_id`](/authkit/metadata/external-identifiers). Used for upserting and deduplication.
email string The user's email address.
first_name string The user's first name.
last_name string The user's last name.
metadata object A set of key-value pairs to attach to the user.
View JSON Schema on GitHub

JSON Schema

workos-userobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserObject",
  "title": "UserObject",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Your application's user identifier, which will be stored as an [`external_id`](/authkit/metadata/external-identifiers). Used for upserting and deduplication.",
      "example": "user_12345"
    },
    "email": {
      "type": "string",
      "description": "The user's email address.",
      "example": "marcelina.davis@example.com"
    },
    "first_name": {
      "type": "string",
      "description": "The user's first name.",
      "example": "Marcelina"
    },
    "last_name": {
      "type": "string",
      "description": "The user's last name.",
      "example": "Davis"
    },
    "metadata": {
      "type": "object",
      "description": "A set of key-value pairs to attach to the user.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 600
      },
      "maxProperties": 50,
      "example": {
        "department": "Engineering",
        "role": "Developer"
      },
      "propertyNames": {
        "maxLength": 40
      }
    }
  },
  "required": [
    "id",
    "email"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/workos-userobject"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.