Class CustomRoles

Class providing methods for working with Make custom roles. Requires the organization's customRoles license feature to be enabled.

Index

Constructors

Methods

create delete update

Constructors

constructor

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

Methods

create

create(body: CreateCustomRoleBody): Promise<CustomRole>
Create a new custom role.
Parameters
- body: CreateCustomRoleBody
  Parameters for the custom role to create
Returns Promise<CustomRole>
Promise with the created custom role
Example
```
const role = await make.customRoles.create({
    name: 'Custom Viewer',
    category: 'organization',
    organizationId: 1,
    permissions: [101, 102],
});
```
- Defined in src/endpoints/custom-roles.ts:108

delete

delete(roleId: number, body: DeleteCustomRoleBody): Promise<number>
Delete a custom role. The role must not be currently assigned to any users.
Parameters
- roleId: number
  The custom role ID to delete
- body: DeleteCustomRoleBody
  The organization ID the custom role belongs to
Returns Promise<number>
Promise with the ID of the deleted custom role
- Defined in src/endpoints/custom-roles.ts:138

update

update(roleId: number, body: UpdateCustomRoleBody): Promise<CustomRole>
Update an existing custom role.
Parameters
- roleId: number
  The custom role ID to update
- body: UpdateCustomRoleBody
  The organization ID the custom role belongs to, and the fields to update
Returns Promise<CustomRole>
Promise with the updated custom role
- Defined in src/endpoints/custom-roles.ts:123