Users

Defaults to active users. Each user carries a compact risk and training summary; use GET /users/{user_id} for the full breakdown.

Adds a single user to the client outside directory sync, the same as adding a user in the dashboard. The user lands in the client's Manual group, is classified into a risk role from job title, department, and email (or takes the role you send, which is kept as a manual override), and picks up any framework-required courses within a few minutes. Users created here report source: api.

collection_ids places the user in a collection of the same client. A user belongs to at most one collection, so send at most one id.

Welcome email. With send_welcome_email false (the default) the user never gets a welcome email. With true the user is left for the client's scheduled welcome-email run, which sends it once, honoring the client's welcome-email settings (it must be enabled for the client, and the business-day delay and first-send date apply). Nothing is sent from this request.

An email that already belongs to a user of the client (active or inactive) returns 409 CONFLICT; update that user instead. If the client uses directory sync, prefer letting sync create users; a manually created user with the same email is merged on the next sync and then reports the directory as its source.

Full user record including the risk breakdown and current training position.

Partial update: only the fields present are changed, and a body that changes nothing is 400. Returns the updated user.

Directory sync. role, preferred_language and manager_email are kept as manual overrides, the same as editing them in the dashboard: the next directory sync does not overwrite them. first_name, last_name, department and job_title have no override; for a directory-synced user the next sync writes the directory's values back, so change those in the directory. manager_email: null removes the manager (also kept as an override).

Status. inactive deactivates the user exactly as the dashboard does: they stop receiving training and simulations, and their open training assignments are cleared (completions are kept). active reactivates them. If they have completed training before, their history is restored from the day they were added (completed courses and original due dates count again; unfinished ones come back overdue), which is the dashboard's default; otherwise they start fresh from today. A directory-synced user's status follows the directory on the next sync.