WorkOS · Schema

ValidateApiKeyDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
value string The value for an API key.
View JSON Schema on GitHub

JSON Schema

workos-validateapikeydto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ValidateApiKeyDto",
  "title": "ValidateApiKeyDto",
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The value for an API key.",
      "example": "sk_example_1234567890abcdef"
    }
  },
  "required": [
    "value"
  ]
}