Clerk Backend API

{
  "type": "object",
  "required": [
    "object",
    "id",
    "user_id",
    "actor",
    "status",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "nullable": true
    },
    "actor": {
      "type": "object"
    },
    "token": {
      "type": "string",
      "nullable": true
    },
    "object": {
      "enum": [
        "actor_token"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "pending",
        "accepted",
        "revoked"
      ],
      "type": "string"
    },
    "user_id": {
      "type": "string"
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "user_id",
    "actor"
  ],
  "properties": {
    "actor": {
      "type": "object",
      "example": {
        "sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"
      },
      "description": "The actor payload. It needs to include a sub property which should contain the ID of the actor.\nThis whole payload will be also included in the JWT session token."
    },
    "user_id": {
      "type": "string",
      "description": "The ID of the user that can use the newly created sign in token."
    },
    "expires_in_seconds": {
      "type": "integer",
      "default": 3600,
      "description": "Optional parameter to specify the life duration of the actor token in seconds.\nBy default, the duration is 1 hour."
    },
    "session_max_duration_in_seconds": {
      "type": "integer",
      "default": 1800,
      "description": "The maximum duration that the session which will be created by the generated actor token should last.\nBy default, the duration of a session created via an actor token, lasts 30 minutes."
    }
  }
}

{
  "type": "object",
  "required": [
    "status",
    "strategy"
  ],
  "properties": {
    "status": {
      "enum": [
        "verified"
      ],
      "type": "string"
    },
    "attempts": {
      "type": "integer",
      "nullable": true
    },
    "strategy": {
      "enum": [
        "admin"
      ],
      "type": "string"
    },
    "expire_at": {
      "type": "integer",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "required": [
    "identifier"
  ],
  "properties": {
    "identifier": {
      "type": "string",
      "description": "The identifier to be added in the block-list.\nThis can be an email address, a phone number or a web3 wallet."
    }
  }
}

{
  "type": "object",
  "required": [
    "identifier"
  ],
  "properties": {
    "notify": {
      "type": "boolean",
      "default": false,
      "description": "This flag denotes whether the given identifier will receive an invitation to join the application.\nNote that this only works for email address and phone number identifiers."
    },
    "identifier": {
      "type": "string",
      "description": "The identifier to be added in the allow-list.\nThis can be an email address, a phone number or a web3 wallet."
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/AllowlistIdentifier"
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "object": {
      "enum": [
        "allowlist_identifier"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.\n"
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation\n"
    },
    "identifier": {
      "type": "string",
      "description": "An email address or a phone number.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "instance_id": {
      "type": "string"
    },
    "invitation_id": {
      "type": "string"
    },
    "identifier_type": {
      "enum": [
        "email_address",
        "phone_number",
        "web3_wallet"
      ],
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "home_url": {
      "type": "string",
      "description": "The new home URL of the production instance e.g. https://www.example.com"
    }
  }
}

{
  "type": "object",
  "properties": {
    "test_mode": {
      "type": "boolean",
      "nullable": true,
      "description": "Toggles test mode for this instance, allowing the use of test email addresses and phone numbers.\nDefaults to true for development instances."
    },
    "from_email_address": {
      "type": "string",
      "nullable": true,
      "description": "The local part of the email address from which authentication-related emails (e.g. OTP code, magic links) will be sent.\nOnly alphanumeric values are allowed.\nNote that this value should contain only the local part of the address (e.g. `foo` for `foo@example.com`)."
    },
    "progressive_sign_up": {
      "type": "boolean",
      "nullable": true,
      "description": "Enable the Progressive Sign Up algorithm. Refer to the [docs](https://clerk.com/docs/upgrade-guides/progressive-sign-up) for more info."
    },
    "session_token_template": {
      "type": "string",
      "nullable": true,
      "description": "The name of the JWT Template used to augment your session tokens. To disable this, pass an empty string."
    },
    "restricted_to_allowlist": {
      "type": "boolean",
      "default": false,
      "nullable": true,
      "description": "Whether sign up is restricted to email addresses, phone numbers and usernames that are on the allowlist."
    },
    "enhanced_email_deliverability": {
      "type": "boolean",
      "nullable": true,
      "description": "The \"enhanced_email_deliverability\" feature will send emails from \"verifications@clerk.dev\" instead of your domain.\nThis can be helpful if you do not have a high domain reputation."
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "object": {
      "enum": [
        "instance_settings"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "from_email_address": {
      "type": "string"
    },
    "progressive_sign_up": {
      "type": "boolean"
    },
    "restricted_to_allowlist": {
      "type": "boolean"
    },
    "enhanced_email_deliverability": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "properties": {
    "home_url": {
      "type": "string",
      "description": "The new home URL of the production instance e.g. https://www.example.com"
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "object": {
      "enum": [
        "blocklist_identifier"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.\n"
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation\n"
    },
    "identifier": {
      "type": "string",
      "description": "An email address, email domain, phone number or web3 wallet.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "instance_id": {
      "type": "string"
    },
    "identifier_type": {
      "enum": [
        "email_address",
        "phone_number",
        "web3_wallet"
      ],
      "type": "string"
    }
  }
}

{
  "type": "object",
  "required": [
    "data",
    "total_count"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BlocklistIdentifier"
      }
    },
    "total_count": {
      "type": "integer",
      "format": "int64",
      "description": "Total number of blocklist identifiers\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "host",
    "value",
    "required"
  ],
  "properties": {
    "host": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "required": {
      "type": "boolean",
      "description": "Denotes whether this CNAME target is required to be set in order for the domain to be considered deployed.\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "message",
    "long_message",
    "code"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "meta": {
      "type": "object"
    },
    "message": {
      "type": "string"
    },
    "long_message": {
      "type": "string"
    },
    "clerk_trace_id": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "required": [
    "errors"
  ],
  "properties": {
    "meta": {
      "type": "object"
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ClerkError"
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "object",
    "id",
    "session_ids",
    "sessions",
    "sign_in_id",
    "sign_up_id",
    "last_active_session_id",
    "updated_at",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "String representing the identifier of the session.\n"
    },
    "object": {
      "enum": [
        "client"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.\n"
    },
    "sessions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Session"
      }
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation.\n"
    },
    "sign_in_id": {
      "type": "string",
      "nullable": true
    },
    "sign_up_id": {
      "type": "string",
      "nullable": true
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "session_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "last_active_session_id": {
      "type": "string",
      "nullable": true,
      "description": "Last active session_id.\n"
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Client"
  }
}

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "A JWT Token that represents the active client."
    }
  }
}

{
  "type": "object",
  "required": [
    "object",
    "deleted"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "object": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "required": [
    "object",
    "id",
    "name",
    "is_satellite",
    "frontend_api_url",
    "development_origin"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "object": {
      "enum": [
        "domain"
      ],
      "type": "string"
    },
    "proxy_url": {
      "type": "string",
      "nullable": true
    },
    "is_satellite": {
      "type": "boolean"
    },
    "cname_targets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CNameTarget"
      },
      "nullable": true
    },
    "frontend_api_url": {
      "type": "string"
    },
    "development_origin": {
      "type": "string"
    },
    "accounts_portal_url": {
      "type": "string",
      "nullable": true,
      "description": "Null for satellite domains.\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "data",
    "total_count"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Domain"
      }
    },
    "total_count": {
      "type": "integer",
      "format": "int64",
      "description": "Total number of domains\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "is_satellite"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The new domain name. Can contain the port for development instances."
    },
    "proxy_url": {
      "type": "string",
      "description": "The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances."
    },
    "is_satellite": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Marks the new domain as satellite. Only `true` is accepted at the moment."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "description": "The new domain name. For development instances, can contain the port,\ni.e `myhostname:3000`. For production instances, must be a valid FQDN,\ni.e `mysite.com`. Cannot contain protocol scheme."
    },
    "proxy_url": {
      "type": "string",
      "nullable": true,
      "description": "The full URL of the proxy that will forward requests to Clerk's Frontend API.\nCan only be updated for production instances."
    }
  }
}

{
  "type": "object",
  "required": [
    "object",
    "email_address",
    "verification",
    "linked_to",
    "reserved",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "object": {
      "enum": [
        "email_address"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.\n"
    },
    "reserved": {
      "type": "boolean"
    },
    "linked_to": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IdentificationLink"
      }
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation\n"
    },
    "verification": {
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/components/schemas/OTP"
        },
        {
          "$ref": "#/components/schemas/Admin"
        },
        {
          "$ref": "#/components/schemas/Oauth"
        }
      ],
      "nullable": true
    },
    "email_address": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "primary": {
      "type": "boolean",
      "nullable": true,
      "description": "Create this email address as the primary email address for the user.\nDefault: false, unless it is the first email address."
    },
    "user_id": {
      "type": "string",
      "description": "The ID representing the user"
    },
    "verified": {
      "type": "boolean",
      "nullable": true,
      "description": "When created, the email address will be marked as verified."
    },
    "email_address": {
      "type": "string",
      "description": "The new email address. Must adhere to the RFC 5322 specification for email address format."
    }
  }
}

{
  "type": "object",
  "properties": {
    "primary": {
      "type": "boolean",
      "nullable": true,
      "description": "Set this email address as the primary email address for the user."
    },
    "verified": {
      "type": "boolean",
      "nullable": true,
      "description": "The email address will be marked as verified."
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Template"
  }
}

{
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "description": "The template body before variable interpolation"
    },
    "subject": {
      "type": "string",
      "nullable": true,
      "description": "The email subject.\nApplicable only to email templates."
    },
    "from_email_name": {
      "type": "string",
      "description": "The local part of the From email address that will be used for emails.\nFor example, in the address 'hello@example.com', the local part is 'hello'.\nApplicable only to email templates."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "delivered_by_clerk": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether Clerk should deliver emails or SMS messages based on the current template"
    }
  }
}

{
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "description": "The template body before variable interpolation"
    },
    "name": {
      "type": "string",
      "description": "The user-friendly name of the template"
    },
    "markup": {
      "type": "string",
      "nullable": true,
      "description": "The editor markup used to generate the body of the template"
    },
    "subject": {
      "type": "string",
      "nullable": true,
      "description": "The email subject.\nApplicable only to email templates."
    },
    "from_email_name": {
      "type": "string",
      "description": "The local part of the From email address that will be used for emails.\nFor example, in the address 'hello@example.com', the local part is 'hello'.\nApplicable only to email templates."
    },
    "delivered_by_clerk": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether Clerk should deliver emails or SMS messages based on the current template"
    }
  }
}

