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

Delete a role

PDFs

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

Introduced In: 9.6

Deletes the specified role.

Required parameters

  • name - Name of the role to be deleted.

  • owner.uuid - UUID of the SVM housing the role.

  • 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 to be deleted.

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1263347

Cannot modify pre-defined roles.

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

Features require 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.

13434890

Vserver-ID failed for Vserver roles.

13434893

The SVM does not exist.
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

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.