Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Authentication Providers

Creates an authentication provider

Creates an authentication provider.

post/authentication_providers

Request body

activeboolean

The active status of the authentication provider

namestring required

The name associated with the authentication provider.

settings_urlstring uri

The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead.

short_namestring required

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.

Example request

{
  "active": true,
  "name": "Okta",
  "settings": {
    "idp_cert_fingerprint": "13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7",
    "idp_cert_fingerprint_algorithm": "sha256",
    "idp_entity_id": "https://myorg.myidp.com/saml/metadata",
    "idp_sso_target_url": "https://myorg.myidp.com/trust/saml2/http-post/sso"
  },
  "settings_url": "https://myorg.myidp.com/saml/metadata",
  "short_name": "myorg"
}

Response

Successful response

Example response

{
  "data": {
    "activated_at": "2018-02-02T22:25:27.521Z",
    "active": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
    "name": "Okta",
    "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
    "record_type": "authentication_provider",
    "settings": {
      "assertion_consumer_service_url": "https://api.telnyx.com/sso/saml/auth/myorg",
      "idp_attribute_names": {
        "email": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
      },
      "idp_cert_fingerprint": "13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7",
      "idp_cert_fingerprint_algorithm": "sha256",
      "idp_certificate": "-----BEGIN CERTIFICATE-----\nMIIC...\n-----END CERTIFICATE-----",
      "idp_entity_id": "https://myorg.myidp.com/saml/metadata",
      "idp_slo_target_url": "https://myorg.myidp.com/trust/saml2/http-redirect/slo",
      "idp_sso_target_url": "https://myorg.myidp.com/trust/saml2/http-post/sso",
      "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format",
      "service_provider_entity_id": "https://api.telnyx.com/sso/saml/metadata/myorg",
      "service_provider_login_url": "https://api.telnyx.com/sso/myorg"
    },
    "short_name": "myorg",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}