Skip to main content
PATCH
/
authentication_providers
/
{id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const authenticationProvider = await client.authenticationProviders.update('id', {
  active: true,
  name: 'Okta',
  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',
  },
  short_name: 'myorg',
});

console.log(authenticationProvider.data);
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Identifies the resource.

Body

application/json
​
name
string

The name associated with the authentication provider.

Example:

"Okta"

​
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"

​
active
boolean
default:true

The active status of the authentication provider

Example:

true

​
settings
object

The settings associated with the authentication provider.

​
settings_url
string<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.

Example:

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

Response

Successful response

​
data
AuthenticationProvider · object