foliot docs

API reference / Apps / Reveal the signing secret

Reveal the signing secret

POST/apps/{appId}/signing-secret/reveal

Authenticate with an operator token or an app API key or a signed-in Foliot Console session.

The ONLY path by which a signing secret leaves the server, and every use is recorded before the value is returned (if the record cannot be written, nothing is revealed). The app’s own key, an operator token, or a signed-in person who is an owner of the app’s workspace; the person is recorded as the actor by their own identity. A POST rather than a GET for two reasons: the reason belongs in a body rather than a query string that lands in access logs, and a read that writes an audit row is not a safe method.

Path parameters

appId
string
REQUIRED

The app's name.

Request body

reason
string
REQUIRED

Why. Required, and recorded.

min length 8 · max length 1000

Responses

200 object OK
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
503 Error A dependency this route needs is unreachable.