Use the PUT /authenticationApi/settings endpoint to update the authentication API settings.

Status codes

Code Reason
200 Settings updated.
400 The request was improperly formatted or contained invalid fields.
403 PingFederate does not have its IdP role enabled. Operation not available.
422 Validation error(s) occurred.

AuthnApiSettings - Authentication API Application Settings.

Property Type Description
apiEnabled boolean Specifies whether the authentication API is enabled. The default value is false.
defaultApplicationRef ResourceLink Application for non authentication policy use cases.
enableApiDescriptions boolean Enable the API Descriptions endpoint.

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.