Skip to main content
PATCH
Modify SAML configuration

Authorizations

Authorization
string
header
required

This API uses OAuth2 with the implicit grant flow. Learn about the implicit grant flow.

Body

application/json
entrypoint
string

The entrypoint URL of the identity provider; SSO redirects the AuthnRequest there.

certificate
string

The SAML certificate configured on the IDP side in PEM format.

idp_entity_id
string

The entity ID of the external identity provider; usually a URL.

sp_entity_id
string

The entity ID of Text Accounts; it has a default value that can be changed.

active
boolean

If true: the SAML configuration is enabled.

Response

OK: SAML configuration was modified.

The organization's SAML configuration.

entrypoint
string

The entrypoint URL of the identity provider; SSO redirects the AuthnRequest there.

certificate
string

The SAML certificate configured on the IDP side in PEM format.

idp_entity_id
string

The entity ID of the external identity provider; usually a URL.

sp_entity_id
string

The entity ID of Text Accounts; it has a default value that can be changed.

active
boolean

If true: the SAML configuration is enabled.

version
integer

The version of the SAML configuration; currently either 1 or 2.