SDK User Management
The dypai.users module provides admin-level operations to manage the users of your project. These methods require an admin token — they are intended for server-side use or admin dashboards, not for client-side code.
All dypai.users operations require a token with admin permissions. Do not expose admin tokens in client-side code.
These methods require the user's role to have the manage_users permission enabled in system.roles. The "admin" role has it enabled by default. For other roles, you can enable it from the Auth > Roles section of the dashboard. See the Permission System for details.
List Users
Retrieve a paginated list of all users in your project.
const { data, error } = await dypai.users.list({
page: 1,
per_page: 20
});
if (data) {
console.log('Users:', data.users);
console.log('Total:', data.total);
}
Create User
Create a new user programmatically (bypasses email confirmation).
const { data, error } = await dypai.users.create({
email: 'newuser@example.com',
full_name: 'Jane Smith'
});
if (error) {
console.error('Failed to create user:', error.message);
return;
}
console.log('Created user:', data.id);
Update User
Update an existing user's profile data.
const { data, error } = await dypai.users.update('user-uuid', {
full_name: 'Jane Doe'
});
if (error) {
console.error('Failed to update user:', error.message);
return;
}
console.log('Updated user:', data.email);
Delete User
Permanently delete a user from your project.
const { data, error } = await dypai.users.delete('user-uuid');
if (error) {
console.error('Failed to delete user:', error.message);
return;
}
console.log('User deleted:', data.success);
Method Reference
| Method | Description |
|---|---|
list({ page, per_page }) | List users with pagination. Returns { users, total }. |
create({ email, full_name }) | Create a new user. Returns the created User. |
update(userId, { full_name }) | Update a user's profile. Returns the updated User. |
delete(userId) | Delete a user permanently. Returns { success: boolean }. |