Delete a privilege tuple from the role

07/17/2026

DELETE /security/roles/{owner.uuid}/{name}/privileges/{path}

Introduced In: 9.6

Deletes a privilege tuple (of REST URI or command/command directory path, its access level and an optional query) from the role. The REST URI can be a resource-qualified endpoint. Currently, the only supported resource-qualified endpoints are the following:

Snapshots APIs

– /api/storage/volumes/{volume.uuid}/snapshots

File System Analytics APIs

– /api/storage/volumes/{volume.uuid}/files

– /api/storage/volumes/{volume.uuid}/top-metrics/clients

– /api/storage/volumes/{volume.uuid}/top-metrics/directories

– /api/storage/volumes/{volume.uuid}/top-metrics/files

– /api/storage/volumes/{volume.uuid}/top-metrics/users

– /api/svm/svms/{svm.uuid}/top-metrics/clients

– /api/svm/svms/{svm.uuid}/top-metrics/directories

– /api/svm/svms/{svm.uuid}/top-metrics/files

– /api/svm/svms/{svm.uuid}/top-metrics/users

ONTAP S3 APIs

– /api/protocols/s3/services/{svm.uuid}/users

Artificial Intelligence Data Engine (AIDE) APIs

Data Compute Node (DCN) APIs

– /api/dcn/cluster/nodes/{node.uuid}/metrics

– /api/dcn/network/ports/{port.uuid}/metrics

Data-Engine APIs

– /api/data-engine/policies/{policy.uuid}/versions

– /api/data-engine/workspaces/{workspace.uuid}/acls

– /api/data-engine/workspaces/{workspace.uuid}/data-collections

– /api/data-engine/workspaces/{workspace.uuid}/data-collections/{datacollection.uuid}/acls

– /api/data-engine/workspaces/{workspace.uuid}/data-collections/{entity.uuid}/entities

– /api/data-engine/workspaces/{workspace.uuid}/data-collections/{datacollection.uuid}/search

– /api/data-engine/workspaces/{workspace.uuid}/data-collections/{datacollection.uuid}/versions

– /api/data-engine/workspaces/{workspace.uuid}/data-collections/{datacollection.uuid}/versions/{version.uuid}/diffs

– /api/data-engine/workspaces/{workspace.uuid}/data-sources

– /api/data-engine/workspaces/{workspace.uuid}/entities

– /api/data-engine/workspaces/{workspace.uuid}/entities/{entity.uuid}/custom-attributes

– /api/data-engine/workspaces/{workspace.uuid}/queries

– /api/data-engine/workspaces/{workspace.uuid}/queries/{query.uuid}/entities

– /api/data-engine/workspaces/{workspace.uuid}/versions

– /api/data-engine/workspaces/{workspace.uuid}/versions/{version.uuid}/diffs

When used in the context of data collection APIs, {version.uuid} refers to a data collection version. In the context of workspace APIs, it refers to a workspace version.

In the APIs above, and in the context of REST roles, the wildcard character * can be used in place of {volume.uuid} or {svm.uuid} to represent all volumes or all SVMs, depending on whether the REST endpoint references volumes or SVMs. The {volume.uuid} corresponds to the -instance-uuid field in the output of the "volume show" command at the diagnostic privilege level. It can also be retrieved through the REST endpoint /api/storage/volumes.

In the AIDE APIs described above, and in the context of REST roles, the wildcard character * can be used in place of variable components in the Uniform Resource Identifier (URI) path, such as {node.uuid}, {port.uuid}, {policy.uuid}, {workspace.uuid}, {datacollection.uuid}, {entity.uuid}, {version.uuid}, or {query.uuid}. The specific variable to be replaced depends on whether the REST endpoint references nodes, ports, policies, workspaces, data collections, entities, versions, or queries.

However, when using the wildcard character * in place of a variable component in a URI path, it must replace

all variable components in that path. Mixing wildcards and specific values for different variable components within the same URI path is not supported in REST roles. For example, a URI path such as /api/data-engine/workspaces/c6e1b325-4125-11f0-abb5-bc2411f6fd43/data-collections/*/search is not supported.

In summary, only the following two types of resource-qualified endpoints are supported in a REST role:

All variable components in the URI path are specific values. Example: /api/data-engine/workspaces/c6e1b325-4125-11f0-abb5-bc2411f6fd43/data-collections/b09b6d25-4126-11f0-abb5-bc2411f6fd43/search
All variable components in the URI path are wildcards. Example: /api/data-engine/workspaces//data-collections//search

AIDE APIs are supported only in cluster-scoped REST roles, not in SVM-scoped REST roles.

Required parameters

owner.uuid - UUID of the SVM which houses this role.
name - Name of the role to be updated.
path - Constituent REST API path or command/command directory path to be deleted from this role. Can be a resource-qualified endpoint (example: /api/svm/svms/43256a71-be02-474d-a2a9-9642e12a6a2c/top-metrics/users). Currently, resource-qualified endpoints are limited to the Snapshots, File System Analytics_, Artificial Intelligence Data Engine (AIDE)_ and ONTAP S3 endpoints listed above in the description.

security login rest-role delete
security login role delete

Learn more

Parameters

Name	Type	In	Required	Description
owner.uuid	string	path	True	Role owner UUID
name	string	path	True	Role name
path	string	path	True	REST API path or command/command directory path

Name

Type

Required

Description

owner.uuid

string

path

True

Role owner UUID

name

string

path

True

Role name

path

string

path

True

REST API path or command/command directory path

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code	Description
1263347	Cannot modify pre-defined roles.
5636168	This role is mapped to a REST role and can only be modified by updating the REST role.
5636169	Specified URI path is invalid or not supported. Resource-qualified endpoints are not supported.
5636170	URI does not exist.
5636172	User accounts detected with this role assigned. Update or delete those accounts before deleting this role.
5636173	This feature requires an effective cluster version of 9.6 or later.
5636184	Expanded REST roles for granular resource control feature is currently disabled.
5636185	The specified UUID was not found.
5636186	Expanded REST roles for granular resource control requires an effective cluster version of 9.10.1 or later.
5636259	The specified child AIDE object was not found within the specified parent AIDE object.
5636261	The specified grandchild AIDE object was not found within the specified child AIDE object that belongs to the specified parent AIDE object.
13434890	Vserver-ID failed for Vserver roles.
13434893	The SVM does not exist.

Also see the table of common errors in the Response body overview section of this documentation.

Name	Type	Description
error	returned_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

error_arguments

Name	Type	Description
code	string	Argument code
message	string	Message argument

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.

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.

Delete a privilege tuple from the role

Creating your file...

Snapshots APIs

File System Analytics APIs

ONTAP S3 APIs

Artificial Intelligence Data Engine (AIDE) APIs

Data Compute Node (DCN) APIs

Data-Engine APIs

Required parameters

Related ONTAP commands

Learn more

Parameters

Response

Error

Definitions