{
  "type": "object",
  "required": [
    "type",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "enum": [
        "oauth_google",
        "oauth_mock",
        "saml"
      ],
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "object": {
      "enum": [
        "instance_restrictions"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "allowlist": {
      "type": "boolean"
    },
    "blocklist": {
      "type": "boolean"
    },
    "block_email_subaddresses": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "properties": {
    "hibp": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the instance should be using the HIBP service to check passwords for breaches"
    },
    "test_mode": {
      "type": "boolean",
      "nullable": true,
      "description": "Toggles test mode for this instance, allowing the use of test email addresses and phone numbers.\nDefaults to true for development instances."
    },
    "support_email": {
      "type": "string",
      "nullable": true
    },
    "cookieless_dev": {
      "type": "boolean",
      "deprecated": true,
      "description": "Whether the instance should operate in cookieless development mode (i.e. without third-party cookies).\nDeprecated: Please use `url_based_session_syncing` instead."
    },
    "allowed_origins": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "For browser-like stacks such as browser extensions, Electron, or Capacitor.js the instance allowed origins need to be updated with the request origin value.\nFor Chrome extensions popup, background, or service worker pages the origin is chrome-extension://extension_uiid. For Electron apps the default origin is http://localhost:3000. For Capacitor, the origin is capacitor://localhost."
    },
    "clerk_js_version": {
      "type": "string",
      "nullable": true
    },
    "development_origin": {
      "type": "string",
      "nullable": true
    },
    "url_based_session_syncing": {
      "type": "boolean",
      "description": "Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies)."
    },
    "enhanced_email_deliverability": {
      "type": "boolean",
      "nullable": true,
      "description": "The \"enhanced_email_deliverability\" feature will send emails from \"verifications@clerk.dev\" instead of your domain.\nThis can be helpful if you do not have a high domain reputation."
    }
  }
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "nullable": true
    },
    "creator_role_id": {
      "type": "string",
      "description": "Specify what the default organization role is for an organization creator."
    },
    "domains_enabled": {
      "type": "boolean",
      "nullable": true
    },
    "admin_delete_enabled": {
      "type": "boolean",
      "nullable": true
    },
    "domains_default_role_id": {
      "type": "string",
      "description": "Specify what the default organization role is for the organization domains."
    },
    "max_allowed_memberships": {
      "type": "integer",
      "nullable": true
    },
    "domains_enrollment_modes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specify which enrollment modes to enable for your Organization Domains.\nSupported modes are 'automatic_invitation' & 'automatic_suggestion'."
    }
  }
}

