Auth0 · Schema

EmailProviderCredentialsSchema

Credentials required to use the provider.

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM
View JSON Schema on GitHub

JSON Schema

auth0-emailprovidercredentialsschema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EmailProviderCredentialsSchema",
  "title": "EmailProviderCredentialsSchema",
  "type": "object",
  "description": "Credentials required to use the provider.",
  "anyOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "api_key"
      ],
      "properties": {
        "api_key": {
          "type": "string",
          "description": "API Key",
          "minLength": 1
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "accessKeyId": {
          "type": "string",
          "description": "AWS Access Key ID.",
          "minLength": 1
        },
        "secretAccessKey": {
          "type": "string",
          "description": "AWS Secret Access Key.",
          "minLength": 1
        },
        "region": {
          "type": "string",
          "description": "AWS region.",
          "minLength": 1
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "smtp_host": {
          "$ref": "#/components/schemas/EmailSMTPHost"
        },
        "smtp_port": {
          "type": "integer",
          "description": "SMTP port."
        },
        "smtp_user": {
          "type": "string",
          "description": "SMTP username.",
          "minLength": 1
        },
        "smtp_pass": {
          "type": "string",
          "description": "SMTP password.",
          "minLength": 1
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "api_key": {
          "type": "string",
          "description": "API Key",
          "minLength": 1
        },
        "region": {
          "$ref": "#/components/schemas/EmailSparkPostRegionEnum"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "api_key": {
          "type": "string",
          "description": "API Key",
          "minLength": 1
        },
        "domain": {
          "type": "string",
          "description": "Domain",
          "minLength": 4
        },
        "region": {
          "$ref": "#/components/schemas/EmailMailgunRegionEnum"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "connectionString": {
          "type": "string",
          "description": "Azure Communication Services Connection String.",
          "minLength": 1
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "properties": {
        "tenantId": {
          "type": "string",
          "description": "Microsoft 365 Tenant ID.",
          "minLength": 1
        },
        "clientId": {
          "type": "string",
          "description": "Microsoft 365 Client ID.",
          "minLength": 1
        },
        "clientSecret": {
          "type": "string",
          "description": "Microsoft 365 Client Secret.",
          "minLength": 1
        }
      }
    },
    {
      "$ref": "#/components/schemas/ExtensibilityEmailProviderCredentials"
    }
  ]
}