V2 Create Policy

Creates a new policy with dictionary references.

Creates a policy

post

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.

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringRequired

Key Manager authentication token.

Body

The policy object to use for creating/updating a policy.

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

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

HTTPcURLJavaScriptPython

POST /agent/v1/dlp/policies HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
keyManagerToken: text
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "contentTypes": [
    "text"
  ],
  "dictionaryIds": [
    "text"
  ],
  "name": "text",
  "scopes": [
    "text"
  ],
  "type": "text"
}

{
  "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"
  }
}

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.