Skip to main content
GET
Get a capability's provider binding readiness for an org unit
Returns a bindable capability’s (file_hosting, source_control, typed_judgments) provider binding for one org unit, as the Console’s organization binding editor shows it: the unit’s own binding (bindingProviderKey, absent when the unit has none of its own), each provider record of the domain with whether it is enabled, its connection target and whether an approved credential for that target is homed at this unit, and for typed_judgments the unit’s readiness. The unit’s binding is read by its exact key, however many units the domain binds. credentials:read is decided at the org unit: a grant at the platform, an ancestor or the unit itself. A unit outside your grants is 403. A missing domain or orgUnitId is 400; a missing org unit, or an unknown or non-bindable domain, is 404. No credential id, field or secret is returned.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

domain
string
required

A bindable capability domain.

Minimum string length: 1

Query Parameters

orgUnitId
string
required

The org unit whose binding to read.

Minimum string length: 1

Response

Binding readiness

data
object
required

A capability's provider binding for one org unit: the bound provider record (bindingProviderKey, absent when the unit has no binding of its own), each provider record of the domain with whether it is enabled, its connection target and whether an approved credential for that target is homed at this unit, and for typed_judgments the unit's readiness. No credential id, field or secret is returned.

meta
object
required