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

Create a multi-admin-verify rule

Contributors
PDFs

POST /security/multi-admin-verify/rules

Introduced In: 9.11

Creates a multi-admin-verify rule.

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

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: 1

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

Response

Status: 201, Created
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

ONTAP Error Response Codes

Error Code Description

262148

The specified command is not recognized.

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.

262314

Some approval-groups were not found.

262316

Value must be in the range one second to two weeks.

262326

Failed to parse query.

262335

The query string must be contained in either the "operation" or "query" parameters but not in both.
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

approval_groups

Name Type Description

name

string

Name of the approval group.

href

Name Type Description

href

string

_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: 1

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

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