Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarTenant

Tenant routes: invite, pin, provision, requestSetup

The Tenant Verbs invite, pin, provision, requestSetup as api.sb routes, with inputs, result, refusals and an example.

Reference for Tenant, one group of Tenant routes.

Tenant.invite

Invite asks a Person to join a Customer’s Tenant, and resizes the Subscription when the Offer prices per member. Verb page.

Text
POST /{namespace}/tenants/{tenant}/invite

Path: tenant. Body, as JSON: the other inputs. Emits Tenant.invited.

Inputs

InputTypeRequiredDescription
tenantTenantrequiredThe Customer’s Tenant.
emailemailrequiredWhere the invitation goes.

Returns

OutputTypeRequiredDescription
personPersonrequiredThe invited Person.
tenantTenantrequiredThe Tenant the Person was invited to.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/tenants/ten_Bu63f0he26/invite \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"dana@leaseline.app"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "person": {
    "$id": "https://api.sb/leaseline.app/people/person_oJZMe5UtCH",
    "$type": "Person",
    "name": "Dana Okafor"
  },
  "tenant": {
    "$id": "https://api.sb/leaseline.app/tenants/ten_Bu63f0he26",
    "$type": "Tenant",
    "placement": "path",
    "apiVersion": "v2"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Tenant.invite",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Tenant.pin

Pin moves a Tenant’s keys to another API version, or to latest, once a call with its test key passes there. Verb page.

Text
POST /{namespace}/tenants/{tenant}/pin

Path: tenant. Body, as JSON: the other inputs. Emits Tenant.pinned.

Inputs

InputTypeRequiredDescription
tenantTenantrequiredThe Tenant whose keys move.
apiVersionstringrequiredThe version to answer at, such as v2, or latest to track the newest.

Returns

OutputTypeRequiredDescription
tenantTenantrequiredThe Tenant, answering at its new version.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
Until a call with the Tenant’s test key succeeds at the target versionrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/tenants/ten_Bu63f0he26/pin \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"apiVersion":"v2"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "tenant": {
    "$id": "https://api.sb/leaseline.app/tenants/ten_Bu63f0he26",
    "$type": "Tenant",
    "placement": "path",
    "apiVersion": "v2"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Tenant.pin",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Tenant.provision

Provision creates a Customer’s Tenant in a Startup’s App, holding that Customer’s records apart from every other. Verb page.

Text
POST /{namespace}/tenants/provision

Body, as JSON: the inputs. Emits Tenant.provisioned.

Inputs

InputTypeRequiredDescription
customerCustomerrequiredThe Customer the Tenant serves.

Returns

OutputTypeRequiredDescription
tenantTenantrequiredThe new Tenant.

Refuses when

CheckErrorFixThen call
The operation is part of an Offer the caller has not accepted or paid for.payment-requiredAccept the Offer named in the response, then retry the call.Offer.accept
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/tenants/provision \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer":"cus_K1BROJhqzZ"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "tenant": {
    "$id": "https://api.sb/leaseline.app/tenants/ten_Bu63f0he26",
    "$type": "Tenant",
    "placement": "path",
    "apiVersion": "v2"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Tenant.provision",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Tenant.requestSetup

RequestSetup sends a Customer’s admin a link to connect their own sign-in, directory or verified domain to the Tenant. Verb page.

Text
POST /{namespace}/tenants/{tenant}/requestSetup

Path: tenant. Body, as JSON: the other inputs. Emits Tenant.setupRequested.

Inputs

InputTypeRequiredDescription
tenantTenantrequiredThe Tenant to set up.
adminPersonrequiredThe Customer’s admin who receives the link.
intentstringrequiredWhat the link sets up.

Returns

OutputTypeRequiredDescription
linkurlrequiredThe single-use setup link, valid for 7 days.
tenantTenantrequiredThe Tenant being set up.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/tenants/ten_Bu63f0he26/requestSetup \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"admin":"person_sLqbXbW683","intent":"sso"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "link": "https://leaseline.app",
  "tenant": {
    "$id": "https://api.sb/leaseline.app/tenants/ten_Bu63f0he26",
    "$type": "Tenant",
    "placement": "path",
    "apiVersion": "v2"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Tenant.requestSetup",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Thing

Next