Skip to main content

4) Conditional Policy Query and Enforcement Policy Reception

Conditional Policy Query and Enforcement Policy Reception API

API

MethodURL
POST/api/search/ztca/evaluation

Request Body

NameRequiredTypeDescription
licenseKeyrequiredstringEnter the issued license in the integration app management menu of the SHIELDRM admin page.
userIdrequiredstringUser IDs by company registered in the authentication/authorization service
ipAddressrequiredstringUser IP Address
fileEventrequiredstringFile Events
typerequiredstringTarget Document Type
extrequiredstringTarget Document Extension
propertiesoptionalstringDocument Encryption Types
If there are multiple DAC IDs, separate them with "|".
ex) DAC;user1|DAC;user2
creatorSameLoginUseroptionalstringCheck Constructor Information
- Whether the document creator ID matches the userId
  : true / false

Response

NameTypeDescription
codeintSuccess status (Success:0)
messagestring"Success" : Success
Other Value Error Message
conditionalPolicyNamestringConditional Policy Name
conditionalPolicyIdstringConditional Policy ID
enforcementAttributesjsonArrayExecution Policy List
    orderintPolicy Priorities
    categorystringEvaluation Target Categories
    infojsonExecution Policy Details

Examples

Request

  • Body
 {
"licenseKey": "A4CD-BCBE6-D1DF-8BFB9",
"userId": "ekms2@softcamp.co.kr",
"ipAddress": "10.10.10.100",
"fileEvent": "encryption",
"type": "ds",
"ext": "pptx",
"properties": "MAC;0000001",
"creatorSameLoginUser": "false"
}

Response

  • success
[조건부 정책 조회 성공]
{
"code": 0,
"message": "Success",
"conditionalPolicyName": "test",
"conditionalPolicyId": "ePs0qUsi-mZ6KUyKV-uhTvXHQh-1w35aKNa",
"enforcementAttributes": [
{
"order": 0,
"category": "convert",
"info": {
"auth": "011111000",
"detail": "DAC;test@test.com",
"forcedEncryptPolicy": "false",
"type": "ds"
}
}
]
}

[조건에 맞는 조건부 정책이 존재하지 않음]
{
"code": 1621,
"message": "Conditional policies does not exist that match the conditions"
}

[존재하지 않는 userId]
{
"code": 1200,
"message": "User not found"
}
  • Internal Service Failure
{
"code": 50001,
"message": "An unexpected error has occurred in the internal system"
}