Skip to main content

Update a authentication provider

PATCH 
/authentication_providers/:id

Updates settings of an existing authentication provider.

Request ​

Path Parameters

    id stringrequired

    Identifies the resource.

Body

    name name (string)

    The name associated with the authentication provider.

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

    active active (boolean)

    Default value: true

    The active status of the authentication provider

    settings

    object

    The settings associated with the authentication provider.

    idp_entity_id stringrequired

    The Entity ID for the identity provider (IdP).

    idp_sso_target_url stringrequired

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

    idp_cert_fingerprint stringrequired

    The certificate fingerprint for the identity provider (IdP)

    idp_cert_fingerprint_algorithm string

    Possible values: [sha1, sha256, sha384, sha512]

    Default value: sha1

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

    The settings associated with the authentication provider.

    settings_url settings_url (string)

    The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead.

Responses ​

200: Successful response

Response Headers

    Schema

      data

      object

      id uuid

      Uniquely identifies the authentication provider.

      record_type string

      Identifies the type of the resource.

      name name (string)

      The name associated with the authentication provider.

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

      organization_id uuid

      The id from the Organization the authentication provider belongs to.

      active active (boolean)

      Default value: true

      The active status of the authentication provider

      settings

      object

      The settings associated with the authentication provider.

      assertion_consumer_service_url string

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

      service_provider_entity_id string

      The Entity ID for the service provider (Telnyx).

      idp_entity_id string

      The Entity ID for the identity provider (IdP).

      idp_sso_target_url string

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

      idp_cert_fingerprint string

      The certificate fingerprint for the identity provider (IdP)

      idp_cert_fingerprint_algorithm string

      Possible values: [sha1, sha256, sha384, sha512]

      Default value: sha1

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

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

      The settings associated with the authentication provider.

      created_at string

      ISO 8601 formatted date indicating when the resource was created.

      updated_at string

      ISO 8601 formatted date indicating when the resource was updated.

    401: Unauthorized

    Response Headers

      Schema

        object

      404: Resource not found

      Response Headers

        Schema

          object

        422: Bad request

        Response Headers

          Schema

            object

          Request samples

          curl -L -X PATCH 'https://api.telnyx.com/v2/authentication_providers/:id' \
          -H 'Content-Type: application/json' \
          -H 'Accept: application/json' \
          -H 'Authorization: Bearer <TOKEN>' \
          -d '{
            "name": "Okta",
            "short_name": "myorg",
            "active": true,
            "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"
            }
          }'

          Response samples

          {
            "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"
              ]
            }
          }