FruxonDocs
ApiSecrets

Mints a link asking for the secret's value.

The link is in the response once and never again; only its hash is kept. Minting another for the same secret withdraws the open one. A secret has nothing to test its value against, so the value is published as typed. A sign-in link (`requireSignIn: true`) takes `secrets:write`. A capability link, which anyone holding it can fill, takes `workspace:write` as well (403 `insufficient_scope` naming it without).

POST
/v1/tenants/{tenant}/secrets/{secret}/credentialRequests

Authorization

Bearer
AuthorizationBearer <token>

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

In: header

Path Parameters

secret*string

The secret ID.

Formatuuid
tenant*string

The tenant 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/secrets/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
}