{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities Organization Realms 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 Realms",
"type": "folder"
},
"items": [
{
"info": {
"name": "Update Realm",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/realms/:realmId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "realmId",
"value": "",
"type": "path",
"description": "The unique identifier of the realm to update.**Example:** `website-domain-coveo.com`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a realm of an [organization](https://docs.coveo.com/en/185/).
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List Realms",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/realms",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
}
]
},
"docs": "Lists the realms of an [organization](https://docs.coveo.com/en/185/).
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Add Realm for Groups",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/realms",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a realm for a set of groups in an [organization](https://docs.coveo.com/en/185/).
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
}
]
}
],
"bundled": true
}