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.

post

/v1/dlp/policies

Header parameters

sessionTokenstringrequired

Session authentication token.

keyManagerTokenstringrequired

Key Manager authentication token.

Body

namestringrequired

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

typestringrequired

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

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[]

List of dictionaries Ids for the policy.

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

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

500

200

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

Success

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.