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

Retrieve the access level for a REST API path or command/command directory path for a role

PDFs

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

Retrieves the privilege level for a REST API path for the specified role.

  • security login rest-role show

Learn more

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

owner.uuid

string

path

True

Role owner UUID

name

string

path

True

Role name

path

string

path

True

REST API path

Response

Status: 200, Ok
Name Type Description

_links

_links

access

string

Access level for the REST endpoint.

path

string

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

Error

Status: Default, Error
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

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.