Skip to main content

Role

APIs and Models to manage your automation roles

API

Here is the list of APIs existing under the Role category.

APIDescription
CreateRoleAsyncCreates new Role with specified NewRoleInfo details from the connected Control Room.
DeleteRoleAsyncThe API deletes an existing Role with a specified role ID from the connected Control Room.
GetAllRolesAsyncGets the list of RoleInfo of all Roles from the connected Control Room.
GetRoleByIdAsyncGets a role in the form of Role with specified Role Id from the connected Control Room.
UpdateRoleAsyncUpdate the existing role with specified NewRoleInfo from the connected Control Room.

Models

Here is the list of Models used in Roles APIs.

ModelsDescription
NewRoleInfoThe structure represents an instance of the New Role entity.
RoleThe structure represents an instance of the Role entity.
RoleInfoThe structure represents an instance of the RoleInfo entity.
RolePermissionThe structure represents an instance of the Role permission entity.
PermissionThe structure represents an instance of the permission entity.