Class UsersApi

Anonymize a list of users, removing their personal data. This operation is irreversible. Requires the user_access_manage permission.

Create a user for your organization.

Cancel all pending invitations for a specified user. Requires the user_access_invite permission.

Disable a user. Can only be used with an application key belonging to an administrator user.

Get the user associated with the current authentication context. The response includes the user's profile attributes (name, email, handle, status, MFA state), along with related resources: the user's organization, assigned roles with their granted permissions, and team-scoped roles. No additional permissions are required beyond valid authentication.

Returns a single user invitation by its UUID.

Get a user in the organization specified by the user’s user_id.

Get a user organization. Returns the user information and all organizations joined by this user.

Get a user permission set. Returns a list of the user’s permissions granted by the associated user's roles.

Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.

Provide a paginated version of listUsers returning a generator with all the items.

Sends emails to one or more users inviting them to join the organization.

Edit the profile of the currently authenticated user. Updatable fields include name, title, email, and disabled status. The id field in the request body must match the authenticated user's UUID; a mismatch returns a 422 error. Email address changes are recorded in the audit trail. Requires the user_self_profile_write permission.

Edit a user. Can only be used with an application key belonging to an administrator user.