Users

Manage users with the de.iterate SDK.

Overview

The users resource provides operations for managing user accounts within your organization.

List Users

const response = await client.users.list();

for (const user of response.data) {
  console.log(`${user.name} (${user.email})`);
  console.log(`  Role: ${user.role}`);
  console.log(`  Status: ${user.status}`);
}

Get User

const user = await client.users.get('user-123');

console.log(user.name);
console.log(user.email);
console.log(user.role);

Create User

const user = await client.users.create({
  email: 'new.user@company.com',
  name: 'New User',
  role: 'analyst',
});

console.log(`Created: ${user.id}`);

CreateUserInput

Field	Type	Required	Description
email	string	✅	User email
name	string	✅	Display name
role	string	❌	User role

Update User

await client.users.update('user-123', {
  role: 'admin',
  status: 'active',
});

Delete User

await client.users.delete('user-123');

User Type

interface User {
  id: string;
  type: 'user';
  email: string;
  name: string;
  role?: string;
  status: 'active' | 'inactive' | 'pending';
  createdAt: Date;
  updatedAt: Date;
}

Next Steps

• Roles - Role management
• Company - Organization settings