Class: RoleService
Defined in: service/RoleService.ts:105
Backwards-compatible class form. New code should call roleService(client).
Constructors
Constructor
new RoleService(
client):RoleService
Defined in: service/RoleService.ts:107
Parameters
client
Returns
RoleService
Methods
createRole()
createRole(
input):Promise<Role>
Defined in: service/RoleService.ts:122
Creates a new role
Parameters
input
Role creation input data
Returns
Promise<Role>
createRoleDefinition()
createRoleDefinition(
input):Promise<RoleDefinition>
Defined in: service/RoleService.ts:142
Creates a new role definition
Parameters
input
RoleDefinition creation input data
Returns
Promise<RoleDefinition>
getRole()
getRole(
id):Promise<Role>
Defined in: service/RoleService.ts:112
Fetches a single role by ID
Parameters
id
number
Role ID to fetch
Returns
Promise<Role>
getRoleDefinition()
getRoleDefinition(
id):Promise<RoleDefinition>
Defined in: service/RoleService.ts:132
Fetches a single role definition by ID
Parameters
id
number
RoleDefinition ID to fetch
Returns
Promise<RoleDefinition>
getRoleDefinitions()
getRoleDefinitions(
input?):Promise<RoleDefinitionResponse>
Defined in: service/RoleService.ts:137
Fetches a list of role definitions with search criteria
Parameters
input?
RoleDefinition search input parameters
Returns
Promise<RoleDefinitionResponse>
getRoles()
getRoles(
input?):Promise<RoleResponse>
Defined in: service/RoleService.ts:117
Fetches a list of roles with search criteria
Parameters
input?
Role search input parameters
Returns
Promise<RoleResponse>
updateRole()
updateRole(
variables):Promise<Role>
Defined in: service/RoleService.ts:127
Updates an existing role
Parameters
variables
Role update input data
Returns
Promise<Role>
updateRoleDefinition()
updateRoleDefinition(
variables):Promise<RoleDefinition>
Defined in: service/RoleService.ts:147
Updates an existing role definition
Parameters
variables
RoleDefinition update input data
Returns
Promise<RoleDefinition>