{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Security Identity 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 Identity",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add or Update an Alias",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/providers/:providerId/mappings",
            "params": [
              {
                "name": "providerId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target security identity provider (see [Create a security provider](https://docs.coveo.com/en/85/index-content/create-or-update-a-security-identity-provider-for-a-secured-push-source#create-a-security-provider)).  \n**Example:** `My Secured Push Source Security Identity Provider`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Adds or updates a single security identity alias pointing to one or several security identities in other security identity providers."
        },
        {
          "info": {
            "name": "Add or Update a Security Identity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/providers/:providerId/permissions",
            "params": [
              {
                "name": "providerId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target security identity provider (see [Create a security provider](https://docs.coveo.com/en/85/index-content/create-or-update-a-security-identity-provider-for-a-secured-push-source#create-a-security-provider)).  \n**Example:** `My Secured Push Source Security Identity Provider`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Adds or updates a single security identity in the security identity provider of a secured Push source."
        },
        {
          "info": {
            "name": "Delete a Security Identity",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/providers/:providerId/permissions",
            "params": [
              {
                "name": "providerId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target security identity provider (see [Create a security provider](https://docs.coveo.com/en/85/index-content/create-or-update-a-security-identity-provider-for-a-secured-push-source#create-a-security-provider)).  \n**Example:** `My Secured Push Source Security Identity Provider`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Disables a single security identity in the security identity provider of a secured Push source."
        },
        {
          "info": {
            "name": "Add, Update, and/or Delete a Batch of Security Identities",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/providers/:providerId/permissions/batch",
            "params": [
              {
                "name": "providerId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target security identity provider (see [Create a security provider](https://docs.coveo.com/en/85/index-content/create-or-update-a-security-identity-provider-for-a-secured-push-source#create-a-security-provider)).  \n**Example:** `My Secured Push Source Security Identity Provider`"
              },
              {
                "name": "fileId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the Amazon S3 file container into which the JSON definition of the security identity update was previously uploaded (see [Create a file container](https://docs.coveo.com/en/43/))."
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "A value indicating the order of arrival of the Push operation in the Coveo Cloud V2 indexing pipeline. A lower value corresponds to an older operation.  \nBy default, the service automatically sets this parameter to the current number of milliseconds since Unix Epoch.  \nSpecifying a custom `orderingId` value is typically not recommended unless you know what you are doing and have a good reason to do so (see [About the orderingId parameter](https://docs.coveo.com/en/147/)).  \n**Example:**  `1506700606240`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Manages a batch of security identities in the security identity provider of a secured Push source."
        },
        {
          "info": {
            "name": "Delete Old Security Identities",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/organizations/:organizationId/providers/:providerId/permissions/olderthan",
            "params": [
              {
                "name": "providerId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target security identity provider (see [Create a security provider](https://docs.coveo.com/en/85/index-content/create-or-update-a-security-identity-provider-for-a-secured-push-source#create-a-security-provider)).  \n**Example:** `My Secured Push Source Security Identity Provider`"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud V2 organization.  \n**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "orderingId",
                "value": "",
                "type": "query",
                "description": "The lowest Push API operation timestamp value a security identity must be associated to in order not to be deleted from the security identity provider.  \n**Example:** `1506700606240`"
              },
              {
                "name": "queueDelay",
                "value": "",
                "type": "query",
                "description": "A grace period (in minutes) whose purpose is to give the Coveo Cloud V2 indexing pipeline enough time to finish processing any previously enqueued operation that would affect the target Push source. Default value is 15 minutes.  \n**Example:** `5`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "In a specific security identity provider, disables all security identities whose last update was made by a Push API operation whose `orderingId` is strictly lower than a specified value."
        }
      ]
    }
  ],
  "bundled": true
}