https://portal.hyperprop.com.
What each person can see and do is set by their role. You can manage both
from the dashboard or with the API, for example to onboard staff from your own
HR or admin system.
Reading the team and roles works with a read-only key;
changes need a full-access key.
Roles
A role is a map of permission domains to a level:none (hidden),
view (read only) or manage (read and change).
Every organization has four system roles you can assign but not change:
GET /organization/roles lists the system roles and your custom roles with
their permission maps.
Create a custom role
none. Change a custom role with
PATCH /organization/roles/{roleId}; members with that role get the new access
on their next request. Delete it with DELETE /organization/roles/{roleId}
once no member has it.
Team members
GET /organization/team lists members with their role (roleId,
roleName) and resolved permissions.
Add a member
tempPassword, shown once.
Share it with the person through a secure channel; they should change it after
signing in. If the email already has a Hyperprop login, it is linked instead
(linkedExisting: true, no temporary password). An email that is already a
staff login at another organization returns 409 EMAIL_IN_USE.
Change a role, reset a password, remove a member
To keep your organization manageable, you cannot demote or remove the last
member who can manage the team.
People versus API keys
Roles apply to people signed in to the dashboard. API keys are not team members and have no role: a full-access key can call every endpoint, and a read-only key can call everyGET endpoint. If your own tool
lets several people act through one key, enforce who may do what inside your
tool.
Changes to trading accounts are recorded in the audit log
(GET /organization/audit-log) with who made them: the team member’s email,
or the API key.