account

put/v1/account/app

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/v1/account/app
  • Auth: none declared

Request body

namestring
apiUrlstring
uiUrlstring
webhookUrlstring
webhookEventFilterstring[]
webhookEnabledboolean
logostring
tenantSelfSignupboolean

Allow self signup (relates to cloud views, payment providers etc)

redirectUrisstring[]

Allowed redirect uris

allowedOriginsstring[]

Allowed origins for SDK mode (CORS + origin validation)

defaultCallbackUristring

Default handover/callback uri used by Nblocks

onboardingFlow'B2B' | 'B2C'
websiteUrlstring
privacyPolicyUrlstring
termsOfServiceUrlstring
emailSenderNamestring
emailSenderEmailstring
paymentsAutoRedirectboolean
passkeysEnabledboolean
stripeEnabledboolean
currencystring
mfaEnabledboolean
magicLinkEnabledboolean
googleSsoEnabledboolean
linkedinSsoEnabledboolean
azureAdSsoEnabledboolean
appleSsoEnabledboolean
githubSsoEnabledboolean
facebookSsoEnabledboolean
azureMarketplaceEnabledboolean
accessTokenTTLnumber
refreshTokenTTLnumber
allowedTokenPrivilegesstring[] nullable

Controls which privileges workspace users (OWNER/ADMIN) can grant on workspace-scoped API tokens. null = flexible (no restriction). [] = disabled. ['USER_READ', ...] = restricted to list.

Response

idstring required

Unique ID (Read only)

namestring required

Name of the app

domainstring required

Unique domain name of the app (Read only)

apiUrlstring required

URL to your api (to receive webhooks etc). Must be HTTPS

uiUrlstring required

URL to your frontend app (for onboarding redirects etc). Must be HTTPS

logostring required

URL to your logo

websiteUrlstring required

URL to your website or landing page. E.g. Branded emails will link to this URL, checkout process will redirect to /payment-success and /payment-cancel

webhookUrlstring required

Events like tenant and user updates will be sent to this webhook url

privacyPolicyUrlstring required

URL to a page on your website containing a Privacy policy for your app users. E.g. checkout process will link to this url.

termsOfServiceUrlstring required

URL to a page on your website containing a Terms of service for your app users. E.g. checkout process will link to this url.

emailSenderNamestring

Emails sent from Nblocks will have this sender name

emailSenderEmailstring

Emails sent from Nblocks will have this sender email. You'll have to verify this email before

paymentsAutoRedirectboolean required
stripeEnabledboolean required

Boolean value telling the user if Stripe is enabled

stripeSetupStatus'completed' | 'pending' | 'failed'

Status of Stripe setup process

stripeSetupErrorstring nullable

Error message if Stripe setup failed

stripeLastWebhookAtstring date-time nullable

Last time a Stripe webhook event was received and verified. Null means none has been verified yet.

stripeLastWebhookRejectedAtstring date-time nullable

Last time a Stripe webhook event was rejected

stripeLastWebhookRejectionReasonstring nullable

Why the last Stripe webhook event was rejected: no_signing_secret, signature_mismatch or raw_body_missing

stripeWebhookRejectionStreaknumber

Rejected Stripe webhook events since the last verified one, counted at most once per minute. 3 or more means events are being rejected persistently.

allowedTokenPrivilegesstring[] nullable

Allowed privileges for API tokens

passkeysEnabledboolean required

Boolean value telling the user if passkeys login is enabled

mfaEnabledboolean required

Boolean value telling the user if MFA is enabled

magicLinkEnabledboolean required

Boolean value telling the user if Login with Magic Link is enabled

googleSsoEnabledboolean required

Boolean value telling the user if Google Social login / SSO is enabled

linkedinSsoEnabledboolean required

Boolean value telling the user if LinkedIn Social login / SSO is enabled

azureAdSsoEnabledboolean required

Boolean value telling the user if Azure AD SSO is enabled

azureMarketplaceEnabledboolean required

Boolean value telling the user if Azure marketplace is enabled

appleSsoEnabledboolean required

Boolean value telling the user if Apple Social login / SSO is enable

githubSsoEnabledboolean required

Boolean value telling the user if Github Social login / SSO is enable

facebookSsoEnabledboolean required

Boolean value telling the user if Facebook Social login / SSO is enable

onboardingFlow'B2B' | 'B2C' required

Configure how users will be onboarded

tenantSelfSignupboolean required

Allow self signup (relates to cloud views, payment providers etc)

redirectUrisstring[] required

Allowed redirect uris

allowedOriginsstring[] required

Allowed origins for SDK mode (CORS + origin validation)

defaultCallbackUristring required

Default handover/callback uri used by Nblocks

accessTokenTTLnumber required

TTL for access token, default 1 hour

refreshTokenTTLnumber required

TTL for refresh token, default 1 week

Changes

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