Tenant

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/petpantry.shop/tenants/tenant_1",
  "$type": "Tenant",
  "placement": "path",
  "apiVersion": "v2"
}

RelationshipsCopy Anchor Link

• A Tenant admits many People: a Person joins a Customer’s Tenant as a member, and one Person can join many Tenants. admits, inverse joins.
• A Tenant has many API Keys: every call it signs reads and writes only that Customer’s records. apiKeys, inverse reaches.
• A Tenant’s hostnames are many Domains: a Tenant answers on the names its Customer connects; each such Domain serves one Tenant. hostnames, inverse serves.
• A Tenant is owned by one Customer: each Customer has one Tenant: the partition of the Startup’s data that no other Customer reads. ownedBy, inverse owns.
• A Tenant is provisioned by many Member Directories: a Member Directory fills and empties Roles in one Tenant as people join and leave the Customer. provisionedBy, inverse provisions.
• A Tenant signs in via many SSO Connections: a Tenant’s people sign in through its SSO Connections; the Customer’s admin owns each one. signsInVia, inverse serves.
• A Tenant verifies many Domains: a Tenant proves control of its Customer’s email domain, so sign-ins on that domain follow the Tenant’s policy. verifies, inverse verifiedBy.

VerbsCopy Anchor Link

1. createCreates a Tenant.
   POST /{namespace}/tenantsdoTenant.created
2. getReturns one Tenant by id.
   GET /{namespace}/tenants/{id}readNo Event
3. listReturns Tenants, newest first, one page at a time.
   GET /{namespace}/tenantsreadNo Event
4. updateChanges the given properties of a Tenant.
   PATCH /{namespace}/tenants/{id}doTenant.updated
5. deleteDeletes a Tenant; its history is kept.
   DELETE /{namespace}/tenants/{id}doTenant.deleted
6. inviteInvite asks a Person to join a Customer’s Tenant, and resizes the Subscription when the Offer prices per member.
   POST /{namespace}/tenants/{tenant}/invitedoTenant.invited
7. pinPin moves a Tenant’s keys to another API version, or to `latest`, once a call with its test key passes there.
   POST /{namespace}/tenants/{tenant}/pindoTenant.pinned
8. provisionProvision creates a Customer’s Tenant in a Startup’s App, holding that Customer’s records apart from every other.
   POST /{namespace}/tenants/provisiondoTenant.provisioned
9. requestSetupRequestSetup sends a Customer’s admin a link to connect their own sign-in, directory or verified domain to the Tenant.
   POST /{namespace}/tenants/{tenant}/requestSetupdoTenant.setupRequested

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Provision the latest tenant with a customer.

ExampleCopy Anchor Link

A recruiting agency's Tenant in a candidate-tracking SaaS holds its 40,000 candidates, its API keys, and its usage. No other Customer reads it.