This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Returns a list of access requirements a user needs in order to view a resource. Access requirements are composed of Organizations and Markings, and can either be applied directly to the resource or inherited.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:filesystem-read.
objectAccess requirements for a resource are composed of Markings and Organizations. Organizations are disjunctive, while Markings are conjunctive.
list<Organization>list<Marking>1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getAccessRequirements?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
{
"markings": [
{
"markingId": "18212f9a-0e63-4b79-96a0-aae04df23336"
}
],
"organizations": [
{
"organizationRid": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa",
"markingId": "18212f9a-0e63-4b79-96a0-aae04df23336"
}
]
}| Error Name | ||
|---|---|---|
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not getAccessRequirements the Resource. | |
| Parameters | resourceRid | |
See Errors for a general overview of errors in the platform.