Skip to content

Revoke a federation share (aa:Unshare + audit, atomic)

DELETE
/admin/federation/shares/{id}

Marks revoked_at + emits aa:Unshare activity + writes federation.share.revoked audit event — atomically. Recipient’s local cache purges per design §4.2; their own derivative work (comments/annotations) is preserved per §4.3.

id
required
string format: uuid

Revoked.

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Share already revoked.

One federation_shares row per the 1.22.C design proposal. Pairing alone shares nothing; each row here is an explicit per-object grant.

object
id
required
string format: uuid
grantor_user_ref
required
integer format: int64
object_kind
required
string
Allowed values: asset post collection workspace brand_kit user
object_id
required
string format: uuid
peer_id
required
string format: uuid
target_user_url

NULL = broadcast within peer; non-null = specific user actor URL

string
nullable
scope
required
string
Allowed values: view comment annotate remix
expires_at
string format: date-time
nullable
notes
required
string
granted_activity_id
required
string format: uuid
granted_at
required
string format: date-time
revoked_at
string format: date-time
nullable
revoked_activity_id
string format: uuid
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time