Skip to main content
Get connected-account metadata

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

account_id
string
required

BoxRouter connected-account ID, scoped to this workspace.

Minimum string length: 1
Pattern: ^[^\u0000]*$

Response

Account metadata and current credential version.

id
string
required
name
string
required
provider
string
required
status
string
required

Known states are pending, enabled, invalid_credentials, credentials_rejected and unavailable. Pending is a legacy state for an account saved before provider approval. Enabled means hosted BYOK is approved and the provider did not reject the credentials when they were saved. invalid_credentials and unavailable remain readable for older records. credentials_rejected means a later provider call rejected the saved access; credential_failure gives a safe cause and the action needed to restore it.

settings
object
required

Non-secret credential fields saved with the credentials, named as in credential_fields. Legacy accounts may return an empty object. Secrets are never returned; credential_hints may return the last four characters and credential_prefixes only a declared public prefix.

credential_version
integer
required

Monotonic version. Contains no key material or key fingerprint; credential_hints and credential_prefixes may return only the last four characters and a declared public prefix, respectively.

Required range: x >= 1
credential_hints
object

Last four characters of saved secret credential fields that contain at least 12 characters. No other key material is returned.

credential_prefixes
object

Declared public prefixes for saved secret credential fields, returned only when the saved value starts with the declared prefix and at least eight characters remain hidden before the last four. No other key material is returned.

credential_failure
object | null

Present when a later provider call rejected the saved credentials or access.

standard_image
object
disconnect
object | null

A removal accepted with wait=false that is still running or was refused; null otherwise.

warnings
object[]

Notices about this connect. Present only on the response that created the account, and only when there is something to say.