Retrieve a group-to-role mapping entry
Suggest changes
PDFs
GET /security/group/role-mappings/{group_id}/{ontap_role.name}
Introduced In: 9.16
Retrieves a group to role mapping entry.
Related ONTAP commands
-
security login group role-mapping show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
group_id |
integer |
path |
True |
Group ID.
|
ontap_role.name |
string |
path |
True |
Role name. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
comment |
string |
Any comment regarding this group entry. |
group_id |
integer |
Group ID. |
ontap_role |
Role name. |
|
scope |
string |
Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects. |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"comment": "string",
"group_id": 1,
"ontap_role": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "admin"
},
"scope": "string"
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
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 |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
ontap_role
Role name.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Role name |
error_arguments
| 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. |