Summary
Update a role.
Description
Update a role
Route
PATCH /authorization/roles/:roleId
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| roleId |
string |
yes |
The individual role to update. |
| updates |
object |
yes |
An object containing the requested updates |
Copied to Clipboard
{
"updates": {
"description": "description of role_1",
"allowedMethods": [
{
"name": "methodName",
"provenance": "ApplicationName"
},
{
"name": "methodName",
"provenance": "ApplicationName"
}
],
"allowedViews": [
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
},
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
},
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
},
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
}
]
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The output of the role update. |
Copied to Clipboard
{
"status": "OK",
"message": "A sample success message",
"data": {
"provenance": "Custom",
"name": "role_1",
"description": "description of role_1",
"allowedMethods": [
{
"name": "methodName",
"provenance": "ApplicationName"
},
{
"name": "methodName",
"provenance": "ApplicationName"
},
{
"name": "methodName",
"provenance": "ApplicationName"
}
],
"allowedViews": [
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
},
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
}
],
"_meta": {
"created": "2018-08-02T15:56:12.912Z",
"updated": "2018-08-02T15:56:12.912Z"
}
}
}
