Skip to main content

6) AIP 레이블 설정

일반 문서를 AIP 문서로 변환

API

Method	URL
POST	/api/protect

Request Body

Name	Required	Type	Description
licenseKey	required	string	SHIELDRM 관리자 페이지의 연동 앱 관리 메뉴에서 발급 받은 라이선스 입력
labelId	required/optional	string	적용할 레이블 id
labelName	required/optional	string	적용할 레이블 name - labelId 없는 경우 labelName 사용하여 적용
srcFilePath	required	string	원본 일반 문서 경로 - 일반 문서만 변환 가능
dstFilePath	required	string	변환된 AIP 문서 경로
extraInfo	optional	json	JSON 형식의 추가 정보 입력 (아래의 extraInfo 데이터 설명표 및 샘플 데이터 참고)
setProtect	optional	boolean	프로텍트 설정 여부
decisionFactor	optional	json	등록된 조건부 정책 적용을 위한 추가 정보 입력 (아래의 decisionFactor 데이터 설명표 및 샘플 데이터 참고)

extraInfo 데이터 설명표

Key Required Type Description
source required json
name required string 호출 시스템 이름
from required string 호출 시스템 URL
user json
id string 사용자 아이디
name string 사용자 이름
depart string 사용자 전체 부서 (상위그룹/중위그룹/하위그룹)
duty string 사용자 직책 이름

샘플 데이터
{
  "source": {
    "name": "EKMS",
    "from": "https://devekms.softcamp.co.kr"
  },
  "user": {
    "id": "ekmsTest@softcamp.co.kr",
    "name": "ekmsTest",
    "depart": "임직원/연구소/개발실/개발1팀",
    "duty": "과장"
  }
}

decisionFactor 데이터 설명표

Key Required Type Description
userId required string 조건부 정책의 구성원에 해당하는 문서 변환을 요청한 사용자 아이디
ipAddress required string 조건부 정책의 위치(IP)에 해당하는 문서 변환을 요청한 사용자 IP

샘플 데이터
{
  "userId": "user1@socam.info",
  "ipAddress": "10.10.10.100"
}

Response

Name	Type	Description
code	int	0 : 성공 0 이외의 값 : 에러
message	string	"OK" : 성공 이외의 값 에러 메시지

Examples

Request

Body

[labelId 사용]
{
  "licenseKey": "FEFF-0C448-B1D8-A1A9A",
  "labelId": "070b7e3a-bb66-47e0-8196-7d030d54190d",
  "srcFilePath" : "/opt/shieldrm/data/test.xlsx",
  "dstFilePath" : "/opt/shieldrm/dataout_test.xlsx" ,
  "extraInfo" : "{\"source\":{\"name\":\"EKMS\",\"from\":\"https://devekms.softcamp.co.kr\"},\"user\":{\"id\":\"ekmsTest@softcamp.co.kr\",\"name\":\"ekmsTest\",\"depart\":\"임직원/연구소/개발실/개발1팀\",\"duty\":\"과장\"}}",
  "decisionFactor": "{\"userId\":\"user1@socam.info\",\"ipAddress\":\"10.10.10.100\"}"
}

[labelName 사용]
{
  "licenseKey": "FEFF-0C448-B1D8-A1A9A",
  "labelName": "Protected by SHIELDRM(DEV)",
  "srcFilePath" : "/opt/shieldrm/data/test.xlsx",
  "dstFilePath" : "/opt/shieldrm/dataout_test.xlsx" ,
  "extraInfo" : "{\"source\":{\"name\":\"EKMS\",\"from\":\"https://devekms.softcamp.co.kr\"},\"user\":{\"id\":\"ekmsTest@softcamp.co.kr\",\"name\":\"ekmsTest\",\"depart\":\"임직원/연구소/개발실/개발1팀\",\"duty\":\"과장\"}}",
  "decisionFactor": "{\"userId\":\"user1@socam.info\",\"ipAddress\":\"10.10.10.100\"}"
}

Response

성공

{
    "code": 0,
    "message" : "OK"
}

실패

Status code : 400 Bad Request

[필수 파라미터 없음]
{
    "code": 40001,
    "message": "Missing required input values"
}

[비밀번호 설정된 일반 문서]
{
    "code": 40010,
    "message": "The file has been protected using non RMS technologies"
}

[원본 문서가 AIP 문서인 경우]
{
    "code": 40010,
    "message": "File is already Protected."
}

Status code : 401 UNAUTHORIZED

{
    "code": 40001,
    "message": "Invalid token"
}

Status code : 500 INTERNAL_SERVER_ERROR

[AIP SDK 에러]
{
    "code": 60001,
    "message": "com.microsoft.informationprotection.internal.gen.Error: NoAuthTokenError: Client application failed to provide authentication token for HTTP request., CorrelationId=a2d2f6b1-4265-482b-bc7d-18c88f8284bd, CorrelationId.Description=PolicyProfile"
}

[내부 서비스 에러]
{
    "code": 50001,
    "message": "400 : \"{\"code\":40011,\"message\":\"Unable to AzureInfo\",\"detail\":\"OpenidTenant is Empty\"}\""
}
{
    "code": 50001,
    "message": "No matching labelId found"
}

일반 문서를 AIP 문서로 변환
Examples