Skip to main content

User

A User represents an actor who interacts with the platform and is identified by a unique email address.

User vs Account

The distinction between User and Account is important:

  • A User is the authenticated identity (person / serviceAccount + credentials).
  • An Account is the legal holding vehicle (individual, corporate, or joint).

A single user can have multiple accounts (e.g., a personal account and a company account). Conversely, a joint account involves two users sharing one account, or a corporate account can involve the CEO and accountant.

This relationship is somewhat similar to the one used in the intermediated placement thanks to the Advisors.

User Groups (Teams)

Users are organized into UserGroup. Each group defines a shared set of roles and permissions. Admins can assign users to different groups to fine-tune their access rights.

query {
GetUser(id: "456") {
id
active
email
firstName
lastName
userGroup {
id
name
persona
}
accounts {
id
label
}
# ...Other User fields
}
}

→ Type reference: User

User Lifecycle

StateDescription
PendingUser has registered but is awaiting admin approval (acceptedAt is null)
ActiveUser is approved and can log in (active: true)
InactiveUser has been deactivated (active: false); an unactiveComment explains why

Key Fields at a Glance

FieldTypeDescription
idIDUnique identifier
emailString!Email address (used for login)
firstNameStringFirst name
lastNameStringLast name
mobileStringMobile phone number
activeBooleanWhether the user is active
acceptedAtDateTimeWhen the user was accepted (null = pending)
userGroupUserGroupThe team / permission group
accounts[Account]!All accounts owned by this user
localeSupportedLocalePreferred language locale
lastLoginDateTimeTimestamp of the last successful login
OperationReference
Fetch a single userGetUser
List all usersGetUsers
Create a user (authenticated)CreateUser
Create a user (public / self-registration)CreateUser (public)
Activate a userActivateUser
Deactivate a userDeactivateUser
Update user info and permissionsUpdateUserInfosAndPermissions