{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Snapshot Access API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Snapshot Access", "type": "folder" }, "items": [ { "info": { "name": "Show Access", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/access", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).
**Example:** `startingorganizationg8tp8wu3`" }, { "name": "snapshotId", "value": "", "type": "path", "description": "The unique identifier of the target snapshot.
**Example:** `startingorganization-xzgbf5rdaiqtaznvh74zdwcedi`" }, { "name": "snapshotAccessType", "value": "", "type": "query", "description": "The resource access level to verify.
**Allowed values:**
- `READ`
- `WRITE`" } ] }, "docs": "Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the target snapshot.
**Required privilege:** `Snapshot - View`

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Show Resources Access", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/:snapshotId/access/resources", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).
**Example:** `startingorganizationg8tp8wu3`" }, { "name": "snapshotId", "value": "", "type": "path", "description": "The unique identifier of the target snapshot.
**Example:** `startingorganization-xzgbf5rdaiqtaznvh74zdwcedi`" }, { "name": "snapshotAccessType", "value": "", "type": "query", "description": "The resource access level to verify.
**Allowed values:**
- `READ`
- `WRITE`" } ] }, "docs": "Shows whether the authenticated user has the specified access level (i.e., read or write) to the content of the snapshot and returns a list of missing privileges.
**Required privilege:** `Snapshot - View`

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Show Resource Access", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/snapshots/access/resource", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the [organization](https://docs.coveo.com/en/185/).
**Example:** `startingorganizationg8tp8wu3`" } ] }, "docs": "Lists the resources that the authenticated user can leverage in snapshots in the target [organization](https://docs.coveo.com/en/185/).
**Required privilege:** `Snapshot - Edit`

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SNAPSHOTS\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" } ] } ], "bundled": true }