RolesResource

API reference for the Roles resource.

Methods

list

List all roles.

async list(): Promise<ListResponse<Role>>

get

Get a single role by ID.

async get(id: string): Promise<Role>

Types

Role

interface Role {
  id: string;
  type: 'role';
  name: string;
  description?: string;
  permissions: string[];
  userCount?: number;
  createdAt: Date;
  updatedAt: Date;
}

Example

// List all roles
const response = await client.roles.list();

for (const role of response.data) {
  console.log(`${role.name}`);
  console.log(`  Users: ${role.userCount}`);
  console.log(`  Permissions: ${role.permissions.join(', ')}`);
}