Skip to main content

Update User Roles

This API can be used by MSPs to add or remove roles for a certain user. User Role update is asynchronous. Upon request submission, user record will be in "updating" status and will become "active" when update process finishes

Removing Account Manager role or Service Administrator role from user will also remove all the accounts the user manages.

Adding Service Administrator role to user will upgrade normal user to Administrator

Path Variables

FieldDescriptionTypeNotes
userIdUser metallic idUUID

Request Body

FieldDescriptionTypeRequiredNotes
actionAction for requested rolesString Enumeration. Allowed values: add / removeTrue
rolesList of user role IdsString ArrayTrueSee - Available Roles

Response Body

FieldDescriptionTypeNotes
idUser metallic idUUID
statusUser statusString Enumeration - User Status EnumerationRefer to User Status Enumeration. Value "updating" is returned in this case.
insertTsUser created timeTimestamp
updateTsUser last updated timeTimestamp
requestDataUpdate user roles Request BodyUpdate User Roles - Request BodySee - Update User Roles - Request Body
Path Parameters
  • userId string required
Request Body required
    Responses

    OK


    Schema
      Loading...