Org - Provider Credentials

Operations of the Connector Gateway API. Paths are relative to your deployment's API host.

GET /api/connector-gateway-api/org/provider-credentials

List every provider that permits an ORG app-credential override, with its form schema + whether this org has its own provision configured.

Authentication: bearer token (Authorization: Bearer <token>)

StatusDescriptionBody
200application/json OrgProviderCredentialDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/connector-gateway-api/org/provider-credentials

Create or replace THIS org's app credential for a provider (custody-backed). Fail-fast when the provider does not permit org overrides.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateOrgProviderCredentialDto

StatusDescriptionBody
201application/json OrgProviderCredentialDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/connector-gateway-api/org/provider-credentials/{providerKey}

Revoke this org's provider app credential — the org falls back to the platform default.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
providerKeypathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/connector-gateway-api/org/provider-credentials/{providerKey}/rotate

Rotate the secret behind this org's provider app credential.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
providerKeypathstringyes

Request body: application/json RotateOrgProviderCredentialDto

StatusDescriptionBody
200application/json OrgProviderCredentialDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto