Disconnect specified organization from external account.
This will delete all the data associated with the connected account, including
payment methods, invoices, and subscriptions.
If the delete external account option is enabled it will also attempt to delete
the external account (e.g. Stripe Customer object).
WARNING: This can irreversibly destroy data and should be
used with extreme caution.
path parameters
organizationId
string
Required
The organization identifier.
body parameters
connectionId
string
Required
The identifier of the connection.
deleteExternalAccount
boolean
Whether to attempt to delete the external account and all it's associated data (e.g. Stripe Customer object).
Returns
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The connection type.
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
type
string
The provider type.
default
boolean
Whether the connection is the default for the provider type.
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
allowedEmails
string[]
The allowed email list.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.