Returns a list of your SSO authentication providers.
Successful response
Array of objects (AuthenticationProvider) | |
object (PaginationMeta) |
Bad request
Unauthorized
Resource not found
const telnyx = require('telnyx')('YOUR_API_KEY'); const {data: authenticationProviders} = await telnyx.authenticationProviders.list();
{- "data": [
- {
- "active": true,
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
- "name": {
- "first_name": "John",
- "formatted_name": "John Smith",
- "last_name": "Smith"
}, - "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
- "record_type": "authentication_provider",
- "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",
- "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format",
}, - "short_name": "myorg",
- "updated_at": "2018-02-02T22:25:27.521Z"
}
], - "meta": {
- "page_number": 2,
- "page_size": 25,
- "total_pages": 3,
- "total_results": 55
}
}
Creates an authentication provider.
Parameters that can be defined during authentication provider creation
Successful response
Bad request
{- "active": true,
- "name": {
- "first_name": "John",
- "formatted_name": "John Smith",
- "last_name": "Smith"
}, - "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",
}, - "short_name": "myorg"
}
{- "data": {
- "active": true,
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
- "name": {
- "first_name": "John",
- "formatted_name": "John Smith",
- "last_name": "Smith"
}, - "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
- "record_type": "authentication_provider",
- "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",
- "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format",
}, - "short_name": "myorg",
- "updated_at": "2018-02-02T22:25:27.521Z"
}
}
Deletes an existing authentication provider.
Successful response
object (AuthenticationProvider) | |||||||||||||||||||
|
Unauthorized
Resource not found
Bad request
const telnyx = require('telnyx')('YOUR_API_KEY'); await telnyx.authenticationProviders.del('123');
{- "data": {
- "active": true,
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
- "name": {
- "first_name": "John",
- "formatted_name": "John Smith",
- "last_name": "Smith"
}, - "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
- "record_type": "authentication_provider",
- "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",
- "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format",
}, - "short_name": "myorg",
- "updated_at": "2018-02-02T22:25:27.521Z"
}
}
Retrieves the details of an existing authentication provider.
Successful response
object (AuthenticationProvider) | |||||||||||||||||||
|
Unauthorized
Resource not found
Bad request
const telnyx = require('telnyx')('YOUR_API_KEY'); const {data: authenticationProvider} = await telnyx.authenticationProviders.retrieve('123');
{- "data": {
- "active": true,
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
- "name": {
- "first_name": "John",
- "formatted_name": "John Smith",
- "last_name": "Smith"
}, - "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
- "record_type": "authentication_provider",
- "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",
- "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format",
}, - "short_name": "myorg",
- "updated_at": "2018-02-02T22:25:27.521Z"
}
}
Updates settings of an existing authentication provider.
Parameters that can be updated in a authentication provider
active | boolean (active) The active status of the authentication provider |
object (name) Full contact name | |
object (settings) The settings associated with the authentication provider. | |
settings_url | string (settings_url) 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_name | string (short_name) 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. |
Successful response
object (AuthenticationProvider) | |||||||||||||||||||
|
Unauthorized
Resource not found
Bad 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": "sha1",
}, - "short_name": "myorg"
}
{- "data": {
- "active": true,
- "created_at": "2018-02-02T22:25:27.521Z",
- "id": "35146afd-df93-4963-b1e9-1a085e2ae874",
- "name": {
- "first_name": "John",
- "formatted_name": "John Smith",
- "last_name": "Smith"
}, - "organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
- "record_type": "authentication_provider",
- "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",
- "name_identifier_format": "urn:oasis:names:tc:SAML:1.1:nameid-format",
}, - "short_name": "myorg",
- "updated_at": "2018-02-02T22:25:27.521Z"
}
}