Introduction
APIs and Models to administer your automation users
API
Here is the list of APIs existing under the Users category.
| API | Description |
|---|---|
| AssignRoleAsync | The API assigns the Role ID to the specified user ID of the user inside the connected Control Room. |
| CreateUserAsync | Creates a new User of type UserInfo with specified NewUserInfo details inside the connected Control Room. |
| DeleteUserAsync | Deletes an existing User with a specified user ID from the connected Control Room. |
| GetCurrentUserAsync | Gets the current user's UserInfo details from the connected Control Room. |
| GetAllUsersAsync | Gets the list of all available UserInfo details from the connected Control Room. |
| GetRolesAsync | The API gets the assigned list of roles for the specified user ID from the connected Control Room. |
| GetUserByIdAsync | Gets UserInfo details with the specified User Id from the connected Control Room. |
| UpdateUserInfoAsync | Updates the specified UserInfo details inside the connected Control Room. |
Models
Here is the list of Models used in Users' APIs.
| Models | Description |
|---|---|
| NewUserInfo | The structure represents an instance of the New User entity. |
| PasswordInfo | The structure represents an instance of the Password entity. |
| UserRole | The structure represents an instance of the User Role entity. |
| UserInfo | The structure represents an instance of the User entity. |