List federation shares

GET

/admin/federation/shares

• Local development behind nginx (port 8088 by default)

Mutually-exclusive filter via query params:

• object_kind+object_id: “who has access to this object?”
• peer_id: “what am I sharing with this peer?”
• grantor_user_ref: “what shares did this user grant?” Returns only ACTIVE shares. Gated on system.admin.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Query Parameters

object_kind

string

Allowed values: asset post collection workspace brand_kit user

object_id

string format: uuid

peer_id

string format: uuid

grantor_user_ref

integer format: int64

limit

integer

default: 100 >= 1 <= 500

Responses

200

Active shares matching the filter.

object

items

required

Array<object>

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

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

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"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed