Skip to main content

REST APIs for 24.2.20 and 24.2.10

Authentication Settings Reference

This topic covers examples of authentication settings.

Examples
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"}