Skip to main content
zerotal

Documentation


Documentation / @zerotal/admin / index / RoleProvider

Interface: RoleProvider

Defined in: admin/src/roles.ts:55

What the app supplies so roles can be listed and edited.

Methods

list()

list(): Role[] | Promise<Role[]>

Defined in: admin/src/roles.ts:57

Every role, in the order they should appear.

Returns

Role[] | Promise<Role[]>


permissionsFor()

permissionsFor(roleId): string[] | Promise<string[]>

Defined in: admin/src/roles.ts:59

The permission keys one role currently holds.

Parameters

roleId

string

Returns

string[] | Promise<string[]>


setPermissions()

setPermissions(roleId, keys): void | Promise<void>

Defined in: admin/src/roles.ts:61

Replace a role's permissions with exactly this set.

Parameters

roleId

string

keys

string[]

Returns

void | Promise<void>


create()?

optional create(role): void | Promise<void>

Defined in: admin/src/roles.ts:63

Create a role. Omit to make roles read-only in the panel.

Parameters

role

Omit<Role, "id">

Returns

void | Promise<void>


remove()?

optional remove(roleId): void | Promise<void>

Defined in: admin/src/roles.ts:65

Delete a role. Omit to forbid deletion from the panel.

Parameters

roleId

string

Returns

void | Promise<void>