Organisations and roles.
One balance, one set of keys, and a role for each person who uses them.
Organisations#
An organisation holds the balance, the ledger, the API keys, the request log, the rate limits and the billing details. People belong to it as members, and every call made with one of its keys is charged to its balance.
When you sign up you get a personal organisation named after you, with you as its owner. You can create more, and belong to as many as you like. The dashboard works on one at a time: switch between them under Settings, Organisation. search login creates its key in the organisation you have open, and asks which one when you belong to several. GET /api/v1/mereturns the calling key's organisation as org.id and org.name.
Roles#
Each member has one role: owner, admin, member or viewer. Every member can see everything the organisation spends; only owners and admins can add money, change settings or manage people.
| permission | owner | admin | member | viewer |
|---|---|---|---|---|
| See the organisation, its usage, logs, balance, statement and receipts | ✓ | ✓ | ✓ | ✓ |
| See the keys list, masked | ✓ | ✓ | ✓ | ✓ |
| Create keys, and rename, cap, expire, reveal and revoke your own | ✓ | ✓ | ✓ | |
| Do the same to every key in the organisation | ✓ | ✓ | ||
| Change the name and settings, including query storage and retention | ✓ | ✓ | ||
| Invite, change and remove members (an admin cannot change or remove an owner) | ✓ | ✓ | ||
| Top up and redeem promo codes | ✓ | ✓ | ||
| Manage billing details, contacts, the saved card and auto-recharge | ✓ | ✓ | ||
| Read the activity log and download the organisation's data | ✓ | ✓ | ||
| Delete the organisation and transfer ownership | ✓ |
Viewers see keys masked and can never reveal one. Members can reveal only the keys they created. An organisation always has at least one owner, so the last owner can neither leave nor be demoted until another member is made owner.
Invites#
Owners and admins invite people by email and choose their role. The invite email carries a link; the person signs in with the invited address to accept it, and a sign-in with any other address cannot. An invite lasts 7days, and can be resent or cancelled until then under Settings, Members & roles.
Shared keys#
Keys belong to the organisation, not to the person who made them. Each key shows who created it and how (in the dashboard, or by search login on a named machine). An organisation can have 10 active keys. A key can carry a daily spend cap and an expiry date; after that date it is refused with 401 key_expired. Daily caps and rate limits are on Billing.
Leaving and deleting#
When a member leaves or is removed, the keys they created keep working and the ledger keeps every row they caused. An owner or admin can revoke those keys if they should stop.
Closing your account deletes your personal organisation in the same way when no one else belongs to it. If you are the only owner of an organisation that has other members, transfer ownership first.