User management API overview

Use the User Management APIs to create, search, update, or delete roles and users in your Control Room.

User Management Roles

The Role and User APIs are available to create and manage roles and users. Use the links in the following sections to compose an API request and receive a response. You can use the APIs in any order you want. The order that is presented below is as shown in the Automation Anywhere Swagger interface.

Role APIs

Use Role APIs to create a role, search for roles, retrieve a specific role using an object ID, update a role, or delete a role.

Create a new role
Creates a new role with a new role name.
POST http://<your_control_room_url>/v1/usermanagement/roles

See Create a new role.

Search for roles
Retrieves all roles based on search criteria, such as filtering, sorting, and pagination.
POST http://<your_control_room_url>/v1/usermanagement/roles/list

See Search for roles.

Retrieve a role
Retrieves a specific role based on a unique role ID.
GET http://<your_control_room_url>/v1/usermanagement/roles/{id}

See Retrieve a specific role.

Update a role
Modifies an existing role name based on a unique role ID.
PUT http://<your_control_room_url>/v1/usermanagement/roles/{id}

See Update an existing role.

Delete a role
Deletes an existing role based on a unique role ID.
DELETE http://<your_control_room_url>/v1/usermanagement/roles/{id}

See Delete an existing role.

User APIs

Use User APIs to create a user, search for users, retrieve a user, update a user, or delete a user.

Create a new user
Creates a user with a new user name.
POST http://<your_control_room_url>/v1/usermanagement/users

See Create a new user.

Search for users
Retrieves current logged-in users based on search criteria, such as filtering, sorting, and pagination.
POST http://<your_control_room_url>/v1/usermanagement/users/list

See Search for users.

Retrieve a user
Retrieves user details based on a unique user ID.
GET http://<your_control_room_url>/v1/usermanagement/users/{id}

See Retrieve a specific user.

Update a user
Modifies an existing user name based on a unique user ID.
PUT http://<your_control_room_url>/v1/usermanagement/users/{id}

See Update an existing user.

Delete a user
Deletes an existing user based on a unique user ID.
DELETE http://<your_control_room_url>/v1/usermanagement/users/{id}

See Delete an existing user.