{
  "opencollection": "1.0.0",
  "info": {
    "name": "Agent Admin DLP Policies and Dictionary Management API",
    "version": "25.8.1"
  },
  "items": [
    {
      "info": {
        "name": "DLP Policies and Dictionary Management",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all policies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify which page to return (default is 0)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50.\n"
              }
            ]
          },
          "docs": "Get all policies"
        },
        {
          "info": {
            "name": "Creates a policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new policy with dictionary references.\n\nAt the time of policy creation, the caller should only provide - contentTypes, name, scopes and type. The rest of the information is populated automatically.\n\nNote - You need to enable the policy after creation to start enforcing the policy.\n"
        },
        {
          "info": {
            "name": "Get a policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies/:policyId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier."
              },
              {
                "name": "policyVersion",
                "value": "",
                "type": "query",
                "description": "Optional parameter, if set to be valid policy version number,  will return policy with specified policyVersion. \nOtherwise, return the latest policy.\n"
              }
            ]
          },
          "docs": "Get a policy"
        },
        {
          "info": {
            "name": "Updates a policy. Cannot be used for creation.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies/:policyId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the policy (name, type, contentTypes, scopes) and also the dictionaries for a policy.\nWarning: If you send empty list of dictionaries during the update operation, then all the\ndictionaries for this policy are deleted and policy is automatically disabled.\nNote: The policy should already exist.\n"
        },
        {
          "info": {
            "name": "Delete a policy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies/:policyId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier."
              }
            ]
          },
          "docs": "Delete a policy.\nNote: Only disabled policy can be deleted\n"
        },
        {
          "info": {
            "name": "Enables a policy.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies/:policyId/enable",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Enables a policy."
        },
        {
          "info": {
            "name": "Disables a policy.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v1/dlp/policies/:policyId/disable",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Disables a policy."
        },
        {
          "info": {
            "name": "Get all dictionary metadatas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify which page to return (default is 0)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50.\n"
              }
            ]
          },
          "docs": "Get all dictionary metadatas with the latest version. Each dictionary object will only contain meta data of the content.\n"
        },
        {
          "info": {
            "name": "Create a dictionary",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a dictionary with basic metadata and no content. Only \"name\" and \"type\" field is used to create a new dictionary entry.\n"
        },
        {
          "info": {
            "name": "Get dictionary metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries/:dictId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dictId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier"
              },
              {
                "name": "dictVersion",
                "value": "",
                "type": "query",
                "description": "If set to be valid dictionary version number, will return dictionary metadata with specified version. \nOtherwise, return the latest dictionary metadata.\n"
              }
            ]
          },
          "docs": "Get basic information for a dictionary."
        },
        {
          "info": {
            "name": "Updates a dictionary",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries/:dictId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dictId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the dictionary's basic metadata without content.\nThis API cannot be used for creating a new dictionary.\nIn case of update only \"name\" can be changed.\nNote: All related policies will also have versions updated.\n"
        },
        {
          "info": {
            "name": "Delete a dictionary",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries/:dictId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dictId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier"
              }
            ]
          },
          "docs": "Deletes a dictionary.\nNote: All related policies will be affected.\n"
        },
        {
          "info": {
            "name": "Downloads Base 64 encoded dictionary content.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries/:dictId/data/download",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dictId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier"
              },
              {
                "name": "dictVersion",
                "value": "",
                "type": "query",
                "description": "If set to be valid dictionary version number, will return dictionary with specified version. \nOtherwise, return the latest dictionary.\n"
              }
            ]
          },
          "docs": "Downloads Base 64 encoded dictionary content."
        },
        {
          "info": {
            "name": "Override dictionary content with provided content.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v1/dlp/dictionaries/:dictId/data/upload",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "dictId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "data",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Override dictionary content with provided content."
        },
        {
          "info": {
            "name": "Get all policies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify which page to return (default is 0)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Optional parameter to specify the number of result to return per page, default is 50. Maximum is 50.\n"
              }
            ]
          },
          "docs": "Get all policies"
        },
        {
          "info": {
            "name": "Creates a policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new policy with dictionary references.\nAt the time of policy creation, the caller should only provide - contentTypes, name, scopes and type.\nThe rest of the information is populated automatically.\nNote - You need to enable the policy after creation to start enforcing the policy.\n"
        },
        {
          "info": {
            "name": "Get a policy",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies/:policyId",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier."
              },
              {
                "name": "policyVersion",
                "value": "",
                "type": "query",
                "description": "Optional parameter, if set to be valid policy version number,  will return policy with specified policyVersion. \nOtherwise, return the latest policy.\n"
              }
            ]
          },
          "docs": "Get a policy"
        },
        {
          "info": {
            "name": "Updates a policy. Cannot be used for creation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies/:policyId/update",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the policy (name, type, contentTypes, scopes) and also the dictionaries for a policy.\nWarning: If you send empty list of dictionaries during the update operation, then all the\ndictionaries for this policy are deleted and policy is automatically disabled.\nNote: The policy should already exist.\n"
        },
        {
          "info": {
            "name": "Delete a policy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies/:policyId/delete",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path",
                "description": "Unique dictionary identifier."
              }
            ]
          },
          "docs": "Delete a policy.\nNote: Only disabled policy can be deleted\n"
        },
        {
          "info": {
            "name": "Enables a policy.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies/:policyId/enable",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Enables a policy."
        },
        {
          "info": {
            "name": "Disables a policy.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "youragentURL.symphony.com/agent/v3/dlp/policies/:policyId/disable",
            "headers": [
              {
                "name": "sessionToken",
                "value": ""
              },
              {
                "name": "keyManagerToken",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "policyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Disables a policy."
        }
      ]
    }
  ],
  "bundled": true
}