List the grants (shares) on a resource

View as Markdown
Lists the role grants on a single resource — who it is shared with. Authorization: org admin, or the caller holds the resource’s share permission on the target (`space:share`/`spacetype:share`; `settings` is admin-only); otherwise 403 `forbidden`. Query: `resourceType` (`space` | `spacetype` | `settings`) and `externalId` (required); optional `assignment` = `direct` | `indirect` filters to directly-assigned vs inherited grants. Returns the resource’s grants.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

resourceTypeenumRequired
Allowed values:
externalIdstringRequired>=1 character
assignmentenumOptional
Allowed values:

Response

The subjects and roles granted on the resource.
assignmentenum
roleAssignmentslist of objects
membershipslist of maps from strings to any
The memberships behind the assignments, for rendering a share list.

Errors

403
Forbidden Error