User management APIs
Use User Management APIs to create, search, update, or delete roles and users in your Control Room.
User Management Roles
Users need the following permissions in order to create and manage users and roles.- View users
You need an administrator permission to create and manage users and roles. It is recommended that non-administrator users be given limited permissions for creating and managing users. Learn how to create a role with limited permissions that can be assigned to users.
- Create users
Create new users in the Control Room.
- Edit users
Edit all users in the Control Room, including users created by other administrators.
- Delete users
Delete any user in the Control Room.
- View roles
Users with this permission can view roles to which they have access.
- Manage roles
Users can create, edit and delete roles to which they have access.
- View licenses
Users with these permissions are able to view and manage device licenses. Device licenses are required to enable users to perform specific tasks. For example, Bot Creators require a DEVELOPMENT device license in order to create bots.
- Manage users device license
Users with this permission can assign device licenses to other users.
Role APIs
Use Role APIs to List Roles, create a role, retrieve a specific role using an object ID, update a role, or delete a role.
- List roles
- Retrieves current roles based on search criteria, such as filtering,
sorting, and pagination.
POST http://<your_control_room_url>/v1/usermanagement/roles/list
- Create role
- Creates a new role with a new role name.
POST http://<your_control_room_url>/v1/usermanagement/roles
- Retrieve role
- Retrieves a specific role based on a unique role ID.
GET http://<your_control_room_url>/v1/usermanagement/roles/{id}
- Update role
- Modifies an existing role name based on a unique role ID.
PUT http://<your_control_room_url>/v1/usermanagement/roles/{id}
- Delete role
- Deletes an existing role based on a unique role ID.
DELETE http://<your_control_room_url>/v1/usermanagement/roles/{id}
User APIs
Use User APIs to create a user, search for users, retrieve a user details based on a user ID, update a specific user details, or delete a user.
- Create a new user API
- Creates a user with a new user name.
POST http://<your_control_room_url>/v1/usermanagement/users
- Search for users API
- Retrieves current users based on search criteria, such as filtering,
sorting, and pagination.
POST http://<your_control_room_url>/v1/usermanagement/users/list
- Retrieve a specific user details API
- Retrieves user details based on a unique user ID.
GET http://<your_control_room_url>/v1/usermanagement/users/{uid}
- Update an existing user details API
- Modifies an existing user name based on a unique user ID.
PUT http://<your_control_room_url>/v1/usermanagement/users/{uid}
- Delete an existing user API
- Deletes an existing user based on a unique user ID.
DELETE http://<your_control_room_url>/v1/usermanagement/users/{uid}