Update a multi-admin-verify request
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /security/multi-admin-verify/requests/{index}
Introduced In: 9.11
Updates a multi-admin-verify request.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
index |
string |
path |
True |
Request Body
Name | Type | Description |
---|---|---|
approve_expiry_time |
string |
|
approve_time |
string |
|
approved_users |
array[string] |
The users that have approved the request. |
comment |
string |
Optional user-provided comment that is sent to the approval-group email indicating why the request was made. |
create_time |
string |
|
execute_on_approval |
boolean |
Specifies that the operation is executed automatically on final approval. |
execution_expiry_time |
string |
|
index |
integer |
Unique index that represents a request. |
operation |
string |
The command to execute. |
owner |
The owner of the request. This can identify the cluster or an SVM. |
|
pending_approvers |
integer |
The number of approvers remaining that are required to approve. |
permitted_users |
array[string] |
List of users that can execute the operation once approved. If not set, any authorized user can perform the operation. |
potential_approvers |
array[string] |
The users that are able to approve the request. |
query |
string |
Identifies the specific entry upon which the user wants to operate. |
required_approvers |
integer |
The number of required approvers, excluding the user that made the request. |
state |
string |
The state of the request. PATCH supports approved and vetoed. The state only changes after setting to approved once no more approvers are required. |
user_requested |
string |
The user that created the request. Automatically set by ONTAP.
|
user_vetoed |
string |
The user that vetoed the request. |
Example request
{
"approve_expiry_time": "string",
"approve_time": "string",
"approved_users": [
"string"
],
"comment": "string",
"create_time": "string",
"execution_expiry_time": "string",
"index": 0,
"operation": "string",
"owner": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"pending_approvers": 0,
"permitted_users": [
"string"
],
"potential_approvers": [
"string"
],
"query": "string",
"required_approvers": 0,
"state": "string",
"user_requested": "string",
"user_vetoed": "string"
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
262309 |
The feature must be enabled first. |
262329 |
Invalid state. State can be modified to approved, vetoed, or executed. |
262337 |
User not eligible to approve the request. |
Also see the table of common errors in the Response body overview section of this documentation.
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
owner
The owner of the request. This can identify the cluster or an SVM.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
multi_admin_verify_request
Name | Type | Description |
---|---|---|
approve_expiry_time |
string |
|
approve_time |
string |
|
approved_users |
ar |