{
  "opencollection": "1.0.0",
  "info": {
    "name": "Akamai: API Endpoint Definition Access tokens Personally identifiable information API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "Personally identifiable information",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List parameters with PII for an endpoint version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "status",
                "value": "{{status}}",
                "type": "query",
                "description": "__Enum__ The status of an instance of personally identifiable information (PII) discovered on the network. See [PII status](https://techdocs.akamai.com/api-definitions/reference/personally-identifiable-information-status)."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "Returns all PII objects for an endpoint version. This includes parameters with PII already in your API definition as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.com/application-security/reference/put-advanced-settings-pii-learning) to use this feature."
        },
        {
          "info": {
            "name": "Add or update a user-created PII instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/parameters/:paramId",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "paramId",
                "value": "{{paramId}}",
                "type": "path",
                "description": "The unique identifier for a parameter."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds or updates PII in an API parameter. This is for you to add to or modify in your API definition yourself, rather than the network discovering the PII for you."
        },
        {
          "info": {
            "name": "List PII settings for an endpoint version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/settings",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "Returns the PII settings in an endpoint version, including the inspection scope and constraints, and how you want the network to handle PII."
        },
        {
          "info": {
            "name": "Modify PII settings for an endpoint version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/settings",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the PII settings in an endpoint version. These settings are for a PII object per endpoint version, so if you have the same object in multiple endpoint versions, you'll need to run the operation for each version. n as well as parameters with PII the network discovers on your behalf. You can return this information for both active and inactive endpoint versions. All operations for PII are per endpoint version. Run [Enable PII learning settings for a configuration](https://techdocs.akamai.co"
        },
        {
          "info": {
            "name": "Modify PII status per endpoint version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/status",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself."
        },
        {
          "info": {
            "name": "Delete PII in an endpoint version",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/:piiId",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "piiId",
                "value": "{{piiId}}",
                "type": "path",
                "description": "The unique identifier for the PII object."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "Removes a PII object from your API endpoint definition for the version you specify. If you want to delete the PII object from all the versions where it exists, you'll need to make this request for each version of the endpoint."
        },
        {
          "info": {
            "name": "Patch PII status per endpoint version",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{hostname}/api-definitions/v2/endpoints/:apiEndPointId/versions/:versionNumber/piis/:piiId/status",
            "params": [
              {
                "name": "apiEndPointId",
                "value": "{{apiEndPointId}}",
                "type": "path",
                "description": "The unique identifier for the endpoint."
              },
              {
                "name": "versionNumber",
                "value": "{{versionNumber}}",
                "type": "path",
                "description": "The unique identifier for the endpoint version."
              },
              {
                "name": "piiId",
                "value": "{{piiId}}",
                "type": "path",
                "description": "The unique identifier for the PII object."
              },
              {
                "name": "accountSwitchKey",
                "value": "{{accountSwitchKey}}",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the PII status. This operation applies to PII found by the network and not PII you add to your API definition yourself."
        }
      ]
    }
  ],
  "bundled": true
}