List all SSO authentication providers

gethttps://api.telnyx.com/v2/authentication_providers

Returns a list of your SSO authentication providers.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/authentication_providers?page[number]=1&page[size]=20"

Parameters

In Query
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20
sort
string
optional
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.
Default:
"-created_at"
Example: "name"Options: [ "name", "-name", "short_name", "-short_name", "active", "-active", "created_at", "-created_at", "updated_at", "-updated_at" ]

Responses

200
Successful response
400
Bad request
401
Unauthorized
404
Resource not found

Success Response

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

...

posthttps://api.telnyx.com/v2/authentication_providers

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/authentication_providers/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/authentication_providers/{id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/authentication_providers/{id}

...

...

Parameters

Responses

Success Response

Previous:
Account
Next:
Billing
Was this page helpful?