WorkOS · Schema

CreateOAuthApplicationDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
name	string	The name of the application.
application_type	string	The type of application to create.
description	stringnull	A description for the application.
scopes	arraynull	The OAuth scopes granted to the application.
redirect_uris	arraynull	Redirect URIs for the application.
uses_pkce	booleannull	Whether the application uses PKCE (Proof Key for Code Exchange).
is_first_party	boolean	Whether this is a first-party application. Third-party applications require an organization_id.
organization_id	stringnull	The organization ID this application belongs to. Required when is_first_party is false.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOAuthApplicationDto",
  "title": "CreateOAuthApplicationDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the application.",
      "example": "My Application"
    },
    "application_type": {
      "type": "string",
      "description": "The type of application to create.",
      "const": "oauth"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "A description for the application.",
      "example": "An application for managing user access"
    },
    "scopes": {
      "description": "The OAuth scopes granted to the application.",
      "example": [
        "openid",
        "profile",
        "email"
      ],
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "redirect_uris": {
      "description": "Redirect URIs for the application.",
      "example": [
        {
          "uri": "https://example.com/callback",
          "default": true
        }
      ],
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RedirectUriDto"
      }
    },
    "uses_pkce": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether the application uses PKCE (Proof Key for Code Exchange).",
      "example": true
    },
    "is_first_party": {
      "type": "boolean",
      "description": "Whether this is a first-party application. Third-party applications require an organization_id.",
      "example": true
    },
    "organization_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The organization ID this application belongs to. Required when is_first_party is false.",
      "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
    }
  },
  "required": [
    "name",
    "application_type",
    "is_first_party"
  ]
}