Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Authentication Providers API

The Authentication Providers API from Telnyx — 2 operation(s) for authentication providers.

Telnyx Authentication Providers API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication Providers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Authentication Providers API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication Providers 5
GET
/authentication_providers
List all SSO authentication providers
FindAuthenticationProviders 2 params → 200400401404
POST
/authentication_providers
Creates an authentication provider
CreateAuthenticationProvider body → 200422
DELETE
/authentication_providers/{id}
Deletes an authentication provider
DeleteAuthenticationProvider 1 param → 200401404422
GET
/authentication_providers/{id}
Retrieve an authentication provider
GetAuthenticationProvider 1 param → 200401404422
PATCH
/authentication_providers/{id}
Update an authentication provider
UpdateAuthenticationProvider 1 param body → 200401404422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AuthenticationProvider (10 properties), AuthenticationProviderCreate (5 properties), UpdateAuthenticationProviderRequest (5 properties), PaginationMeta (4 properties). Each schema is shown below with its type and property counts.

short_name
string
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.
active
boolean
The active status of the authentication provider
settings
object
The settings associated with the authentication provider.
4 properties 3 required
AuthenticationProviderCreate
object
5 properties 3 required
PaginationMeta
object
4 properties
organization_id
string
The id from the Organization the authentication provider belongs to.
AuthenticationProvider
object
10 properties
UpdateAuthenticationProviderRequest
object
5 properties
settings_url
string
The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead.
name
string
The name associated with the authentication provider.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-authentication-providers-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API
Telnyx Bucket Usage API