Skip to main content

Security authentication cluster oauth2 endpoint overview

Contributors
PDFs

Overview

This API is used to enable and disable OAuth 2.0 in the cluster. The PATCH request enables and disables OAuth 2.0 in the cluster.

Examples

Retrieving the OAuth 2.0 status in the cluster

The following output shows the OAuth 2.0 status of the cluster. 

# The API:
/api/security/authentication/cluster/oauth2

# The call:
curl -X GET "https://<mgmt-ip>/api/security/authentication/cluster/oauth2" -H "accept: application/hal+json"

# The response:
{
"enabled": false
}

Enabling the OAuth 2.0 in the cluster

The following output shows how to enable the OAuth 2.0 in the cluster. 

# The API:
/api/security/authentication/cluster/oauth2

# The call:
curl -X PATCH "https://<mgmt-ip>/api/security/authentication/cluster/oauth2" -H "accept: application/hal+json" -d '{ "enabled": true }'