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

Add a privilege tuple to an existing role

PDFs

POST /security/roles/{owner.uuid}/{name}/privileges

Add a privilege tuple (of REST URI and its access level) to an existing role.

Required parameters

  • owner.uuid - UUID of the SVM that houses this role.

  • name - Name of the role to be updated.

  • path - REST URI path (example: "/api/storage/volumes").

  • access - Desired access level for the REST URI path (one of "all", "readonly" or "none").

Optional parameters

none

  • security login rest-role create

Learn more

Parameters

Name Type In Required Description

owner.uuid

string

path

True

Owner UUID of the role.

name

string

path

True

Role name

Request Body

Name Type Description

_links

_links

access

string

Access level for the REST endpoint.

path

string

REST URI/endpoint
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access": "readonly",
  "path": "/api/storage/volumes"
}

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

13434891

UUID LookUp failed for Vserver roles.

13434890

Vserver-Id failed for Vserver roles.

13434892

Roles is a required field.

13434893

SVM does not exist.

5636173

This feature requires an effective cluster version of 9.6 or later.

5636129

Role with given name has not been defined.

5636169

Invalid character in URI.

5636170

URI does not exist.

5636175

Vserver admin cannot have access to given API.

5636144

Invalid value specified for the access level.

5636143

A Vserver admin cannot use the API with this access level.
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

role_privilege

A tuple containing the REST endpoint and the access level assigned to that endpoint.

Name Type Description

_links

_links

access

string

Access level for the REST endpoint.

path

string

REST URI/endpoint

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.