Skip to main content

REST APIs for 24.2.20 and 24.2.10

  • REST APIs for 24.2.20 and 24.2.10
  • PCE Management
  • Authentication Settings

Authentication Settings

This Public Experimental API gets or updates the authentication settings for the login domain (organization).

These new APIs with the included saml_configs setting provide customers an option to sign authN requests.

API Methods for Authentication Settings

HTTP

URI

Functionality

GET

[api_version]/authentication_settings

Get authentication settings

PUT

[api_version]/authentication_settings

Update authentication settings

GET

[api_version]/authentication_settings/ saml_configs

Gets all SAML configurations where any_org_owner is authorized to use it. The response now includes the PCE signing certificates that IdP will use for the SAML authN request signature validation.

GET

[api_version]/authentication_settings/ saml_configs/:uuid

Get the specified SAML configuration. The response now includes the PCE signing certificates that IdP will use for the SAML authN request signature validation.

PUT

[api_version]/authentication_settings/ saml_config/:uuid

Update the specified SAML configuration. API has been enhanced to enable/disable the signing of a SAML authN request.

POST

[api_version]/authentication_settings/ saml_configs/:uuid/pce_signing_cert

Generate a new certificate for signing SAML AuthN requests.

See also: