Skip to main content

Creates an authentication provider

POST 

/authentication_providers

Creates an authentication provider.

Request

Body

required

Parameters that can be defined during authentication provider creation

    name namerequired

    The name associated with the authentication provider.

    short_name short_namerequired

    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

    Default value: true

    The active status of the authentication provider

    settings

    object

    required

    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

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

Responses

200: Successful response

Schema

    data

    object

    id uuid

    Uniquely identifies the authentication provider.

    record_type string

    Identifies the type of the resource.

    name name

    The name associated with the authentication provider.

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

    organization_id uuid

    The id from the Organization the authentication provider belongs to.

    active active

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

    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.

422: Bad request

Loading...