WorkOS · Schema

CreateOrganizationApiKeyDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
name	string	The name for the API key.
permissions	array	The permission slugs to assign to the API key.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOrganizationApiKeyDto",
  "title": "CreateOrganizationApiKeyDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name for the API key.",
      "example": "Production API Key"
    },
    "permissions": {
      "description": "The permission slugs to assign to the API key.",
      "example": [
        "posts:read",
        "posts:write"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name"
  ]
}