Auth0 · Schema

IntegrationRequiredParam

Param are form input values, primarily utilized when specifying secrets and configuration values for actions. These are especially important for partner integrations -- but can be exposed to tenant admins as well if they want to parameterize their custom actions.

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
type	object
name	string	The name of the parameter.
required	boolean	The flag for if this parameter is required.
optional	boolean	The temp flag for if this parameter is required (experimental; for Labs use only).
label	string	The short label for this parameter.
description	string	The lengthier description for this parameter.
default_value	string	The default value for this parameter.
placeholder	string	Placeholder text for this parameter.
options	array	The allowable options for this param.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IntegrationRequiredParam",
  "title": "IntegrationRequiredParam",
  "type": "object",
  "description": "Param are form input values, primarily utilized when specifying secrets and\nconfiguration values for actions.\n\nThese are especially important for partner integrations -- but can be\nexposed to tenant admins as well if they want to parameterize their custom\nactions.",
  "additionalProperties": false,
  "properties": {
    "type": {
      "$ref": "#/components/schemas/IntegrationRequiredParamTypeEnum"
    },
    "name": {
      "type": "string",
      "description": "The name of the parameter."
    },
    "required": {
      "type": "boolean",
      "description": "The flag for if this parameter is required."
    },
    "optional": {
      "type": "boolean",
      "description": "The temp flag for if this parameter is required (experimental; for Labs use only)."
    },
    "label": {
      "type": "string",
      "description": "The short label for this parameter."
    },
    "description": {
      "type": "string",
      "description": "The lengthier description for this parameter."
    },
    "default_value": {
      "type": "string",
      "description": "The default value for this parameter."
    },
    "placeholder": {
      "type": "string",
      "description": "Placeholder text for this parameter."
    },
    "options": {
      "type": "array",
      "description": "The allowable options for this param.",
      "items": {
        "$ref": "#/components/schemas/IntegrationRequiredParamOption"
      }
    }
  }
}