{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Temporary 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": "Temporary Access", "type": "folder" }, "items": [ { "info": { "name": "List Temporary Accesses for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/users/:username/access/temporary", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to list temporary access.
**Example:** `jsmith@email.com-google`" } ] }, "docs": "Lists the temporary accesses for the current user." }, { "info": { "name": "Show Temporary Access for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/users/:username/access/temporary/:temporaryAccessId", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to show a temporary access.
**Example:** `jsmith@email.com-google`" }, { "name": "temporaryAccessId", "value": "", "type": "path", "description": "The unique identifier of the temporary access to show.
**Example:** `wrm4yyygma4dga6zouiqcaknv4`" } ] }, "docs": "Shows a temporary access for the current user." }, { "info": { "name": "Revoke Temporary Access for Current User", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/users/:username/access/temporary/:temporaryAccessId", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to revoke a temporary access.
**Example:** `jsmith@email.com-google`" }, { "name": "temporaryAccessId", "value": "", "type": "path", "description": "The unique identifier of the temporary access to revoke.
**Example:** `0378a782-ca90-11e9-a32f-2a2ae2dbcce4`" } ] }, "docs": "Revokes temporary access for a user to an organization." }, { "info": { "name": "List Expired and Revoked Temporary Accesses for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/users/:username/access/temporary/inactive", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to list expired and revoked temporary accesses.
**Example:** `jsmith@email.com-google`" } ] }, "docs": "Lists the expired and revoked temporary accesses for the current user." }, { "info": { "name": "List Expired Temporary Accesses for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/users/:username/access/temporary/expired", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to list expired temporary accesses.
**Example:** `jsmith@email.com-google`" } ] }, "docs": "List the expired temporary accesses for the current user." }, { "info": { "name": "List Active Temporary Accesses for Current User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/users/:username/access/temporary/active", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to list active temporary accesses.
**Example:** `jsmith@email.com-google`" } ] }, "docs": "Lists the active temporary accesses for the current user." }, { "info": { "name": "List Temporary Accesses", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/temporary", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to list temporary accesses.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "docs": "Lists the temporary accesses in an [organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"TEMPORARY_ACCESS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Show Temporary Access", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/temporary/:temporaryAccessId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "temporaryAccessId", "value": "", "type": "path", "description": "The unique identifier of the temporary access to show.
**Example:** `wrm4yyygma4dga6zouiqcaknv4`" } ] }, "docs": "Shows a temporary access in an [organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"TEMPORARY_ACCESS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Revoke Temporary Access", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/temporary/:temporaryAccessId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "temporaryAccessId", "value": "", "type": "path", "description": "The unique identifier of the temporary access to revoke.
**Example:** `0378a782-ca90-11e9-a32f-2a2ae2dbcce4`" } ] }, "docs": "Revokes a temporary access in an [organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"TEMPORARY_ACCESS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "List User Temporary Accesses", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/temporary/users/:username", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" }, { "name": "username", "value": "", "type": "path", "description": "The username of the user for which to list temporary access.
**Example:** `jsmith@email.com-google`" } ] }, "docs": "Lists user temporary accesses in an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** Temporary access - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"TEMPORARY_ACCESS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "List Expired Temporary Accesses", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/temporary/expired", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to list expired temporary accesses.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "docs": "List expired temporary accesses in an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** Temporary access - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"TEMPORARY_ACCESS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "List Active Temporary Accesses", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/temporary/active", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to list active temporary accesses.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "docs": "List active temporary accesses in an organization.

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