account

get/account/tenant/byId/{id}

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/byId/{id}
  • Auth: none declared

Path parameters

idstring required

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.