Auth0 · Schema

ClientGrantResponseContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
id	string	ID of the client grant.
client_id	string	ID of the client.
audience	string	The audience (API identifier) of this client grant.
scope	array	Scopes allowed for this client grant.
organization_usage	object
allow_any_organization	boolean	If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations.
default_for	object
is_system	boolean	If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly.
subject_type	object
authorization_details_types	array	Types of authorization_details allowed for this client grant.
allow_all_scopes	boolean	If enabled, all scopes configured on the resource server are allowed for this grant.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientGrantResponseContent",
  "title": "ClientGrantResponseContent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the client grant."
    },
    "client_id": {
      "type": "string",
      "description": "ID of the client."
    },
    "audience": {
      "type": "string",
      "description": "The audience (API identifier) of this client grant.",
      "minLength": 1
    },
    "scope": {
      "type": "array",
      "description": "Scopes allowed for this client grant.",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "organization_usage": {
      "$ref": "#/components/schemas/ClientGrantOrganizationUsageEnum"
    },
    "allow_any_organization": {
      "type": "boolean",
      "description": "If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations."
    },
    "default_for": {
      "$ref": "#/components/schemas/ClientGrantDefaultForEnum",
      "x-release-lifecycle": "GA"
    },
    "is_system": {
      "type": "boolean",
      "description": "If enabled, this grant is a special grant created by Auth0. It cannot be modified or deleted directly."
    },
    "subject_type": {
      "$ref": "#/components/schemas/ClientGrantSubjectTypeEnum"
    },
    "authorization_details_types": {
      "type": "array",
      "description": "Types of authorization_details allowed for this client grant.",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255
      }
    },
    "allow_all_scopes": {
      "type": "boolean",
      "description": "If enabled, all scopes configured on the resource server are allowed for this grant."
    }
  }
}