FruxonDocs
IntegrationsConfigs

Withdraws a credential link, which stops working at once.

Whoever holds the link is told it was withdrawn and to ask for a new one. A fill already submitted is not undone; publish an earlier revision of the configuration for that.

POST
/v1/tenants/{tenant}/integrations/{integration}/configs/{config}/credentialRequests/{credentialRequest}:withdraw
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

config*string

The configuration ID.

Formatuuid
credentialRequest*string

The link's request ID.

Formatuuid
tenant*string

The tenant identifier

integration*string

The integration identifier

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string/configs/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentialRequests/497f6eca-6276-4993-bfeb-53cbbbba6f08:withdraw"
Empty
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Mints a link asking for the configuration's credentials.

The link is in the response once and never again; only its hash is kept. Minting another for the same configuration withdraws the open one. Refused (409 `not_linkable`) for a configuration each person connects with their own credentials and one that picks its credentials by request parameters. For a configuration that connects an account by signing in to its provider (OAuth), whoever opens the link signs in, granting the `scopes` asked for, and that account becomes the configuration's connection. A sign-in link (`requireSignIn: true`) takes `integrations:write`. A capability link, which anyone holding it can fill, takes `workspace:write` as well (403 `insufficient_scope` naming it without). Either stops working once its sender no longer holds what sending it took.

Deletes a configuration.

Rejected with 400 if any agent's <em>current</em> revision (or a participant / active trigger) still references this config via `TenantConfigId` — use the `/usage` endpoint to check first. With no live references, the config is hard-deleted (along with its revision history) when nothing references it at all, or <em>soft-deleted</em> when only a historical agent revision still pins it — the row is retained (and the credential severed from live use) so a revert can `:restore` it. Either way, every account a person connected under the config is deleted and its open connect links are cancelled; after a restore, people connect again when an agent next needs their account.