Auth0 · Schema

UpdateHookRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
name	string	Name of this hook.
script	string	Code to be executed when this hook runs.
enabled	boolean	Whether this hook will be executed (true) or ignored (false).
dependencies	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateHookRequestContent",
  "title": "UpdateHookRequestContent",
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of this hook.",
      "default": "my-hook",
      "pattern": "^[a-zA-Z0-9]([ \\-a-zA-Z0-9]*[a-zA-Z0-9])?$"
    },
    "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); };",
      "minLength": 1
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this hook will be executed (true) or ignored (false).",
      "default": false
    },
    "dependencies": {
      "$ref": "#/components/schemas/HookDependencies"
    }
  }
}