The User
A user is a person with a Lexabit account. Users are different from the other entities: they're the actor — the thing that acts on clients, cases, and teams — rather than a work or organizational target. That's why users are managed under Access & Permissions, not Entity Management.
How you address it
/users/v1 # list
/users/v1/{id} # retrieve, delete
/users/v1/{id}/roles # assign / remove roles on the current scope
/users/v1/{id}/scope-profile # per-scope profile
/users/v1/me/invitations # the current user's own invitations
The /users/v1/me/… endpoints act on the authenticated user and don't need an
X-Scope. See Users, Roles & Permissions
for the workflow.
Key fields
| Field | Notes |
|---|---|
name, firstName, lastName | Display identity |
email | Login identity |
phone, avatarUrl | Contact / display |
membership | The user's membership on the current scope |
roles | The user's roles on the current scope entity |
What makes a user different
- It's an actor, not a target. Users don't carry the Entity Management sub-resources (contacts, addresses, …) the way clients and cases do; a user has its own scope-profile instead.
- Roles are per scope. The same user can be an editor on one team and a
viewer on another —
rolesandmembershipare always relative to the currentX-Scope. See Permissions. - Identity is authentication's concern. How a user signs in and obtains a token is covered under Authentication; this page is about the user as an entity in the access model.
Relationships
- Belongs to a tenant.
- Is a member of teams and groups, with a role on each.
- Acts on target entities (clients, cases, …) subject to those roles.