Retrieve a list of roles configured in the cluster
GET /security/roles
Introduced In: 9.6
Retrieves a list of roles configured in the cluster.
Related ONTAP commands
-
security login rest-role show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
owner.uuid |
string |
query |
False |
Filter by owner.uuid
|
owner.name |
string |
query |
False |
Filter by owner.name
|
name |
string |
query |
False |
Filter by name
|
scope |
string |
query |
False |
Filter by scope
|
privileges.path |
string |
query |
False |
Filter by privileges.path
|
privileges.access |
string |
query |
False |
Filter by privileges.access
|
builtin |
boolean |
query |
False |
Filter by builtin
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Error
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
_links
Name | Type | Description |
---|---|---|
self |
owner
Owner name and UUID that uniquely identifies the role.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
role_privilege
A tuple containing the REST endpoint and the access level assigned to that endpoint. The REST endpoint can be a resource-qualified endpoint. At present, the only supported resource-qualified endpoints are /api/storage/volumes/{volume.uuid}/snapshots and /api/storage/volumes//snapshots. "" is a wildcard character denoting "all" volumes.
Name | Type | Description |
---|---|---|
_links |
||
access |
string |
Access level for the REST endpoint. |
path |
string |
REST URI/endpoint |
role
A named set of privileges that defines the rights an account has when it is assigned the role.
Name | Type | Description |
---|---|---|
_links |
||
builtin |
boolean |
Indicates if this is a built-in (pre-defined) role which cannot be modified or deleted. |
name |
string |
Role name |
owner |
Owner name and UUID that uniquely identifies the role. |
|
privileges |
array[role_privilege] |
The list of privileges that this role has been granted. |
scope |
string |
Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects. |
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. |