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

Retrieve multi-admin-verify rules

Contributors
PDFs

GET /security/multi-admin-verify/rules

Introduced In: 9.11

Retrieves multi-admin-verify rules.

Parameters

Name Type In Required Description

system_defined

boolean

query

False

Filter by system_defined

query

string

query

False

Filter by query

approval_groups.name

string

query

False

Filter by approval_groups.name

approval_expiry

string

query

False

Filter by approval_expiry

required_approvers

integer

query

False

Filter by required_approvers

execution_expiry

string

query

False

Filter by execution_expiry

operation

string

query

False

Filter by operation

create_time

string

query

False

Filter by create_time

auto_request_create

boolean

query

False

Filter by auto_request_create

owner.uuid

string

query

False

Filter by owner.uuid

owner.name

string

query

False

Filter by owner.name

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_rule]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "approval_groups": {
    },
    "create_time": "string",
    "owner": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  }
}

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

approval_groups

Name Type Description

name

string

Name of the approval group.

_links

Name Type Description

self

href

owner

The owner of the rule. The only valid owner is currently the cluster.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

multi_admin_verify_rule

Name Type Description

approval_expiry

string

Time for requests to be approved, in ISO-8601 duration format. If not set, the global setting is used.

approval_groups

array[approval_groups]

List of approval groups that are allowed to approve requests for rules that don't have approval groups.

auto_request_create

boolean

When true, ONTAP automatically creates a request for any failed operation where there is no matching pending request.

  • Default value:

  • Introduced in: 9.11

create_time

string

execution_expiry

string

Time for requests to be executed once approved, in ISO-8601 duration format. If not set, the global setting is used.

operation

string

Command that requires one or more approvals.

owner

owner

The owner of the rule. The only valid owner is currently the cluster.

query

string

When specified, this property limits the entries that require approvals to those that match the specified query.

required_approvers

integer

The number of required approvers, excluding the user that made the request.

system_defined

boolean

Specifies whether the rule is system-defined or user-defined.

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.