Skip to main content
Version: Current

Roles API

APIs and models to manage your automation roles

API​

The following methods are available in the Role category.

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

Models​

The following models are used by the 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.