WorkOS · Schema

UpdateOAuthApplicationDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
name string The name of the application.
description stringnull A description for the application.
scopes arraynull The OAuth scopes granted to the application.
redirect_uris arraynull Updated redirect URIs for the application. OAuth applications only.
View JSON Schema on GitHub

JSON Schema

workos-updateoauthapplicationdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateOAuthApplicationDto",
  "title": "UpdateOAuthApplicationDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the application.",
      "example": "My Application"
    },
    "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": "Updated redirect URIs for the application. OAuth applications only.",
      "example": [
        {
          "uri": "https://example.com/callback",
          "default": true
        }
      ],
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RedirectUriDto"
      }
    }
  }
}