WorkOS · Schema

WorkOS Directory

A linked SCIM directory through which a customer provisions users and groups.

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string
id	string
organization_id	string
type	string
state	string
name	string
domain	stringnull
created_at	string
updated_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workos/main/json-schema/workos-directory-schema.json",
  "title": "WorkOS Directory",
  "description": "A linked SCIM directory through which a customer provisions users and groups.",
  "type": "object",
  "required": ["id", "organization_id", "type", "state"],
  "properties": {
    "object": { "type": "string", "const": "directory" },
    "id": { "type": "string", "pattern": "^directory_[A-Z0-9]{26}$" },
    "organization_id": { "type": "string", "pattern": "^org_[A-Z0-9]{26}$" },
    "type": {
      "type": "string",
      "enum": [
        "azure scim v2.0", "bamboohr", "breathe hr", "cyberark scim v2.0", "fourth hr", "generic scim v2.0",
        "gsuite directory", "hibob", "jump cloud scim v2.0", "okta scim v2.0", "onelogin scim v2.0",
        "people hr", "personio", "pingfederate scim v2.0", "rippling scim v2.0", "s f t p", "s f t p workday",
        "workday"
      ]
    },
    "state": { "type": "string", "enum": ["linked", "unlinked", "invalid_credentials", "validating"] },
    "name": { "type": "string" },
    "domain": { "type": ["string", "null"] },
    "created_at": { "type": "string", "format": "date-time" },
    "updated_at": { "type": "string", "format": "date-time" }
  }
}

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-directory"

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.

GitHub Google LinkedIn

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