Skip to main content

Retrieve a multi-admin-verify approval group

Contributors
PDFs

GET /security/multi-admin-verify/approval-groups/{owner.uuid}/{name}

Introduced In: 9.11

Retrieves a multi-admin-verify approval group.

Parameters

Name Type In Required Description

owner.uuid

string

path

True

name

string

path

True

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

approvers

array[string]

List of users that can approve a request.

email

array[string]

Email addresses that are notified when a request is created, approved, vetoed, or executed.

name

string

Name of the approval group.

owner

owner

The owner of the approval group. The only valid owner is currently the cluster.
Example response 
{
  "approvers": [
    "string"
  ],
  "email": [
    "string"
  ],
  "name": "string",
  "owner": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error
Name Type Description

error

returned_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 approval group. The only valid owner is currently the cluster.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a POST or PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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