Telnyx Authentication Providers API

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

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 5

GET /authentication_providers List all SSO authentication providers #
POST /authentication_providers Creates an authentication provider #
DELETE /authentication_providers/{id} Deletes an authentication provider #
GET /authentication_providers/{id} Retrieve an authentication provider #
PATCH /authentication_providers/{id} Update an authentication provider #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-authentication-providers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-authentication-providers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Telnyx Authentication Providers API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Authentication Providers across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Authentication Providers
paths:
  /authentication_providers:
    get:
      summary: List all SSO authentication providers
      deprecated: false
      description: Returns a list of your SSO authentication providers.
      operationId: FindAuthenticationProviders
      tags:
      - Authentication Providers
      parameters:
      - name: sort
        in: query
        description: "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code>-</code> prefix.<br/><br/>\nThat is: <ul>\n  <li>\n    <code>name</code>: sorts the result by the\n    <code>name</code> field in ascending order.\n  </li>\n  <li>\n    <code>-name</code>: sorts the result by the\n    <code>name</code> field in descending order.\n  </li>\n</ul><br/>If not given, results are sorted by <code>created_at</code> in descending order."
        required: false
        schema:
          type: string
          enum:
          - name
          - -name
          - short_name
          - -short_name
          - active
          - -active
          - created_at
          - -created_at
          - updated_at
          - -updated_at
          default: -created_at
          example: name
      - name: page
        in: query
        style: deepObject
        explode: true
        description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
        schema:
          type: object
          properties:
            number:
              type: integer
              minimum: 1
              default: 1
              description: The page number to load
            size:
              type: integer
              minimum: 1
              maximum: 250
              default: 20
              description: The size of the page
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuthenticationProvider'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
    post:
      summary: Creates an authentication provider
      deprecated: false
      description: Creates a new authentication provider for single sign-on, configured from the provided identity provider details, and returns the created resource.
      operationId: CreateAuthenticationProvider
      tags:
      - Authentication Providers
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationProviderCreate'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AuthenticationProvider'
        '422':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /authentication_providers/{id}:
    delete:
      summary: Deletes an authentication provider
      deprecated: false
      description: Deletes an existing authentication provider.
      operationId: DeleteAuthenticationProvider
      tags:
      - Authentication Providers
      parameters:
      - name: id
        in: path
        description: authentication provider ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AuthenticationProvider'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '422':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
    get:
      summary: Retrieve an authentication provider
      deprecated: false
      description: Retrieves the details of an existing authentication provider.
      operationId: GetAuthenticationProvider
      tags:
      - Authentication Providers
      parameters:
      - name: id
        in: path
        description: authentication provider ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AuthenticationProvider'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '422':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
    patch:
      summary: Update an authentication provider
      deprecated: false
      description: Updates settings of an existing authentication provider.
      operationId: UpdateAuthenticationProvider
      tags:
      - Authentication Providers
      parameters:
      - name: id
        in: path
        description: Identifies the resource.
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAuthenticationProviderRequest'
            example:
              name: Okta
              short_name: myorg
              active: true
              settings:
                idp_entity_id: https://myorg.myidp.com/saml/metadata
                idp_sso_target_url: https://myorg.myidp.com/trust/saml2/http-post/sso
                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: sha1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AuthenticationProvider'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '422':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties: {}
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    settings:
      type: object
      description: The settings associated with the authentication provider.
      required:
      - idp_entity_id
      - idp_sso_target_url
      - idp_cert_fingerprint
      properties:
        idp_entity_id:
          type: string
          description: The Entity ID for the identity provider (IdP).
          format: uri
          example: https://myorg.myidp.com/saml/metadata
        idp_sso_target_url:
          type: string
          description: The SSO target url for the identity provider (IdP).
          format: uri
          example: https://myorg.myidp.com/trust/saml2/http-post/sso
        idp_cert_fingerprint:
          type: string
          description: The certificate fingerprint for the identity provider (IdP)
          example: 13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7
        idp_cert_fingerprint_algorithm:
          type: string
          description: The algorithm used to generate the identity provider's (IdP) certificate fingerprint
          enum:
          - sha1
          - sha256
          - sha384
          - sha512
          default: sha1
          example: sha256
    UpdateAuthenticationProviderRequest:
      type: object
      title: Update Authentication Provider Request
      properties:
        name:
          $ref: '#/components/schemas/name'
        short_name:
          $ref: '#/components/schemas/short_name'
        active:
          $ref: '#/components/schemas/active'
        settings:
          $ref: '#/components/schemas/settings'
        settings_url:
          $ref: '#/components/schemas/settings_url'
      example:
        name: Okta
        short_name: myorg
        active: true
        settings:
          idp_entity_id: https://myorg.myidp.com/saml/metadata
          idp_sso_target_url: https://myorg.myidp.com/trust/saml2/http-post/sso
          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: sha1
    AuthenticationProviderCreate:
      type: object
      required:
      - name
      - short_name
      - settings
      properties:
        name:
          $ref: '#/components/schemas/name'
        short_name:
          $ref: '#/components/schemas/short_name'
        active:
          $ref: '#/components/schemas/active'
        settings:
          $ref: '#/components/schemas/settings'
        settings_url:
          $ref: '#/components/schemas/settings_url'
    name:
      type: string
      description: The name associated with the authentication provider.
      example: Okta
    short_name:
      type: string
      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.
      example: myorg
    organization_id:
      type: string
      format: uuid
      description: The id from the Organization the authentication provider belongs to.
      example: 24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7
    settings_url:
      type: string
      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
      example: https://myorg.myidp.com/saml/metadata
    PaginationMeta:
      type: object
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    AuthenticationProvider:
      type: object
      title: AuthenticationProvider
      properties:
        id:
          type: string
          format: uuid
          description: Uniquely identifies the authentication provider.
          example: 35146afd-df93-4963-b1e9-1a085e2ae874
        record_type:
          type: string
          description: Identifies the type of the resource.
          example: authentication_provider
        name:
          $ref: '#/components/schemas/name'
        short_name:
          $ref: '#/components/schemas/short_name'
        organization_id:
          $ref: '#/components/schemas/organization_id'
        active:
          $ref: '#/components/schemas/active'
        activated_at:
          type: string
          description: ISO 8601 formatted date indicating when the authentication provider was activated.
          format: date-time
          example: '2018-02-02T22:25:27.521Z'
        settings:
          type: object
          description: The settings associated with the authentication provider.
          properties:
            assertion_consumer_service_url:
              type: string
              description: The Assertion Consumer Service URL for the service provider (Telnyx).
              format: uri
              example: https://api.telnyx.com/sso/saml/auth/myorg
            service_provider_entity_id:
              type: string
              description: The Entity ID for the service provider (Telnyx).
              format: uri
              example: https://api.telnyx.com/sso/saml/metadata/myorg
            service_provider_login_url:
              type: string
              description: The login URL for the service provider (Telnyx). Users navigate to this URL to initiate SSO login.
              format: uri
              example: https://api.telnyx.com/sso/myorg
            idp_entity_id:
              type: string
              description: The Entity ID for the identity provider (IdP).
              format: uri
              example: https://myorg.myidp.com/saml/metadata
            idp_sso_target_url:
              type: string
              description: The SSO target url for the identity provider (IdP).
              format: uri
              example: https://myorg.myidp.com/trust/saml2/http-post/sso
            idp_cert_fingerprint:
              type: string
              description: The certificate fingerprint for the identity provider (IdP)
              example: 13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7
            idp_cert_fingerprint_algorithm:
              type: string
              description: The algorithm used to generate the identity provider's (IdP) certificate fingerprint
              enum:
              - sha1
              - sha256
              - sha384
              - sha512
              default: sha1
              example: sha256
            name_identifier_format:
              type: string
              description: The name identifier format associated with the authentication provider. This must be the same for both the Identity Provider (IdP) and the service provider (Telnyx).
              example: urn:oasis:names:tc:SAML:1.1:nameid-format
            idp_slo_target_url:
              type: string
              description: The Single Logout (SLO) target URL for the identity provider (IdP).
              format: uri
              example: https://myorg.myidp.com/trust/saml2/http-redirect/slo
            idp_certificate:
              type: string
              description: The full X.509 certificate for the identity provider (IdP).
              example: '-----BEGIN CERTIFICATE-----

                MIIC...

                -----END CERTIFICATE-----'
            idp_attribute_names:
              type: object
              description: Mapping of SAML attribute names used by the identity provider (IdP).
              example:
                email: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
            provision_groups:
              type: boolean
              description: Whether group provisioning is enabled for this authentication provider.
              example: false
        created_at:
          type: string
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          example: '2018-02-02T22:25:27.521Z'
        updated_at:
          type: string
          description: ISO 8601 formatted date indicating when the resource was updated.
          format: date-time
          example: '2018-02-02T22:25:27.521Z'
    active:
      type: boolean
      description: The active status of the authentication provider
      default: true
      example: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt