V3 Update Policy

Updates data for an existing policy, such as the dictionaries and also `name`, `type`, `contentTypes`, and `scopes`.

Updates a policy. Cannot be used for creation.

Update the policy (name, type, contentTypes, scopes) and also the dictionaries for a policy. Warning: If you send empty list of dictionaries during the update operation, then all the dictionaries for this policy are deleted and policy is automatically disabled. Note: The policy should already exist.

POSTyouragentURL.symphony.com/agent/v3/dlp/policies/{policyId}/update

Path parameters

policyId*string

Unique dictionary identifier.

Header parameters

Body

application/json

name*string

Unique name of a policy, max 30 characters. Cannot be empty. All the leading and trailing blank spaces are trimmed.

scopes*array of string

List of communication scopes. Possible values are "Internal" (for Internal conversations) or "External" (for External conversations). You can apply both scopes if you set it to ["Internal", "External"].

appliesTo*array of V3DLPPolicyAppliesTo (object)

Response

200400401403500

Success

Body

application/json

dataV3DLPPolicy (object)

A policy is the main entity of V3 policy/rule system. It is responsible to define rules and add scope constraints to the engine.

Request

JavaScriptCurl

const response = await fetch('youragentURL.symphony.com/agent/v3/dlp/policies/{policyId}/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "appliesTo": [
        {
          "action": "text",
          "dataType": "text",
          "rules": [
            {
              "name": "text",
              "type": "text"
            }
          ]
        }
      ],
      "name": "text",
      "scopes": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "data": {
    "id": "text",
    "policyId": "text",
    "version": "text",
    "name": "text",
    "scopes": [
      "text"
    ],
    "appliesTo": [
      {
        "dataType": "text",
        "action": "text",
        "rules": [
          {
            "id": "text",
            "type": "text",
            "name": "text",
            "textMatchConfig": {
              "dictionaries": [
                {
                  "dictId": "text",
                  "version": "text",
                  "name": "text"
                }
              ],
              "applicableFileTypes": [
                "text"
              ]
            },
            "fileSizeConfig": {},
            "fileExtensionConfig": {
              "allowLists": [
                "text"
              ],
              "blockLists": [
                "text"
              ]
            },
            "filePasswordConfig": {
              "applicableFileTypes": [
                "text"
              ],
              "matchCriteria": "text"
            },
            "fileClassifierConfig": {
              "applicableFileTypes": [
                "text"
              ]
            }
          }
        ]
      }
    ],
    "active": false,
    "deleted": false,
    "systemPolicy": false
  }
}

🚧 Important

Do not use this endpoint to create new policies. Use Create Policy.

❗️ Warning

Updating a policy requires to send a whole data that was used for creation a policy with modification to be applied. There is no partial update for this endpoint.

🚧 Required Permissions

Calling this endpoint requires a Service User Account set with the Expression Filter Policy Management role. For more information about Service User accounts and their roles, see the Symphony Administration Guide.

See Bot Permissions for a list of roles and associated privileges.