ApprovalRequests

Submit a response to an approval request

Changed on

Only a person may answer: a user token, a page session signed for a user, or the shared key with no agent identity (recorded as operator). The responder is taken from the credential. When the request lists approvers.users or approvers.roles, a user must match one of them. A rejection resolves the request at once; approvals resolve it when the any, all or { min: N } policy is met, and until then it stays pending with the answer recorded in approvals. A config question takes { action: "set", value }, { action: "keep" } (key must exist) or { action: "skip" } (optional questions only); set also needs the config write permission. The value is written only when the request is approved, and the stored answer is the result, never a secret value.

post/api/approval-requests/{id}/respond

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/approval-requests/{id}/respond
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Request body

responsesobject required
respondedBystring

Unverified display name. Stored as claimedRespondedBy on the answer; never used as the responder.

Response

Response recorded. status stays pending while the policy needs more approvals.

Changes

    • warning

      added the new config enum value to the /// response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the non-success response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status