Organisations
An organisation is an account that owns Spaces, members, Agents and billing. This page describes organisation membership types, the organisation pages in Studio, permissions, seats, invites, Space ownership and removal. For the Agents an organisation controls, see Agents.
Where Organisations Are Managed
In Studio, open the user menu and select Organisations. The Organisations page lists:
Item | Shows |
|---|---|
Each organisation you belong to | Its display name, your membership type ( |
Pending Invites | Organisation invites sent to your email address, with Accept and Decline. |
Create Organisation opens a form with one field, Display Name. Continue to billing creates the organisation, makes you its owner, and opens billing setup: a billing address, then a billing account with a plan and a number of seats. Until a subscription exists, the organisation shows Setup required and its owners can only set up billing and remove the organisation; members have no organisation permissions.
A display name that contains profanity is rejected with Display name contains profanity. Contact support if you believe this is an error.
Organisation Tabs
Selecting an organisation opens a page with these tabs. A tab appears only when you hold its permission.
Tab | Contents | Required permission |
|---|---|---|
Spaces | The organisation's Spaces, your role in each (Space User Role), Join and Leave, and Create Space. |
|
Members | Seat usage and every member, with Type (owner or member) and Actions. |
|
Invites | Pending invites, seat usage, and Invite User, or Add seats when every seat is used. |
|
Agents | The organisation's Agents. See Agents. |
|
Billing | Addresses and Billing Accounts (plan, seats, status and monthly total). |
|
Config | Danger zone with Remove Organisation. |
|
Audit | Device lifecycle events. Shown only when device pairing is enabled. See Devices — Audit. |
|
Membership Types
Every member is either an owner or a member.
Type | Permissions |
|---|---|
Owner | Every organisation permission. Until the organisation has a subscription, only the billing setup permissions and |
Member |
|
An organisation always has at least one owner:
- The last owner cannot leave. The request fails with
Cannot leave the organisation as the last owner. The organisation must have at least one owner. - The last owner cannot become a member. The request fails with
Cannot downgrade the last owner to member. The organisation must have at least one owner. - You cannot change your own type:
You cannot change your own role.
Owners change another member's type with the Type select on the Members tab.
Organisation Permissions
Permission | Allows |
|---|---|
| Removing the organisation |
| Listing the organisation's Spaces and members |
| Creating a Space owned by the organisation |
| Joining one of the organisation's Spaces |
| Transferring a Space into the organisation |
| Transferring one of the organisation's Spaces to yourself |
| Removing other members |
| Changing a member's type |
| Viewing invites |
| Inviting users |
| Cancelling invites |
| Resending invites |
| Viewing and adding billing addresses |
| Viewing, creating and changing billing accounts |
| Viewing, buying and viewing usage of credits |
| Managing the subscription |
| Setting a Space's billing account |
| Managing Agents. See Agents — Permissions. |
| Managing devices and viewing the audit log. See Devices — Permissions. |
Seats
The plan sets how many seats the organisation has. Seat usage is shown on the Members and Invites tabs, in one of these forms:
Label | Meaning |
|---|---|
| A limited number of seats. |
| Seats are not limited. |
Each member uses a seat, and so does each pending invite. An Agent added as an organisation member also uses a seat. When every seat is used, the Invites tab shows Add seats, which opens billing, in place of Invite User, and invites fail with Seat limit reached (<used>/<limit>). Upgrade your plan or add seats to invite more members.
Invites
Invite User takes:
Field | Description |
|---|---|
The address to invite. Disposable email addresses are rejected. | |
Membership Type | Member or Owner. |
The invited user receives an email and sees the invite under Pending Invites on the Organisations page. An invite expires 7 days after it is sent. Resending it sends the email again and restarts the 7 days. Cancelling it frees its seat.
Spaces
An organisation's Spaces are listed on its Spaces tab.
- Join adds you to the Space as Admin - built-in. Leave removes you.
- Create Space creates a Space owned by the organisation. It takes a Title and an optional Parent Space.
- A Space you own can be moved into an organisation from Space Settings → Config → Transfers with Transfer to Organisation. Moving an organisation's Space back to you uses Transfer to User in the same place.
Removing Members and Organisations
Removing a member takes away their access to everything associated with the organisation. They keep access to resources they own or were granted by other means, such as Spaces they joined. Removal cannot be undone.
Remove Organisation removes, permanently:
- the organisation's Spaces;
- its members;
- its addresses and billing accounts;
- its Agents, together with their API keys.
API and CLI
Operation | REST | CLI |
|---|---|---|
List your organisations |
|
|
Get an organisation |
|
|
Create an organisation |
|
|
Remove an organisation |
|
|
Leave an organisation |
|
|
Change a member's type |
|
|
List your pending invites |
|
|
Accept an invite |
|
|
Decline an invite |
|
|
List the organisation's Spaces |
|
|
Join a Space |
|
|
Transfer a Space to the organisation |
|
|
Transfer a Space to yourself |
|
|
Set a Space's billing account |
|
|
Billing addresses, accounts and credits |
|
|
… is /api/v1/organisations/{organisationId}. CLI commands that act on a Space use the current Space, or --space <id>. Inviting users and removing members are available in Studio only. For every option, see Generated CLI commands — ligantic organisations.