secrets

Propose which credentials a package uses: org default mappings (defaults), your own defaults (mine), per-trigger mapp...

Propose which credentials a package uses: org default mappings (defaults), your own defaults (mine), per-trigger mappings for your instance of a cron job, subscription, or webhook (triggers), and triggers to turn on with no mapping (enable). Never writes a mapping. Returns an approval URL to send to the person; nothing changes until they review it and click Approve, which applies every change at once and turns on every trigger it maps or enables. A webhook URL must be minted before it can be approved; minting alone does not turn it on. email.message.received and email.message.quarantined run only for a sender: pass sender (kind member, address, domain, or any_authenticated, and value except for any_authenticated) so the approval link names who it runs for. view.canApprove false lists what to fix first in view.changes[].error, view.enable[].error, and view.errors (unknown need or trigger, unminted webhook, missing or ambiguous credential with a createUrl, kind or provider mismatch, org defaults without package:write). Once the person approves, credentialTriggerPickSet can set those trigger picks again later. Needs package:execute on the package.

Org permission: none (touches no org data).

post/v1/credential-proposals

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/credential-proposals
  • Auth: HTTP bearer

Request body

packageIdstring

Saved-package UUID. Use when the scoped name is not known, or for a stable ref.

kodyIdstring

Package name (@owner/leaf or the name leaf). Prefer this when you know the name.

defaultsobject

Org default mappings, keyed by need key.

mineobject

Your own default mappings, keyed by need key.

reasonstring

Shown to the approver as an untrusted note.

Response

Success.

approvalUrlstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.