Update a configured group role-mapping entry
Suggest changes
PDFs
PATCH /security/group/role-mappings/{group_id}/{ontap_role.name}
Introduced In: 9.16
Updates a configured group role-mapping.
Related ONTAP commands
-
security login group role-mapping modify
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
group_id |
integer |
path |
True |
Group ID.
|
ontap_role.name |
string |
path |
True |
Role name. |
Request Body
| Name | Type | Description |
|---|---|---|
comment |
string |
Any comment regarding this group entry. |
scope |
string |
Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects. |
Example request
{
"comment": "string",
"scope": "string"
}Response
Status: 200, OkError
Status: Default, ErrorDefinitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
ontap_role
Role name.
| Name | Type | Description |
|---|---|---|
name |
string |
Role name |
group_role_mappings
| Name | Type | Description |
|---|---|---|
comment |
string |
Any comment regarding this group entry. |
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 |
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. |