{
  "type": "object",
  "properties": {
    "allowlist": {
      "type": "boolean",
      "nullable": true
    },
    "blocklist": {
      "type": "boolean",
      "nullable": true
    },
    "block_email_subaddresses": {
      "type": "boolean",
      "nullable": true
    },
    "block_disposable_email_domains": {
      "type": "boolean",
      "nullable": true
    }
  }
}

{
  "type": "object",
  "required": [
    "object",
    "id",
    "email_address",
    "status",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "nullable": true
    },
    "object": {
      "enum": [
        "invitation"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "pending",
        "accepted",
        "revoked"
      ],
      "type": "string",
      "example": "pending"
    },
    "revoked": {
      "type": "boolean",
      "example": false
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "email_address": {
      "type": "string",
      "format": "email"
    },
    "public_metadata": {
      "type": "object"
    }
  }
}

{
  "type": "object",
  "required": [
    "email_address"
  ],
  "properties": {
    "notify": {
      "type": "boolean",
      "default": true,
      "nullable": true,
      "description": "Optional flag which denotes whether an email invitation should be sent to the given email address.\nDefaults to true."
    },
    "redirect_url": {
      "type": "string",
      "description": "Optional URL which specifies where to redirect the user once they click the invitation link.\nThis is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components."
    },
    "email_address": {
      "type": "string",
      "description": "The email address the invitation will be sent to"
    },
    "ignore_existing": {
      "type": "boolean",
      "default": false,
      "nullable": true,
      "description": "Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user."
    },
    "public_metadata": {
      "type": "object",
      "description": "Metadata that will be attached to the newly created invitation.\nThe value of this property should be a well-formed JSON object.\nOnce the user accepts the invitation and signs up, these metadata will end up in the user's public metadata."
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Invitation"
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/Invitation"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "enum": [
            "revoked"
          ],
          "type": "string",
          "example": "revoked"
        },
        "revoked": {
          "enum": [
            true
          ],
          "type": "boolean",
          "example": true
        }
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "object",
    "id",
    "name",
    "claims",
    "lifetime",
    "allowed_clock_skew",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "claims": {
      "type": "object"
    },
    "object": {
      "enum": [
        "jwt_template"
      ],
      "type": "string"
    },
    "lifetime": {
      "type": "integer"
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "signing_algorithm": {
      "type": "string"
    },
    "allowed_clock_skew": {
      "type": "integer"
    },
    "custom_signing_key": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": false,
      "description": "JWT template name"
    },
    "claims": {
      "type": "object",
      "nullable": false,
      "description": "JWT template claims in JSON format"
    },
    "lifetime": {
      "type": "number",
      "maximum": 315360000,
      "minimum": 30,
      "nullable": true,
      "description": "JWT token lifetime"
    },
    "signing_key": {
      "type": "string",
      "nullable": true,
      "description": "The custom signing private key to use when minting JWTs"
    },
    "signing_algorithm": {
      "type": "string",
      "nullable": true,
      "description": "The custom signing algorithm to use when minting JWTs"
    },
    "allowed_clock_skew": {
      "type": "number",
      "maximum": 300,
      "minimum": 0,
      "nullable": true,
      "description": "JWT token allowed clock skew"
    },
    "custom_signing_key": {
      "type": "boolean",
      "nullable": false,
      "description": "Whether a custom signing key/algorithm is also provided for this template"
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/JWTTemplate"
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": false,
      "description": "JWT template name"
    },
    "claims": {
      "type": "object",
      "nullable": false,
      "description": "JWT template claims in JSON format"
    },
    "lifetime": {
      "type": "number",
      "maximum": 315360000,
      "minimum": 30,
      "nullable": true,
      "description": "JWT token lifetime"
    },
    "signing_key": {
      "type": "string",
      "nullable": true,
      "description": "The custom signing private key to use when minting JWTs"
    },
    "signing_algorithm": {
      "type": "string",
      "nullable": true,
      "description": "The custom signing algorithm to use when minting JWTs"
    },
    "allowed_clock_skew": {
      "type": "number",
      "maximum": 300,
      "minimum": 0,
      "nullable": true,
      "description": "JWT token allowed clock skew"
    },
    "custom_signing_key": {
      "type": "boolean",
      "nullable": false,
      "description": "Whether a custom signing key/algorithm is also provided for this template"
    }
  }
}

