WorkOS · Schema

UpdateOrganizationDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
name string The name of the organization.
allow_profiles_outside_organization boolean Whether the organization allows profiles from outside the organization to sign in.
domains array The domains associated with the organization. Deprecated in favor of `domain_data`.
domain_data array The domains associated with the organization, including verification state.
stripe_customer_id string The Stripe customer ID associated with the organization.
metadata objectnull Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.
external_id stringnull An external identifier for the Organization.
View JSON Schema on GitHub

JSON Schema

workos-updateorganizationdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateOrganizationDto",
  "title": "UpdateOrganizationDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the organization.",
      "example": "Foo Corp"
    },
    "allow_profiles_outside_organization": {
      "type": "boolean",
      "description": "Whether the organization allows profiles from outside the organization to sign in.",
      "example": false
    },
    "domains": {
      "description": "The domains associated with the organization. Deprecated in favor of `domain_data`.",
      "example": [
        "foo-corp.com"
      ],
      "deprecated": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "domain_data": {
      "description": "The domains associated with the organization, including verification state.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrganizationDomainDataDto"
      }
    },
    "stripe_customer_id": {
      "type": "string",
      "description": "The Stripe customer ID associated with the organization.",
      "example": "cus_R9qWAGMQ6nGE7V"
    },
    "metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string",
        "maxLength": 600
      },
      "maxProperties": 50,
      "example": {
        "tier": "diamond"
      },
      "description": "Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.",
      "propertyNames": {
        "maxLength": 40
      }
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 128,
      "pattern": "^[\\x00-\\x7F]+$",
      "example": "2fe01467-f7ea-4dd2-8b79-c2b4f56d0191",
      "description": "An external identifier for the Organization."
    }
  }
}

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-updateorganizationdto"
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.