Skip to main content

REST API Developer Guide 21.5

Authentication Settings

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

API Methods

Functionality

HTTP

URI

Get authentication settings

GET

[api_version]/authentication_settings

Update authentication settings

PUT

[api_version]/authentication_settings

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

Local authentication.

String

No

SAML

Authentication with SAML.

String

No

Example Request Body

{"authentication_settings": "SAML"}