REST API reference
The requested article is not available. Either it doesn't apply to this version of the product or the relevant information is organized differently in this version of the docs. You can search, browse, or go back to the other version.
Retrieve the OAuth 2.0 status
Contributors
Suggest changes
-
PDF of this doc site
Collection of separate PDF docs
Creating your file...
This may take a few minutes. Thanks for your patience.
Your file is ready
GET /security/authentication/cluster/oauth2
Introduced In: 9.14
Retrieves the OAuth 2.0 status.
Related ONTAP commands
-
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 |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}JSON
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. |
