V3 Get Policy

Gets a policy.

Get a policy

Get a policy

GETyouragentURL.symphony.com/agent/v3/dlp/policies/{policyId}

Path parameters

policyId*string

Unique dictionary identifier.

Query parameters

Header parameters

Response

200400401403500

Success

Body

application/json

dataV3DLPPolicy (object)

A policy is the main entity of V3 policy/rule system. It is responsible to define rules and add scope constraints to the engine.

Request

JavaScriptCurlPython

const response = await fetch('youragentURL.symphony.com/agent/v3/dlp/policies/{policyId}', {
    method: 'GET',
    headers: {
      "sessionToken": "text",
      "keyManagerToken": "text"
    },
});
const data = await response.json();

Response

200400401403500

{
  "data": {
    "id": "text",
    "policyId": "text",
    "version": "text",
    "name": "text",
    "creatorId": 0,
    "scopes": [
      "text"
    ],
    "appliesTo": [
      {
        "dataType": "text",
        "action": "text",
        "rules": [
          {
            "id": "text",
            "type": "text",
            "name": "text",
            "textMatchConfig": {
              "dictionaries": [
                {
                  "dictId": "text",
                  "version": "text",
                  "name": "text"
                }
              ],
              "countUniqueOccurrences": 0,
              "applicableFileTypes": [
                "text"
              ]
            },
            "fileSizeConfig": {
              "sizeLimit": 0
            },
            "fileExtensionConfig": {
              "allowLists": [
                "text"
              ],
              "blockLists": [
                "text"
              ]
            },
            "filePasswordConfig": {
              "applicableFileTypes": [
                "text"
              ],
              "matchCriteria": "text"
            },
            "fileClassifierConfig": {
              "applicableFileTypes": [
                "text"
              ]
            }
          }
        ]
      }
    ],
    "active": false,
    "deleted": false,
    "creationDate": 0,
    "lastUpdatedDate": 0,
    "lastDisabledDate": 0,
    "systemPolicy": false
  }
}

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