WorkOS · Schema

ConnectApplication

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP
View JSON Schema on GitHub

JSON Schema

workos-connectapplication-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectApplication",
  "title": "ConnectApplication",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "object": {
          "type": "string",
          "description": "Distinguishes the connect application object.",
          "example": "connect_application",
          "const": "connect_application"
        },
        "id": {
          "type": "string",
          "description": "The unique ID of the connect application.",
          "example": "conn_app_01HXYZ123456789ABCDEFGHIJ"
        },
        "client_id": {
          "type": "string",
          "description": "The client ID of the connect application.",
          "example": "client_01HXYZ123456789ABCDEFGHIJ"
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "A description of the connect application.",
          "example": "An application for managing user access"
        },
        "name": {
          "type": "string",
          "description": "The name of the connect application.",
          "example": "My Application"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The scopes available for this application.",
          "example": [
            "openid",
            "profile",
            "email"
          ]
        },
        "created_at": {
          "format": "date-time",
          "type": "string",
          "description": "An ISO 8601 timestamp.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "updated_at": {
          "format": "date-time",
          "type": "string",
          "description": "An ISO 8601 timestamp.",
          "example": "2026-01-15T12:00:00.000Z"
        }
      },
      "required": [
        "object",
        "id",
        "client_id",
        "description",
        "name",
        "scopes",
        "created_at",
        "updated_at"
      ]
    },
    {
      "oneOf": [
        {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "application_type": {
                  "type": "string",
                  "description": "The type of the application.",
                  "const": "oauth"
                },
                "redirect_uris": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "uri": {
                        "type": "string",
                        "format": "uri",
                        "description": "The redirect URI for the application.",
                        "example": "https://example.com/callback"
                      },
                      "default": {
                        "type": "boolean",
                        "description": "Whether this is the default redirect URI.",
                        "example": true
                      }
                    },
                    "required": [
                      "uri",
                      "default"
                    ]
                  },
                  "description": "The redirect URIs configured for this application."
                },
                "uses_pkce": {
                  "type": "boolean",
                  "description": "Whether the application uses PKCE for authorization.",
                  "example": true
                }
              },
              "required": [
                "application_type",
                "redirect_uris",
                "uses_pkce"
              ]
            },
            {
              "oneOf": [
                {
                  "type": "object",
                  "properties": {
                    "is_first_party": {
                      "type": "boolean",
                      "description": "Whether the application is a first-party application.",
                      "example": true,
                      "const": true
                    }
                  },
                  "required": [
                    "is_first_party"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "is_first_party": {
                      "type": "boolean",
                      "description": "Whether the application is a first-party application.",
                      "example": false,
                      "const": false
                    },
                    "was_dynamically_registered": {
                      "type": "boolean",
                      "description": "Whether the application was dynamically registered.",
                      "example": false,
                      "const": false
                    },
                    "organization_id": {
                      "type": "string",
                      "description": "The ID of the organization the application belongs to.",
                      "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
                    }
                  },
                  "required": [
                    "is_first_party",
                    "was_dynamically_registered",
                    "organization_id"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "is_first_party": {
                      "type": "boolean",
                      "description": "Whether the application is a first-party application.",
                      "example": false,
                      "const": false
                    },
                    "was_dynamically_registered": {
                      "type": "boolean",
                      "description": "Whether the application was dynamically registered.",
                      "example": true,
                      "const": true
                    }
                  },
                  "required": [
                    "is_first_party",
                    "was_dynamically_registered"
                  ]
                }
              ]
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "application_type": {
              "type": "string",
              "description": "The type of the application.",
              "example": "m2m",
              "const": "m2m"
            },
            "organization_id": {
              "type": "string",
              "description": "The ID of the organization the application belongs to.",
              "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
            }
          },
          "required": [
            "application_type",
            "organization_id"
          ]
        }
      ]
    }
  ]
}