Resource Shares
Organization resource sharing endpoints
List shared resources
Required Permissions:
resource_sharing:read
List the resources this organization has shared with its child organizations, one entry per resource with its aggregated share summary and metadata. Owner view only.
path Parameters
organization_idOwner organization ID
query Parameters
limitPage size (default: 10)
offsetOffset (default: 0)
resource_typeFilter by resource type
List shared resources › Responses
Page of shared resources
List a resource's shares
Required Permissions:
resource_sharing:read
List every per-child share of one resource, each annotated with whether the target organization is using it (in_use), plus whether the resource's policy auto-shares it with new children.
path Parameters
organization_idOwner organization ID
resource_typeResource type
resource_idResource ID
List a resource's shares › Responses
The resource's shares
The shares of a single resource, each with its usage flag.
share_with_all_new_childrenWhether the resource's policy auto-shares it with new direct children.
Share a resource
Required Permissions:
resource_sharing:write
Start sharing one resource with child organizations. The flat body takes two additive create inputs (share_organization_ids and/or all_current_children), may carry revoke_organization_ids, and may toggle the resource's auto-share policy via share_with_all_new_children (omit = unchanged, true = enable, false = disable). Re-sharing existing targets is idempotent.
path Parameters
organization_idOwner organization ID
resource_typeResource type
resource_idResource ID
Share a resource › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Share a resource › Responses
Created and revoked shares
Shares newly created by the request.
Shares revoked (deleted) by the request.
share_with_all_new_childrenThe resource's auto-share policy state after the request.
SkippedInUse holds shares a revoke_all_not_in_use request deliberately left in place because the target org is still using the resource. Empty for every other request shape.
Unshare a resource
Required Permissions:
resource_sharing:write
Remove every per-child share of one resource and its share policy in a single transaction, returning the revoked set. Rejected with 409 if any current target organization is actively using the resource.
path Parameters
organization_idOwner organization ID
resource_typeResource type
resource_idResource ID
Unshare a resource › Responses
The revoked shares
Shares newly created by the request.
Shares revoked (deleted) by the request.
share_with_all_new_childrenThe resource's auto-share policy state after the request.
SkippedInUse holds shares a revoke_all_not_in_use request deliberately left in place because the target org is still using the resource. Empty for every other request shape.
Update a resource's shares
Required Permissions:
resource_sharing:write
Apply per-child share additions and revocations to one resource in a single transaction, returning the before/after diff. Revoking a named share (revoke_organization_ids) that the target organization is actively using is rejected with 409. Set revoke_all_not_in_use to instead revoke every current share the target is NOT using and leave the in-use ones in place (returned in skipped_in_use).
path Parameters
organization_idOwner organization ID
resource_typeResource type
resource_idResource ID
Update a resource's shares › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Update a resource's shares › Responses
Created and revoked shares
Shares newly created by the request.
Shares revoked (deleted) by the request.
share_with_all_new_childrenThe resource's auto-share policy state after the request.
SkippedInUse holds shares a revoke_all_not_in_use request deliberately left in place because the target org is still using the resource. Empty for every other request shape.
List a resource's share targets (all direct child orgs)
Required Permissions:
resource_sharing:read
List every direct child organization of the owner for one resource, each annotated with whether the resource is shared to it (and whether the child is using it). Backs the share UI's per-team shared/not-shared toggles. Filterable by name and share state; sortable (shared-first by default, or by name); paginated.
path Parameters
organization_idOwner organization ID
resource_typeResource type
resource_idResource ID
query Parameters
searchCase-insensitive substring filter on child org name, slug, or id
sharedFilter by share state: true = only shared, false = only not shared
sort_byColumn to sort by; default puts shared rows first
orderSort direction (used with sort_by)
limitPage size
offsetRows to skip
List a resource's share targets (all direct child orgs) › Responses
Direct child orgs annotated with share state
The page of child orgs.
Pagination metadata.
share_with_all_new_childrenWhether the resource's policy auto-shares it with new direct children.
List a shared resource's consumers in other orgs
Required Permissions:
resource_sharing:read
List, paginated, everywhere a shared secret or component owned by this org is consumed by OTHER (child) organizations — the remediation view. For a secret, consumers are the child-org components referencing it; for a component, the child-org pipelines binding it. Each row carries the child org and the consuming resource; rows are ordered so an org's usages are contiguous.
path Parameters
organization_idOwner organization ID
resource_typeResource type
resource_idResource ID
query Parameters
limitPage size
offsetRows to skip
List a shared resource's consumers in other orgs › Responses
Cross-org consumers of the shared resource
Pagination metadata.