{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Security Cache 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": "Security Cache",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a Security Cache Schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/schedules/:scheduleId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Security Cache Schedule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/schedules/:scheduleId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "scheduleId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Triggers a Refresh on a Security Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/:securityProviderId/refresh",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"{securityProviderId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Cancels the Current Refresh Operation on a Security Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/:securityProviderId/refresh/cancel",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"{securityProviderId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Enable All Disabled Entities for a Specified Security Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/:securityProviderId/disabled/enable",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"{securityProviderId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Triggers a Refresh on the Security Cache",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/refresh",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Refreshes a Single Entity in the Security Cache",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/refresh/entity",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Parent Entities for a Specified Security Provider Member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/:securityProviderId/members/parents",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Child Entities for a Specified Security Provider Member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/:securityProviderId/members/children",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Entity Information for a Specified Security Provider Member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/:securityProviderId/entity",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "listSecurityIdentities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/list",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Enable All Disabled Entities on Security Cache",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/disabled/enable",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Entities for a Specified Security Provider on a Specified Security Cache",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/:securityCacheId/entities/:securityProviderId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityCacheId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "states",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Date filter from, minimum updated date."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Date filter to, maximum updated date."
              },
              {
                "name": "usePageModel",
                "value": "",
                "type": "query",
                "description": "Deprecated: you can input either 'true' or 'false' with no effect on the result."
              },
              {
                "name": "minEntityId",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Security Cache Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/status",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Online Security Cache Ids",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/status/online",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Security Cache Schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/schedules",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Entities for a Specified Security Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/:securityProviderId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "states",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Date filter from, minimum updated date."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Date filter to, maximum updated date."
              },
              {
                "name": "usePageModel",
                "value": "",
                "type": "query",
                "description": "Deprecated: you can input either 'true' or 'false' with no effect on the result."
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Members for a Specified Security Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/:securityProviderId/members",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "states",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Date filter from, minimum updated date"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Date filter to, maximum updated date"
              },
              {
                "name": "usePageModel",
                "value": "",
                "type": "query",
                "description": "Deprecated: you can input either 'true' or 'false' with no effect on the result."
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "isListSecurityIdentitiesSupported",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securitycache/entities/list/is_supported",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\nOR\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_CACHE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}