FruxonDocs
IntegrationsConfigs

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.

POST
/v1/tenants/{tenant}/integrations/{integration}/configs/{config}/credentialRequests

Authorization

Bearer
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
tenant*string

The tenant identifier

integration*string

The integration identifier

Request Body

Who it is for, a note, and how long it works.

intendedForEmail?string|null

Who the link is for, for the open-links list. Never checked.

note?string|null

A note to whoever fills it, shown above the form.

ttlHours?integer|null

How long the link works, in hours: 1 to 720, 168 when unset.

Formatint32
requireSignIn?boolean

Open only for a signed-in member of the workspace, who fills it as themselves and needs a role that may set up integrations; a member without one declines it by opening it. For a colleague with a Fruxon login rather than someone outside. Sending one takes integrations:write; sending a link anyone can fill (false) takes workspace:write as well.

scopes?|null

For a configuration that connects an account by signing in to its provider (OAuth): the scopes whoever fills the link is asked to grant, out of the auth method's catalog. Its recommended scopes when unset. Refused for a credential that is typed in.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string/configs/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentialRequests" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "url": "string",
  "intendedForEmail": "string",
  "note": "string",
  "mode": "CAPABILITY",
  "issuedByUserId": "string",
  "issuedByName": "string",
  "issuedByAgentId": "string",
  "issuedByAgentName": "string",
  "target": "INTEGRATION",
  "status": "OPEN",
  "expiresAt": 0,
  "closedAt": 0,
  "createdAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Lists the configuration's open credential links.

Newest first. The links themselves are never listed: each was shown once, when it was minted. A link that was filled, withdrawn, superseded or ran out is not open and is not listed.

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.