Auth0 · Schema

ConnectionGatewayAuthenticationSMS

Optional token-based authentication configuration for the SMS gateway

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
audience	object
method	object
secret	string	The secret used to sign the JSON Web Token sent to the SMS gateway
secret_base64_encoded	boolean	Set to true if the secret is base64-url-encoded
subject	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionGatewayAuthenticationSMS",
  "title": "ConnectionGatewayAuthenticationSMS",
  "type": [
    "object",
    "null"
  ],
  "description": "Optional token-based authentication configuration for the SMS gateway",
  "default": null,
  "required": [
    "audience",
    "method",
    "secret"
  ],
  "properties": {
    "audience": {
      "$ref": "#/components/schemas/ConnectionGatewayAuthenticationAudienceSMS"
    },
    "method": {
      "$ref": "#/components/schemas/ConnectionGatewayAuthenticationMethodSMS"
    },
    "secret": {
      "description": "The secret used to sign the JSON Web Token sent to the SMS gateway",
      "type": "string",
      "minLength": 1,
      "maxLength": 5120
    },
    "secret_base64_encoded": {
      "description": "Set to true if the secret is base64-url-encoded",
      "type": "boolean",
      "default": false
    },
    "subject": {
      "$ref": "#/components/schemas/ConnectionGatewayAuthenticationSubjectSMS"
    }
  },
  "additionalProperties": true,
  "x-release-lifecycle": "deprecated"
}