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
HTTP | URI | Functionality |
|---|---|---|
|
| Get authentication settings |
|
| Update authentication settings |
|
| Gets all SAML configurations where |
|
| Get the specified SAML configuration. The response now includes the PCE signing certificates that will be used by IdP for the SAML authN request signature validation. |
|
| Update the specified SAML configuration. API has been enhanced to enable/disable the signing of a SAML authN request. |
|
| Generate a new certificate for signing SAML AuthN requests. |
Get Authentication Settings
Curl Command to Get Authentication Settings
The org/:org_id/ path parameter is not specified in this command.
curl -i -X GET https://pce.my-company.com:8443/api/v2/authentication_settings -H "Accept: application/json" -u $KEY:$TOKEN
Example Default Response
200 OK
{ "authentication_type":"Local" }Update Authentication Settings
Curl Command to Update Authentication Settings
The org/:org_id/ path parameter is not specified in this command.
curl -i -X PUT https://pce.my-company.com:8443/api/v2/authentication_settings/password_policy -H "Content-Type: application/json" -d '{"authentication_settings": "SAML"}' u $KEY:$TOKEN Request Properties
Parameter | Description | Type | Required |
|---|---|---|---|
| Local authentication. | String | No |
| Authentication with SAML. | String | No |
Example Request Body
{"authentication_settings": "SAML"}