Authentication Providers

Authentication Provider operations

List all SSO authentication providers

Returns a list of your SSO authentication providers.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

sort
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.
Enum: "name" "-name" "short_name" "-short_name" "active" "-active" "created_at" "-created_at" "updated_at" "-updated_at"
Example: sort=name
Responses
200

Successful response

Response Schema: application/json
Array of objects (AuthenticationProvider)
object (PaginationMeta)
400

Bad request

401

Unauthorized

404

Resource not found

get/authentication_providers
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

const {data: authenticationProviders} = await telnyx.authenticationProviders.list();
Response samples
application/json
{
  • "data": [],
  • "meta": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}

Creates an authentication provider

Creates an authentication provider.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Parameters that can be defined during authentication provider creation

active
boolean (active)
Default: true

The active status of the authentication provider

required
object (Name)

Full contact name

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

Responses
200

Successful response

Response Schema: application/json
object (AuthenticationProvider)
active
boolean (active)
Default: true

The active status of the authentication provider

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid>

Uniquely identifies the authentication provider.

object (Name)

Full contact name

organization_id
string <uuid> (organization_id)

The id from the Organization the authentication provider belongs to.

record_type
string

Identifies the type of the resource.

object

The settings associated with the authentication provider.

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.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

422

Bad request

post/authentication_providers
Request samples
application/json
{}
Response samples
application/json
{}

Deletes an authentication provider

Deletes an existing authentication provider.

SecuritybearerAuth
Request
path Parameters
id
required
string

authentication provider ID

Responses
200

Successful response

Response Schema: application/json
object (AuthenticationProvider)
active
boolean (active)
Default: true

The active status of the authentication provider

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid>

Uniquely identifies the authentication provider.

object (Name)

Full contact name

organization_id
string <uuid> (organization_id)

The id from the Organization the authentication provider belongs to.

record_type
string

Identifies the type of the resource.

object

The settings associated with the authentication provider.

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.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

401

Unauthorized

404

Resource not found

422

Bad request

delete/authentication_providers/{id}
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

await telnyx.authenticationProviders.del('123');
Response samples
application/json
{}

Retrieve an authentication provider

Retrieves the details of an existing authentication provider.

SecuritybearerAuth
Request
path Parameters
id
required
string

authentication provider ID

Responses
200

Successful response

Response Schema: application/json
object (AuthenticationProvider)
active
boolean (active)
Default: true

The active status of the authentication provider

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid>

Uniquely identifies the authentication provider.

object (Name)

Full contact name

organization_id
string <uuid> (organization_id)

The id from the Organization the authentication provider belongs to.

record_type
string

Identifies the type of the resource.

object

The settings associated with the authentication provider.

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.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

401

Unauthorized

404

Resource not found

422

Bad request

get/authentication_providers/{id}
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

const {data: authenticationProvider} = await telnyx.authenticationProviders.retrieve('123');
Response samples
application/json
{}

Update a authentication provider

Updates settings of an existing authentication provider.

SecuritybearerAuth
Request
path Parameters
id
required
string

Identifies the resource.

Request Body schema: application/json
required

Parameters that can be updated in a authentication provider

active
boolean (active)
Default: true

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.

Responses
200

Successful response

Response Schema: application/json
object (AuthenticationProvider)
active
boolean (active)
Default: true

The active status of the authentication provider

created_at
string

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid>

Uniquely identifies the authentication provider.

object (Name)

Full contact name

organization_id
string <uuid> (organization_id)

The id from the Organization the authentication provider belongs to.

record_type
string

Identifies the type of the resource.

object

The settings associated with the authentication provider.

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.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

401

Unauthorized

404

Resource not found

422

Bad request

patch/authentication_providers/{id}
Request samples
application/json
{}
Response samples
application/json
{}