Edit a role

PUT https://{{host}}/identity-management/v3/user-admin/roles/:roleId

This operation adds or removes a role's group role assignments, along with other data such as name and description. When you modify a role, those changes affect existing API clients. Review all API clients belonging to the user before modifying a role.

Request Params

KeyDatatypeRequiredDescription
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Request Body

{"grantedRoles"=>[{"grantedRoleId"=>2063}], "roleDescription"=>"Provides users with edit and create access to reports.", "roleName"=>"Edit Reports"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"actions":{"delete":true,"edit":true},"createdBy":"alfulani","createdDate":"2017-09-11T13:43:54.000Z","grantedRoles":[{"grantedRoleDescription":"View Audience Analytics Reports","grantedRoleId":2063,"grantedRoleName":"View Audience Analytics Reports"}],"modifiedBy":"adevi","modifiedDate":"2017-09-11T13:47:32.000Z","roleDescription":"This role lets users edit and create reports.","roleId":100645,"roleName":"Edit Reports","type":"custom"}