Roles

Manage roles with the de.iterate SDK.

Overview

The roles resource provides operations for managing role definitions and permissions.

List 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(', ')}`);
}

Get Role

const role = await client.roles.get('role-123');

console.log(role.name);
console.log(role.description);
console.log(role.permissions);

Role Type

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

Next Steps

• Users - User management