Auth0 · Schema

Auth0 Hook

JSON Schema for Auth0 Hook entity, extracted from the Auth0 Management API OpenAPI v2.0 spec (component: Hook).

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name Type Description
triggerId string Trigger ID
id string ID of this hook.
name string Name of this hook.
enabled boolean Whether this hook will be executed (true) or ignored (false).
script string Code to be executed when this hook runs.
dependencies object
View JSON Schema on GitHub

JSON Schema

auth0-hook-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/auth0/main/json-schema/auth0-hook-schema.json",
  "title": "Auth0 Hook",
  "description": "JSON Schema for Auth0 Hook entity, extracted from the Auth0 Management API OpenAPI v2.0 spec (component: Hook).",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "triggerId": {
      "type": "string",
      "description": "Trigger ID"
    },
    "id": {
      "type": "string",
      "description": "ID of this hook.",
      "default": "00001"
    },
    "name": {
      "type": "string",
      "description": "Name of this hook.",
      "default": "hook"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this hook will be executed (true) or ignored (false).",
      "default": true
    },
    "script": {
      "type": "string",
      "description": "Code to be executed when this hook runs.",
      "default": "module.exports = function(client, scope, audience, context, cb) cb(null, access_token); };"
    },
    "dependencies": {
      "$ref": "#/components/schemas/HookDependencies"
    }
  }
}