{
  "type": "object",
  "required": [
    "object",
    "id",
    "instance_id",
    "name",
    "public",
    "client_id",
    "scopes",
    "callback_url",
    "authorize_url",
    "token_fetch_url",
    "user_info_url",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "object": {
      "enum": [
        "oauth_application"
      ],
      "type": "string"
    },
    "public": {
      "type": "boolean"
    },
    "scopes": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "created_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of creation.\n"
    },
    "updated_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp of last update.\n"
    },
    "instance_id": {
      "type": "string"
    },
    "callback_url": {
      "type": "string"
    },
    "authorize_url": {
      "type": "string"
    },
    "user_info_url": {
      "type": "string"
    },
    "token_fetch_url": {
      "type": "string"
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/OAuthApplication"
    },
    {
      "type": "object",
      "properties": {
        "client_secret": {
          "type": "string",
          "description": "Empty if public client.\n"
        }
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "data",
    "total_count"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OAuthApplication"
      }
    },
    "total_count": {
      "type": "integer",
      "format": "int64",
      "description": "Total number of OAuth applications\n"
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "callback_url"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the new OAuth application"
    },
    "public": {
      "type": "boolean",
      "description": "If true, this client is public and cannot securely store a client secret.\nOnly the authorization code flow with proof key for code exchange (PKCE) may be used.\nPublic clients cannot be updated to be confidential clients, and vice versa."
    },
    "scopes": {
      "type": "string",
      "default": "profile email",
      "example": "profile email public_metadata",
      "description": "Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces."
    },
    "callback_url": {
      "type": "string",
      "description": "The callback URL of the new OAuth application"
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The new name of the OAuth application"
    },
    "scopes": {
      "type": "string",
      "default": "profile email",
      "example": "profile email public_metadata private_metadata",
      "description": "Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces."
    },
    "callback_url": {
      "type": "string",
      "description": "The new callback URL of the OAuth application"
    }
  }
}