Change User Role

patch

https://webapi.splashtop.com/api/open/v1/teams/{team_id}/users/{user_id}/change_role

This is the API to change the user’s role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

integer

required

ID of the Splashtop team.

user_id

integer

required

ID of the user you would like to configure.

Body Params

role

string

required

The role you would like to change to. (String) Available status: manager: The admin on the team group_admin: The group admin on the team member: The member on the team remote_user: available only for Splashtop AEM and Splashtop AEM (Enterprise) When it is group_admin role assigned, or you would like to assign a super admin, please check the Body section. Body

group_ids

array of integers

(Optional) Only required when the above role field is group_admin, to decide which groups the user will be group admin with. (Array, Integer) The ID of the groups. You can have the group ID info from 5.4.1 Get group info API. Example: { "role": "group_admin", "group_ids": [691256,693271] }

group_ids

super_admin

boolean

(Optional) Only required when the above role field is manager, to decide whether this team admin a super admin or not. (Boolean) Available status: true, false Example: See below super_admin_capability

super_admin_capability

object

(Optional) Only required when the above super_admin field is true, to decide which capabilities the super admin will have.

Responses

400

Bad request — invalid parameters

401

Unauthorized — invalid or missing access token

403

Forbidden — insufficient scope, or the action/value/target is not allowed. See data.error for the sub-reason.

200Successful response