V2 Create Policy

Creates a new policy with dictionary references.

Creates a policy

Creates a new policy with dictionary references.

At the time of policy creation, the caller should only provide - contentTypes, name, scopes and type. The rest of the information is populated automatically.

Note - You need to enable the policy after creation to start enforcing the policy.

POSTyouragentURL.symphony.com/agent/v1/dlp/policies

Header parameters

Body

application/json

Details about the policy that should be created.

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

JavaScriptCurl

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

Response

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

After you create a policy, call Enable Policy to start enforcing 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.