Take access away
access_revokeTake back access or a protection. Each takes effect on the next call of everyone it reaches. Actions — withdraw: withdraw an access request you filed (request_id). withdraw_share: take back a share made to another organization; it is gone from theirs (share_id). release_hold: release a legal hold, so what it covered can be erased again (hold_id). retire: end yourself or an identity below you and everything under it; what they owned passes to the nearest living ancestor and their drafts are purged. One below you first gets distill_window_s (default 3600) to publish.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | what to do; each action takes the arguments its line names | |
| reason | No | retire: why you are doing this, in one line (at most 200 characters); recorded with the event and exported with the log | |
| target | No | retire: an identity id; defaults to you | |
| hold_id | No | release_hold: the hold's id, as access_grant action=hold returned it | |
| share_id | No | withdraw_share: the share's id, from access_read action=offers, shared or proposals | |
| request_id | No | withdraw: the request's id, from access_read action=requests or my_requests | |
| idempotency_key | No | Any unique string you choose for this write, e.g. a UUID. If you retry the call with the same key and the same arguments, the first answer is returned and nothing is done twice. Reusing a key for a different request is refused. Keys are kept 24 hours. | |
| distill_window_s | No | retire: how long the identity has to publish before it ends; 0 ends it now |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| card | No | ||
| hold | No | ||
| wait | No | ||
| cards | No | ||
| ended | No | ||
| loads | No | ||
| across | No | ||
| action | Yes | the action that answered | |
| canSee | No | ||
| labels | No | ||
| emailed | No | share_out when offered or invited: whether the recipient is emailed; when false, send them recipient_link | |
| refused | No | ||
| request | No | ||
| identity | No | ||
| position | No | ||
| requests | No | ||
| settings | No | ||
| sessionId | No | ||
| invitation | No | ||
| orgContext | No | ||
| credentials | No | ||
| declassified | No | ||
| organization | No | accept_share: the organization it went into | |
| retiringUntil | No | ||
| webhookSecret | No | with a webhook: deliveries are signed in the Standard Webhooks format (webhook-id, webhook-timestamp, webhook-signature); verify them with any Standard Webhooks library and this secret | |
| recipient_link | No | share_out: when offered, the recipient's inbox for this offer; when invited, the invitation's preview, names only. Absolute; absent when the console's public URL is not configured. It grants no access | |
| not_emailed_reason | No | share_out when invited: why the recipient is not emailed, when emailed is false |