account

post/account/tenant

Request

  • Base URL: https://api.thebridge.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebridge.dev/account/tenant
  • Auth: none declared

Request body

planstring

The plan must be present in the configured App business model

priceOfferPriceOffer
namestring

Name of the new tenant. Can also be set by tenant owner during onboarding

onboardedboolean

Is the tenant considered onboarded from start?

logostring

A url to a logo. Can also be set by tenant owner during onboarding

localestring

The default locale / lang code for all users in this tenant (ISO_639-1 format). This property will set the i18n for all platform emails and can be used to. Defaults to 'en'

metadataobject

Store metadata for your own business logic that will be returned in every Tenant response. This data will never be outputted to the end user

authOriginUrlstring

Origin URL of the caller — used to resolve where email links (e.g. password reset) should point

signupMethodstring

TBP-505 — how the tenant owner signed up (e.g. 'google', 'ms-azure-ad', 'linkedin'). Set ONLY by the federation signup path so account can fire the SignUp/Lead conversion tracking server-side — SSO signups never pass through the client-side signup page that fires them for email signups. Deliberately NOT in the import allowlist (TBP-43): imports must not fire conversion events.

Response

idstring required

Logical id reference to this instance

planstring

Name of the subscription plan. (Read only) Use setPlanDetails to change it Automatically set by the payment service if tenant used the checkout process

mfaboolean required

MFA enabled

paymentStatusobject required

Payment status

trialboolean required

Tenant is trialing (Read only)

localestring required

The default locale / lang code for all users in this tenant (ISO_639-1 format). This property will set the i18n for all platform emails and can be used to

namestring

Name of the tenant. Undefined from the begining until the Tenant owner complets tenant onboarding.

logostring

Url to a public accessible logo

metadataobject required

Store app specific meta data for this tenant

onboardedboolean required

If this tenant is considered onboarded

federationConnectionstring

Logins are made with this enterprise login connection

createdAtstring date-time required

Timestamp when created

Changes

No recorded changes to this operation across all 1 revision of this API.