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.

post

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.

Path parameters

policyIdstringRequired

Unique dictionary identifier.

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringOptional

Key Manager authentication token.

Body

application/json

Request to be used to get policies.

namestringRequired

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

scopesstring[]Required

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"].

Responses

200

Success

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Session tokens invalid.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v3/dlp/policies/{policyId}/update

HTTPcURLJavaScriptPython

POST /agent/v3/dlp/policies/{policyId}/update HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 562

{
  "name": "text",
  "scopes": [
    "text"
  ],
  "appliesTo": [
    {
      "dataType": "text",
      "action": "text",
      "rules": [
        {
          "id": "text",
          "type": "text",
          "name": "text",
          "textMatchConfig": {
            "dictionaries": [
              {
                "dictId": "text",
                "version": "text",
                "name": "text"
              }
            ],
            "countUniqueOccurrences": 1,
            "applicableFileTypes": [
              "text"
            ]
          },
          "fileSizeConfig": {
            "sizeLimit": 1
          },
          "fileExtensionConfig": {
            "allowLists": [
              "text"
            ],
            "blockLists": [
              "text"
            ]
          },
          "filePasswordConfig": {
            "applicableFileTypes": [
              "text"
            ],
            "matchCriteria": "text"
          },
          "fileClassifierConfig": {
            "classifiers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "applicableFileTypes": [
              "text"
            ]
          }
        }
      ]
    }
  ]
}

{
  "data": {
    "id": "text",
    "policyId": "text",
    "version": "text",
    "name": "text",
    "creatorId": 1,
    "scopes": [
      "text"
    ],
    "appliesTo": [
      {
        "dataType": "text",
        "action": "text",
        "rules": [
          {
            "id": "text",
            "type": "text",
            "name": "text",
            "textMatchConfig": {
              "dictionaries": [
                {
                  "dictId": "text",
                  "version": "text",
                  "name": "text"
                }
              ],
              "countUniqueOccurrences": 1,
              "applicableFileTypes": [
                "text"
              ]
            },
            "fileSizeConfig": {
              "sizeLimit": 1
            },
            "fileExtensionConfig": {
              "allowLists": [
                "text"
              ],
              "blockLists": [
                "text"
              ]
            },
            "filePasswordConfig": {
              "applicableFileTypes": [
                "text"
              ],
              "matchCriteria": "text"
            },
            "fileClassifierConfig": {
              "classifiers": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "applicableFileTypes": [
                "text"
              ]
            }
          }
        ]
      }
    ],
    "active": true,
    "deleted": true,
    "creationDate": 1,
    "lastUpdatedDate": 1,
    "lastDisabledDate": 1,
    "systemPolicy": true
  }
}

🚧 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.