Overview

Control who can access the Worky platform and what they can do. You can create users manually or sync them from your Identity Provider (IdP).

1. Create Admin User

Create a user who will have administrative privileges.

POST/api/v1/users
Request Body
{
  "email": "[email protected]",
  "firstName": "Admin",
  "lastName": "User",
  "employeeId": "emp-001"
}

2. Assign Roles

Grant specific capabilities using roles (e.g., `HR_MANAGER`, `PAYROLL_ADMIN`).

PUT/api/v1/users/{id}/roles
Request Body
{
  "roleIds": ["role-hr-mgr", "role-payroll-adm"]
}

3. Batch Activation

When going live, you can activate multiple users at once so they receive their welcome emails.

PUT/api/v1/users/batch/activate
Note: Activation triggers billing for active users.