Users & Roles
API ReferenceUsers
Users & Roles
Manage the people on your team who have access to the merchant dashboard. Users are scoped to one or more merchants/organisations and each one carries a role that decides what they can do (view, manage payments, manage connectors, manage other users, etc.).
Lifecycle
- Invite. POST
/user/user/invite_multiplesends an email with a one-time link. The user is created ininvitation_sentstate. - Accept. The recipient clicks the link, sets a password, optionally TOTP, and lands on the dashboard. State moves to
active. - Update role. POST
/user/user/update_rolechanges the user's role in place. - Resend invite. POST
/user/user/resend_invitegenerates a fresh link if the original expired. - Remove. DELETE
/user/user/deleterevokes access.
Endpoints
| Operation | Method | Path |
|---|---|---|
| List users | GET | /user/user/list |
| List invitable roles | GET | /user/role/list/invite |
| Invite users | POST | /user/user/invite_multiple |
| Update user role | POST | /user/user/update_role |
| Resend invite | POST | /user/user/resend_invite |
| Delete user | DELETE | /user/user/delete |