Skip to main content

Retrieve the OAuth 2.0 status

Contributors
PDFs

GET /security/authentication/cluster/oauth2

Introduced In: 9.14

Retrieves the OAuth 2.0 status.

  • security oauth2 show

Parameters

Name Type In Required Description

enabled

boolean

query

False

Filter by enabled

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

enabled

boolean

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

Error

Status: Default, Error
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

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.