Teams and companies

A consumer team is the group a developer works in. It owns the subscriptions, their credentials, the members, and any prepaid credits. A company is a separate, optional layer that groups email domains and routes sign-in for them. Teams are always on. Company mode you turn on when you need it.

What is a consumer team in Apiable?

A team is the group a developer works in, and every subscription belongs to a team. A team holds members, subscriptions and their credentials, and a prepaid credit balance. A single developer still works inside a team. You manage teams under Consumers, Teams.

The list shows each team's name, whether it is Internal, its # of members, and its created and edited dates, plus its company when company mode is on. Filter it by internal or external teams. An internal team's members can see products whose audience is set to Internal.

To create a team yourself, click + Create Team, enter a Name, set Internal if it applies, pick a Company when company mode is on, and click Create Team. Creating and editing teams needs the Organisation Owner, or the Organisation Admin or Portal Admin role.

What tabs does a team have?

Open a team to reach its detail page. It carries the team name, an Internal team toggle, and five tabs.

The Credits tab is greyed out when your Apiable plan includes prepaid billing but no payment provider is connected. See Connect Stripe.

How do consumers join a team?

Someone adds them or invites them. On the team's Users tab, + Add User adds developers who already have a portal account, and + Invite User sends an email invitation. Team members with Full team access can also invite from the API Portal.

Both + Add User and + Invite User set a role and per-area access:

Each area, Team, API Keys and Billing, is set to None, Read-only, or Full. The developer-side view of the same roles is in Teams.

How does domain joining work?

Nothing joins a team automatically. When a new developer signs up with an email on one of a team's domains, and that team has domain joining on, sign-up offers the team once with a Join team button. The developer who joins becomes an Admin of that team.

• The offer appears in the Join your team step of API Portal sign-up. It lists every team whose domains match the developer's email domain and that has domain joining on.
• Developers who already have an account are not offered teams by domain.
• Whoever joins this way gets the Admin role: Full access to the team's members, API keys, and billing, including the credentials on its subscriptions.
• Joining matches the team's own domains. A company's domains do not add anyone to a team.

Domain joining has two switches:

1. Portal-wide. Under Settings, Portal settings, Portal details, the Team domain joining block has Enable team domain joining. It turns on the domain settings on teams and the join step at sign-up. Prevent users from creating their own team when domain joining is available removes the option to create a new team when the sign-up offers one.
2. Per team. On the team's Settings tab, Team domains lists the Associated Domains, lets you add or remove a domain, and has the Enable domain joining toggle.

Domain joining on a team has no effect until the team has at least one domain.

How do domains end up on a team?

Domains reach a team's Associated Domains in three ways. Only the first one is under your direct control.

How do team credits work?

Team credits are a prepaid balance held against a team. You add credit from the Credits tab in two ways, and the team draws the balance down on prepaid plans. You can void a credit line.

1. Choose a currency and an amount. The minimum is 10. The currency is fixed once the team has an active credit.
2. Click Grant credits for {amount} {currency} to add the credit at once, or pick the team member responsible for the invoice and click Create Invoice for {amount} {currency}. The invoice opens in a new tab, and its credit stays pending until it is paid.

Each credit line shows its amount, type, invoice number, created date, status, and expiry. A credit is Active, Pending, or Void. Void on a line cancels it after a confirmation. Voided and fully spent lines are hidden unless you turn on Show voided and spent credits. Credits total shows the amount of credit left per currency.

What is company mode?

Company mode groups email domains into companies. Each company can route sign-in for its domains to an identity provider, and new sign-ups on a company's domain are linked to that company. Company mode is off until you turn it on.

To turn it on, open Settings, Portal settings, Portal details, find Additional portal registration fields, switch on Company, and click Save changes. The Companies page then appears under Consumers. While company mode is off, a company page reports "Company feature is disabled."

The Companies page lists your companies with their name and domains. Open a company to reach its detail page:

The Identity Provider routes sign-in for the company's domains to that provider. A domain can belong to only one company. Removing a domain asks for confirmation, because it can change sign-in routing for everyone on that domain.

You create a company with Create & Assign Company on a team's Settings tab, or when you create a team. With company mode on, sign-up also creates one when a new developer's email domain has no company yet. See Identity Providers for how routing to a provider works.

How do teams and companies connect?

A team can be linked to one company. When company mode is on, the team's Settings tab shows Company Association, where you pick an existing company or use Create & Assign Company.

Every domain on a linked team is also added to the company's domains, unless another company already has it. The copy goes one way: removing a domain from the team leaves it on the company. The company's domains route sign-in and link new sign-ups to the company. Domain joining still uses only the team's own domains.

Troubleshooting

Where to next