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.

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.

PUTyouragentURL.symphony.com/agent/v1/dlp/policies/{policyId}

Path parameters

policyId*string

Unique dictionary identifier.

Header parameters

Body

application/json

contentTypes*array of string

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.

dictionaryIdsarray of string

List of dictionaries Ids for the policy.

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

type*string

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

Response

200400401403500

Success

Body

application/json

dataV1DLPPolicy (object)

The policy object for expression filter, one policy can have multiple dictionaries

Request

JavaScriptCurlPython

const response = await fetch('youragentURL.symphony.com/agent/v1/dlp/policies/{policyId}', {
    method: 'PUT',
    headers: {
      "sessionToken": "text",
      "keyManagerToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contentTypes": [
        "text"
      ],
      "name": "text",
      "scopes": [
        "text"
      ],
      "type": "text"
    }),
});
const data = await response.json();

Response

200400401403500

{
  "data": {
    "active": false,
    "contentTypes": [
      "text"
    ],
    "creatorId": "text",
    "dictionaryRefs": [
      {
        "dictId": "text",
        "name": "text",
        "version": "text"
      }
    ],
    "name": "text",
    "policyId": "text",
    "scopes": [
      "text"
    ],
    "type": "text",
    "version": "text"
  }
}

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