V3 Get Policy

Gets a policy.

Get a policy

get

Get a policy

Path parameters

policyIdstringRequired

Unique dictionary identifier.

Query parameters

policyVersionstringOptional

Optional parameter, if set to be valid policy version number, will return policy with specified policyVersion. Otherwise, return the latest policy.

Header parameters

sessionTokenstringRequired

Session authentication token.

keyManagerTokenstringRequired

Key Manager authentication token.

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

get

HTTPcURLJavaScriptPython

GET /agent/v3/dlp/policies/{policyId} HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
keyManagerToken: text
Accept: */*

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

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