Skip to main content
A newer release of this product is available.

Create a multi-admin-verify request

Contributors
PDFs

POST /security/multi-admin-verify/requests

Introduced In: 9.11

Creates a multi-admin-verify request.

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

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

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.

  • readOnly: 1

  • Introduced in: 9.11

  • x-nullable: true

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: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[multi_admin_verify_request]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "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"
    }
  ]
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

262148

The specified command is not recognized.

262304

Too many requests. Delete one before creating another.

262305

Can't approve non-pending request.

262306

Can't veto an expired request.

262308

The specified command is not supported by this feature.

262309

The feature must be enabled first.

262311

Value must be greater than zero.

262312

Number of required approvers must be less than the total number of unique approvers in the approval-groups.

262313

Number of unique approvers in the approval-groups must be greater than the number of required approvers.

262326

Failed to parse query.

262327

Failed to crate the request.

262328

There is no matching rule for this request.

262330

Cannot approve/veto a request multiple times.

262334

The parameter specified in the command is not supported.

262337

Cannot approve/veto the user's own request.
Name Type Description

error

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

href

owner

The owner of the request. This can identify the cluster or an SVM.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

multi_admin_verify_request

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

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.

  • readOnly: 1

  • Introduced in: 9.11

  • x-nullable: true

user_vetoed

string

The user that vetoed the request.

_links

Name Type Description

next

href

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.