Teams and companies

A consumer team is the group a developer works in. It owns the subscriptions, API keys, members, and prepaid credits. A company is a separate, optional layer that maps email domains to identity routing and team joining. 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, API keys, and a prepaid credit balance. A single developer still works inside a team. You manage teams under Consumer Teams.

A team is either Internal or external. The Consumer Teams list shows each team's name, whether it is internal, and a Consumers count of its members. You filter the list by Internal or External.

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 disabled unless your account uses the prepaid burn-down revenue model and a payment provider is connected.

How do consumers join a team?

A team member either adds an existing portal user or sends an email invitation. On the team's Users tab, + Add User adds a developer who already has a portal account, and + Invite User sends an email invitation. When domain joining is on, matching developers can also join on their own.

An invitation assigns a role and per-area access:

Each invitation sets the access level for Teams, API keys, and Billing independently, at None, Read-only, or Full.

How does domain auto-join work?

When domain joining is enabled, a developer who signs in with an email on one of a team's associated domains can join that team automatically. You manage this on the team's Settings tab, under Associated Domains with the Enable domain joining toggle.

Two rules come from the backend:

• A team must have at least one associated domain before domain joining can be enabled.
• Free email domains, such as the common consumer mail providers, are rejected and cannot be used for domain joining.

The domain-joining settings appear only when the team-domains feature is enabled for your portal. When neither domain joining nor company association is enabled, the Settings tab reports that no settings are available.

How do team credits work?

Team credits are a prepaid balance held against a team. You add to the balance in two ways from the Credits tab: Grant credits, which adds an amount directly, or Create Invoice, which bills a team member for the amount. The team draws down the balance as it uses paid APIs.

Each credit line shows its amount, type, invoice number, created date, status, and expiry. A credit is Active, Pending, or Void. A granted credit is active right away. An invoiced credit stays pending until the invoice is paid. A running total shows the remaining balance per currency.

What is Company mode?

Company mode maps email domains to a company, and the company carries an identity provider for SSO routing. It groups domains so users who sign in with those domains route to the right provider and join the right teams. Company mode is off by default.

When company mode is on, the Company page lists your companies by name and domains. Open a company to reach its detail page, which has two tabs:

On the Details tab, the Identity Provider field routes users from this company's domains to the selected provider for sign-in. The domains section lists the company's email domains, and a domain can belong to only one company.

How do teams and companies connect?

A team can be associated with one company. When company mode is on, a team's Settings tab shows a Company association section where you select an existing company or create and assign a new one. The company's domains then back the team's domain-based joining.

Where to next