Class Roles

Class providing methods for working with Make roles. Covers both built-in system roles and, when enabled, custom roles.

Index

Constructors

Methods

get list permissions

Constructors

constructor

new Roles(fetch: FetchFunction): Roles
Create a new Roles instance.
Parameters
- fetch: FetchFunction
  Function for making API requests
Returns Roles
- Defined in src/endpoints/roles.ts:118

Methods

get

get(roleId: number): Promise<Role>
Get details of a specific role, including its permissions. Requires Roleman to be enabled; not supported on private (on-premise) instances.
Parameters
- roleId: number
  The role ID to get
Returns Promise<Role>
Promise with the role information
Example
```
const role = await make.roles.get(42);
```
- Defined in src/endpoints/roles.ts:158

list

list<C extends keyof Role = never>(
options?: ListRolesOptions<C>,
): Promise<PickColumns<Role, C>[]>
List roles available to the current user.
Type Parameters
- C extends keyof Role = never
Parameters
- Optionaloptions: ListRolesOptions<C>
  Optional parameters for filtering and column selection
Returns Promise<PickColumns<Role, C>[]>
Promise with the list of roles
Example
```
const roles = await make.roles.list({ organizationId: 5 });
```
- Defined in src/endpoints/roles.ts:132

permissions

permissions(options?: ListRolePermissionsOptions): Promise<RolePermission[]>
List permissions that can be granted through a role.
Parameters
- Optionaloptions: ListRolePermissionsOptions
  Optional parameters for filtering by role category
Returns Promise<RolePermission[]>
Promise with the list of permissions
- Defined in src/endpoints/roles.ts:167