Skip to main content

Update the OAuth 2.0 status

Contributors
PDFs

PATCH /security/authentication/cluster/oauth2

Introduced In: 9.14

Updates the OAuth 2.0 status.

  • 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,
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

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.