{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Security Providers 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 Providers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a Single Security Provider for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/:securityProviderId",
            "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\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Security Provider for an Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/:securityProviderId",
            "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\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Remove a Security Provider from an Organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/:securityProviderId",
            "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": "Get the Raw Configuration of a Security Provider for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/:securityProviderId/raw",
            "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\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update the Raw Configuration of a Security Provider for an Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/:securityProviderId/raw",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "securityProviderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "forceUpdate",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get All Security Providers for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a Security Provider for an Organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get and Filter Security Providers by Ids for an Organization.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/batch/filter",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The text to filter security providers by (applied to the id, and displayName properties).<br/>**Example:** `Email Security Provider`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Lists the requested [security providers](https://docs.coveo.com/en/242/) by their respective ids. The unknown ids are ignored.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get and Filter Security Providers by Page for an Organization.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/securityproviders/page",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "The text to filter security providers by (applied to the id, and displayName properties).<br/>**Example:** `Email Security Provider`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Lists the filtered [security providers](https://docs.coveo.com/en/242/) by page.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SECURITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}