{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities Organization 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": "Organization Access",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Groups with Privilege Access Level",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/groups",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "privilegeOwner",
"value": "",
"type": "query",
"description": "The `owner` value the groups privileges must match to be included in the response."
},
{
"name": "privilegeTargetDomain",
"value": "",
"type": "query",
"description": "The `targetDomain` value the groups privileges must match to be included in the response."
},
{
"name": "accessLevel",
"value": "",
"type": "query",
"description": "The [access level](https://docs.coveo.com/en/2818/) the groups privileges must match to be included in the response.**Allowed values:**- `EDIT_ALL`: Groups can edit the organization.- `CUSTOM`: Groups have custom access to the organization.- `VIEW_ALL`: Groups can view the organization.- `NONE`: Groups have no access to the organization."
}
]
},
"docs": "Lists groups with a specific privilege [access level](https://docs.coveo.com/en/2818/) in an [organization](https://docs.coveo.com/en/185/).See [Privilege reference](https://docs.coveo.com/en/1707/).
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"{privilegeOwner}\",\"targetDomain\":\"{privilegeTargetDomain}\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List API Keys with Privilege Access Level",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/access/apikeys",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "privilegeOwner",
"value": "",
"type": "query",
"description": "The `owner` value an API key must have to be included in the response."
},
{
"name": "privilegeTargetDomain",
"value": "",
"type": "query",
"description": "The `targetDomain` value an API key must have to be included in response."
},
{
"name": "accessLevel",
"value": "",
"type": "query",
"description": "The [access level](https://docs.coveo.com/en/2818/) an API key must have to be included in the response.**Allowed values:**- `EDIT_ALL`: API key can edit the organization.- `CUSTOM`: API key has custom access to the organization.- `VIEW_ALL`: API key can view the organization.- `NONE`: API key has no access to the organization."
}
]
},
"docs": "Lists the API keys with a specific privilege [access level](https://docs.coveo.com/en/2818/) in an [organization](https://docs.coveo.com/en/185/).See [Privilege reference](https://docs.coveo.com/en/1707/).
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"API_KEY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
}
]
}
],
"bundled": true
}