Skip to main content

Roles

Workspace API

Workspace API / models/Roles

models/Roles

Functions​

createSystemRole()​

createSystemRole(data, client?): Promise<SystemRole>

Defined in: models/Roles.ts:21

Create a new system role

Parameters​

data​

CreateSystemRoleData

client?​

any

Returns​

Promise<SystemRole>

findSystemRoleByName()​

findSystemRoleByName(name, client?): Promise<SystemRole | null>

Defined in: models/Roles.ts:39

Find system role by name

Parameters​

name​

string

client?​

any

Returns​

Promise<SystemRole | null>

findSystemRoleById()​

findSystemRoleById(roleId): Promise<SystemRole | null>

Defined in: models/Roles.ts:60

Find system role by ID

Parameters​

roleId​

string

Returns​

Promise<SystemRole | null>

getSystemRoles()​

getSystemRoles(filters): Promise<{ roles: SystemRole[]; total: number; }>

Defined in: models/Roles.ts:71

Get all system roles

Parameters​

filters​

SystemRoleFilters = {}

Returns​

Promise<{ roles: SystemRole[]; total: number; }>

updateSystemRole()​

updateSystemRole(roleId, updateData): Promise<SystemRole | null>

Defined in: models/Roles.ts:110

Update system role

Parameters​

roleId​

string

updateData​

UpdateSystemRoleData

Returns​

Promise<SystemRole | null>

createOrganizationRole()​

createOrganizationRole(data): Promise<OrganizationRole>

Defined in: models/Roles.ts:153

Create a new organization role

Parameters​

data​

CreateOrganizationRoleData

Returns​

Promise<OrganizationRole>

findOrganizationRoleById()​

findOrganizationRoleById(roleId): Promise<OrganizationRole | null>

Defined in: models/Roles.ts:169

Find organization role by ID

Parameters​

roleId​

string

Returns​

Promise<OrganizationRole | null>

findOrganizationRoleByName()​

findOrganizationRoleByName(organizationId, name): Promise<OrganizationRole | null>

Defined in: models/Roles.ts:183

Find organization role by name within organization

Parameters​

organizationId​

string

name​

string

Returns​

Promise<OrganizationRole | null>

getOrganizationRoles()​

getOrganizationRoles(filters): Promise<{ roles: OrganizationRole[]; total: number; }>

Defined in: models/Roles.ts:199

Get organization roles

Parameters​

filters​

OrganizationRoleFilters

Returns​

Promise<{ roles: OrganizationRole[]; total: number; }>

getOrganizationRoleWithPermissions()​

getOrganizationRoleWithPermissions(roleId): Promise<OrganizationRoleWithPermissions | null>

Defined in: models/Roles.ts:244

Get organization role with permissions

Parameters​

roleId​

string

Returns​

Promise<OrganizationRoleWithPermissions | null>

updateOrganizationRole()​

updateOrganizationRole(roleId, updateData): Promise<OrganizationRole | null>

Defined in: models/Roles.ts:284

Update organization role

Parameters​

roleId​

string

updateData​

UpdateOrganizationRoleData

Returns​

Promise<OrganizationRole | null>

deleteOrganizationRole()​

deleteOrganizationRole(roleId): Promise<boolean>

Defined in: models/Roles.ts:328

Delete organization role

Parameters​

roleId​

string

Returns​

Promise<boolean>

isOrganizationRoleNameAvailable()​

isOrganizationRoleNameAvailable(organizationId, name, excludeId?): Promise<boolean>

Defined in: models/Roles.ts:339

Check if organization role name is available

Parameters​

organizationId​

string

name​

string

excludeId?​

string

Returns​

Promise<boolean>

assignPermissionsToSystemRole()​

assignPermissionsToSystemRole(roleId, permissionIds, client?): Promise<boolean>

Defined in: models/Roles.ts:365

Assign permissions to system role

Parameters​

roleId​

string

permissionIds​

string[]

client?​

any

Returns​

Promise<boolean>

assignPermissionsToOrganizationRole()​

assignPermissionsToOrganizationRole(roleId, permissionIds): Promise<boolean>

Defined in: models/Roles.ts:411

Assign permissions to organization role

Parameters​

roleId​

string

permissionIds​

string[]

Returns​

Promise<boolean>

getSystemRolePermissions()​

getSystemRolePermissions(roleId): Promise<object[]>

Defined in: models/Roles.ts:447

Get system role permissions

Parameters​

roleId​

string

Returns​

Promise<object[]>

getOrganizationRolePermissions()​

getOrganizationRolePermissions(roleId): Promise<object[]>

Defined in: models/Roles.ts:465

Get organization role permissions

Parameters​

roleId​

string

Returns​

Promise<object[]>