Users

Retrieve a paginated list of users. Returns users within the managed groups of the authenticated user.

Create a new user. The user will be assigned to a group and an invitation email will be sent automatically, unless skip-invitation is set to true.

To assign access roles at creation time, include an access-roles relationship with one or more role objects. If no roles are provided, the user will have a "Custom Role" with minimal permissions. See Access Roles for the list of valid role names.

login and email are immutable after creation.

Retrieve a single user by ID. Use me as the ID to retrieve the currently authenticated user.

Update a user's attributes. login and email cannot be changed after creation. name (last name) and first-name can be updated at any time. Password changes are only allowed when updating one's own account.

To add or remove access roles, use the /access-roles endpoints — roles cannot be updated inline on this endpoint.

Activate a user and send them an invitation email.

Retrieve the currently authenticated user's details.