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

Retrieve multi-admin-verify requests

Contributors
PDFs

GET /security/multi-admin-verify/requests

Introduced In: 9.11

Retrieves multi-admin-verify requests.

Parameters

Name Type In Required Description

permitted_users

string

query

False

Filter by permitted_users

user_requested

string

query

False

Filter by user_requested

operation

string

query

False

Filter by operation

user_vetoed

string

query

False

Filter by user_vetoed

execution_expiry_time

string

query

False

Filter by execution_expiry_time

approve_time

string

query

False

Filter by approve_time

execute_on_approval

boolean

query

False

Filter by execute_on_approval

  • Introduced in: 9.13

create_time

string

query

False

Filter by create_time

state

string

query

False

Filter by state

approve_expiry_time

string

query

False

Filter by approve_expiry_time

query

string

query

False

Filter by query

required_approvers

integer

query

False

Filter by required_approvers

potential_approvers

string

query

False

Filter by potential_approvers

index

integer

query

False

Filter by index

pending_approvers

integer

query

False

Filter by pending_approvers

comment

string

query

False

Filter by comment

owner.uuid

string

query

False

Filter by owner.uuid

owner.name

string

query

False

Filter by owner.name

approved_users

string

query

False

Filter by approved_users

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
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": {
    },
    "comment": "string",
    "create_time": "string",
    "execution_expiry_time": "string",
    "index": 0,
    "owner": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "pending_approvers": 0,
    "permitted_users": {
    },
    "potential_approvers": {
    },
    "required_approvers": 0,
    "state": "pending",
    "user_requested": "string",
    "user_vetoed": "string"
  }
}

Error

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

next

href

self

href

_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.

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.