Update role

PUT {{baseUrl}}/roles/:id?aid=1234

Updates a user-defined role using its ID.

When updating a role, the following applies: * The full list of permissions must be sent, This endpoint does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions endpoint.

Request Params

KeyDatatypeRequiredDescription
aidnumberA unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.

Request Body

{"name"=>"Organization Admin", "permissions"=>["56", "315"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"name":"Organization Admin","roleId":"35","isBuiltin":false,"permissions":[{"label":"View reports","permissionId":"1","isManagementPermission":true,"permission":"REPORT_READ"},{"label":"View snapshots","permissionId":"51","isManagementPermission":false,"permission":"REPORT_SNAPSHOTS_READ"}],"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"ut et","deprecation":"consequat Ut dolor occaecat dolore","name":"magna ad","profile":"aute nulla sed","title":"ut dolore","hreflang":"pariatur aute incididunt"}}}