Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const authenticationProvider of client.authenticationProviders.list()) {
  console.log(authenticationProvider.id);
}

{
  "data": [
    {
      "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
      "record_type": "authentication_provider",
      "name": "Okta",
      "short_name": "myorg",
      "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
      "active": true,
      "settings": {
        "assertion_consumer_service_url": "https://api.telnyx.com/sso/saml/auth/myorg",
        "service_provider_entity_id": "https://api.telnyx.com/sso/saml/metadata/myorg",
        "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": "sha256",
        "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

authentication_providers

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const authenticationProvider of client.authenticationProviders.list()) {
  console.log(authenticationProvider.id);
}

{
  "data": [
    {
      "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
      "record_type": "authentication_provider",
      "name": "Okta",
      "short_name": "myorg",
      "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
      "active": true,
      "settings": {
        "assertion_consumer_service_url": "https://api.telnyx.com/sso/saml/auth/myorg",
        "service_provider_entity_id": "https://api.telnyx.com/sso/saml/metadata/myorg",
        "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": "sha256",
        "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort

enum<string>

default:-created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

name: sorts the result by the name field in ascending order.
-name: sorts the result by the name field in descending order.

If not given, results are sorted by created_at in descending order.

Available options:

name,

-name,

short_name,

-short_name,

active,

-active,

created_at,

-created_at,

updated_at,

-updated_at

Example:

"name"

page[number]

integer

page[size]

integer

Response

Successful response

data

AuthenticationProvider · object[]

Show child attributes

data.id

string<uuid>

Uniquely identifies the authentication provider.

Example:

"35146afd-df93-4963-b1e9-1a085e2ae874"

data.record_type

string

Identifies the type of the resource.

Example:

"authentication_provider"

data.name

string

The name associated with the authentication provider.

Example:

"Okta"

data.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.

Example:

"myorg"

data.organization_id

string<uuid>

The id from the Organization the authentication provider belongs to.

Example:

"24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7"

data.active

boolean

default:true

The active status of the authentication provider

Example:

true

data.settings

object

The settings associated with the authentication provider.

Show child attributes

data.settings.assertion_consumer_service_url

string<uri>

The Assertion Consumer Service URL for the service provider (Telnyx).

Example:

"https://api.telnyx.com/sso/saml/auth/myorg"

data.settings.service_provider_entity_id

string<uri>

The Entity ID for the service provider (Telnyx).

Example:

"https://api.telnyx.com/sso/saml/metadata/myorg"

data.settings.idp_entity_id

string<uri>

The Entity ID for the identity provider (IdP).

Example:

"https://myorg.myidp.com/saml/metadata"

data.settings.idp_sso_target_url

string<uri>

The SSO target url for the identity provider (IdP).

Example:

"https://myorg.myidp.com/trust/saml2/http-post/sso"

data.settings.idp_cert_fingerprint

string

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"

data.settings.idp_cert_fingerprint_algorithm

enum<string>

default:sha1

The algorithm used to generate the identity provider's (IdP) certificate fingerprint

Available options:

sha1,

sha256,

sha384,

sha512

Example:

"sha256"

data.settings.name_identifier_format

string

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"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all SSO authentication providers

Authorizations

Query Parameters

Response