Skip to main content
POST
Create a Connected Apps connection

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

provider_key
string
required

Provider key. Validation: required, string, max:64.

Maximum string length: 64
Example:

"Provider Key"

connection_name
string | null

Connection name. Validation: nullable, string, max:255.

Maximum string length: 255
Example:

"Connection Name"

scope
enum<string> | null

Scope. Validation: nullable; allowed values: workspace, user.

Available options:
workspace,
user,
null
Example:

"workspace"

provider_account_id
string | null

Provider account id. Validation: nullable, string, max:191.

Maximum string length: 191
Example:

"Provider Account Id"

provider_tenant_id
string | null

Provider tenant id. Validation: nullable, string, max:191.

Maximum string length: 191
Example:

"Provider Tenant Id"

encrypted_credentials

Provider-specific encrypted credentials fields; use provider metadata/configuration for supported keys.

settings_json

Provider-specific settings fields; use provider metadata/configuration for supported keys.

target_context_json

Provider-specific target context fields; use provider metadata/configuration for supported keys.

Response

Operation result.

status
string
Example:

"success"

data
object

Allowlisted connection projection. List/show service retrieval bounds detailed related collections at ten; new/updated records can lazy-load their related collections. last_synced_at reflects actual data runs for Bloomerang.