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

put

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.

keyManagerTokenstringrequired

Key Manager authentication token.

Body

contentTypesstring[]required

The list of content types that policy should apply to. Cannot be empty. Policy content types could be either of "Messages", "RoomMeta", "SignalMeta". Default is set to ["Messages"] if not specified.

dictionaryIdsstring[]optional

List of dictionaries Ids for the policy.

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

typestringrequired

Type of policy. Possible values "Block" or "Warn".

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'youragentURL.symphony.com/agent/v1/dlp/policies/{policyId}' \
  --header 'sessionToken: text' \
  --header 'keyManagerToken: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "contentTypes": [
      "text"
    ],
    "dictionaryIds": [
      "text"
    ],
    "name": "text",
    "scopes": [
      "text"
    ],
    "type": "text"
  }'

200

400

401

403

500

200

{
  "data": {
    "active": true,
    "contentTypes": [
      "text"
    ],
    "creationDate": 1,
    "creatorId": "text",
    "dictionaryRefs": [
      {
        "dictId": "text",
        "name": "text",
        "version": "text"
      }
    ],
    "lastDisabledDate": 1,
    "lastUpdatedDate": 1,
    "name": "text",
    "policyId": "text",
    "scopes": [
      "text"
    ],
    "type": "text",
    "version": "text"
  }
}

Success

🚧 Important

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

❗️ Warning

Sending an empty list of dictionaries with this endpoint deletes all dictionaries for the policy and disables the policy.

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