AuthenticationProviderCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-authentication-provider-create-schema.json",
  "title": "AuthenticationProviderCreate",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-authentication-providers-api-openapi.yml#/components/schemas/AuthenticationProviderCreate",
  "properties": {
    "active": {
      "$ref": "#/$defs/active"
    },
    "name": {
      "$ref": "#/$defs/name"
    },
    "settings": {
      "$ref": "#/$defs/settings"
    },
    "settings_url": {
      "$ref": "#/$defs/settings_url"
    },
    "short_name": {
      "$ref": "#/$defs/short_name"
    }
  },
  "required": [
    "name",
    "short_name",
    "settings"
  ],
  "type": "object",
  "$defs": {
    "active": {
      "default": true,
      "description": "The active status of the authentication provider",
      "type": "boolean"
    },
    "name": {
      "description": "The name associated with the authentication provider.",
      "type": "string"
    },
    "settings": {
      "description": "The settings associated with the authentication provider.",
      "properties": {
        "idp_cert_fingerprint": {
          "description": "The certificate fingerprint for the identity provider (IdP)",
          "type": "string"
        },
        "idp_cert_fingerprint_algorithm": {
          "default": "sha1",
          "description": "The algorithm used to generate the identity provider's (IdP) certificate fingerprint",
          "enum": [
            "sha1",
            "sha256",
            "sha384",
            "sha512"
          ],
          "type": "string"
        },
        "idp_entity_id": {
          "description": "The Entity ID for the identity provider (IdP).",
          "format": "uri",
          "type": "string"
        },
        "idp_sso_target_url": {
          "description": "The SSO target url for the identity provider (IdP).",
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "idp_entity_id",
        "idp_sso_target_url",
        "idp_cert_fingerprint"
      ],
      "type": "object"
    },
    "settings_url": {
      "description": "The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead.",
      "format": "uri",
      "type": "string"
    },
    "short_name": {
      "description": "The short name associated with the authentication provider. This must be unique and URL-friendly, as it's going to be part of the login URL.",
      "type": "string"
    }
  }
}