Create tenants and manage membership. Everything else in the API is tenant-scoped, so this is usually the first call after auth. Bearer required.
import { GatekeeperCore, TenantsService } from '@orkait/sdk';
const tenants = new TenantsService(core, { defaultRole: 'member' });Config#
| Option | Default | Effect |
|---|---|---|
defaultRole | 'member' | role used by addMember when none is passed |
Methods#
| Method | Returns | Notes |
|---|---|---|
create(name) | Tenant | caller becomes owner |
list() | Page<TenantMembership> | tenants the caller belongs to + role |
addMember(tenantId, userId, role?) | void | owner/admin only; role falls back to defaultRole |
listMembers(tenantId) | Page<TenantMember> | caller must be a member |
Example#
const tenant = await tenants.create('Acme');
await tenants.addMember(tenant.id, 'usr_123', 'admin');
const members = await tenants.listMembers(tenant.id);