Skip to main content
REST API reference

Update the OAuth 2.0 status

Updates the OAuth 2.0 status to adjust authentication configurations for your ONTAP environment. Use this endpoint when you need to modify OAuth 2.0 settings to align with security policies or compliance requirements.

HTTP method and endpoint

PATCH /security/authentication/cluster/oauth2

Introduced in

ONTAP 9.14

  • security oauth2 modify

Request Body

Name Type Description

enabled

boolean

Indicates whether OAuth 2.0 is enabled or disabled globally. Default value is false.

Response

Status: 200, Ok

Error

Status: Default,

Definitions

See Definitions

security_oauth2_global

Name Type Description

enabled

boolean

Indicates whether OAuth 2.0 is enabled or disabled globally. Default value is false.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.