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>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json OrgProviderCredentialDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/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
| Status | Description | Body |
|---|---|---|
| 201 | application/json OrgProviderCredentialDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/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>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
providerKey | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/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>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
providerKey | path | string | yes |
Request body: application/json RotateOrgProviderCredentialDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json OrgProviderCredentialDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |