알림
뒤로
DBSAFER 정책 관리 API

DBSAFER 정책 관리 API를 소개합니다.

1. 연동정책 관리

1.1. 연동정책 목록 조회

등록된 연동정책을 목록을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.1.1. HTTP request

GET /dbsafer/api/v1/policy/custom/access-policies?policyId=POLICY_20230101001&userId=user001&serverAddress=1.1.1.1&serverPort=3306&account=account001&policyType=SAC HTTP/1.1
Accept: application/json
Host: localhost:3182

1.1.2. Request parameters

Parameter Description

policyId

정책코드

userId

사용자 ID

serverAddress

서버 주소

serverPort

서버 Port

account

접속계정

policyType

정책 유형 식별값

1.1.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 573

{
  "results" : [ {
    "index" : 1,
    "policyId" : "POLICY_20230101001",
    "userId" : "user001",
    "account" : "account001",
    "clientIpBegin" : "1.1.1.1",
    "clientIpEnd" : "2.2.2.2",
    "serverAddress" : "1.1.1.1",
    "serverPort" : 3306,
    "sid" : "instance001",
    "sqlPrivileges" : [ "INSERT", "SELECT" ],
    "policyType" : "SAC",
    "reserved1" : "추가 정보(1)",
    "reserved2" : "추가 정보(2)",
    "reserved3" : "추가 정보(3)",
    "startDate" : "2022-01-01T00:00:00",
    "endDate" : "2022-12-31T23:59:59",
    "lock" : false
  } ]
}

1.1.4. Response fields

Name Type Description Required

results.[].index

Number

정책 Index

○

results.[].policyId

String

정책코드

○

results.[].userId

String

사용자 ID

○

results.[].account

String

접속계정

○

results.[].clientIpBegin

String

사용자 IP (시작)

○

results.[].clientIpEnd

String

사용자 IP (종료)

○

results.[].serverAddress

String

서버 주소

○

results.[].serverPort

Number

서버 Port

○

results.[].sid

String

인스턴스

○

results.[].sqlPrivileges

Array

SQL 권한

○

results.[].policyType

String

정책 유형 식별값

○

results.[].reserved1

String

추가 정보(1)

○

results.[].reserved2

String

추가 정보(2)

○

results.[].reserved3

String

추가 정보(3)

○

results.[].startDate

String

유효기간 시작일

○

results.[].endDate

String

유효기간 종료일

○

results.[].lock

Boolean

정책 잠금 여부

○

1.1.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies?policyId=POLICY_20230101001&userId=user001&serverAddress=1.1.1.1&serverPort=3306&account=account001&policyType=SAC' -i -X GET \
    -H 'Accept: application/json'

1.2. 연동정책 조회

등록된 연동정책을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.2.1. HTTP request

GET /dbsafer/api/v1/policy/custom/access-policies/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

1.2.2. Path parameters

Table 1. /dbsafer/api/v1/policy/custom/access-policies/{index}
Parameter Description

index

정책 Index

1.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 515

{
  "index" : 1,
  "policyId" : "POLICY_20230101001",
  "userId" : "user001",
  "account" : "account001",
  "clientIpBegin" : "1.1.1.1",
  "clientIpEnd" : "2.2.2.2",
  "serverAddress" : "1.1.1.1",
  "serverPort" : 3306,
  "sid" : "instance001",
  "sqlPrivileges" : [ "INSERT", "SELECT" ],
  "policyType" : "SAC",
  "reserved1" : "추가 정보(1)",
  "reserved2" : "추가 정보(2)",
  "reserved3" : "추가 정보(3)",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "lock" : false
}

1.2.4. Response fields

Name Type Description Required

index

Number

정책 Index

○

policyId

String

정책코드

○

userId

String

사용자 ID

○

account

String

접속계정

○

clientIpBegin

String

사용자 IP (시작)

○

clientIpEnd

String

사용자 IP (종료)

○

serverAddress

String

서버 주소

○

serverPort

Number

서버 Port

○

sid

String

인스턴스

○

sqlPrivileges

Array

SQL 권한

○

policyType

String

정책 유형 식별값

○

reserved1

String

추가 정보(1)

○

reserved2

String

추가 정보(2)

○

reserved3

String

추가 정보(3)

○

startDate

String

유효기간 시작일

○

endDate

String

유효기간 종료일

○

lock

Boolean

정책 잠금 여부

○

1.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies/1' -i -X GET \
    -H 'Accept: application/json'

1.3. 연동정책 추가

새로운 연동정책을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.3.1. HTTP request

POST /dbsafer/api/v1/policy/custom/access-policies HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 482
Host: localhost:3182

{
  "policyId" : "POLICY_20230101001",
  "userId" : "user001",
  "account" : "account001",
  "clientIpBegin" : "1.1.1.1",
  "clientIpEnd" : "2.2.2.2",
  "serverAddress" : "1.1.1.1",
  "serverPort" : 3306,
  "sid" : "instance001",
  "sqlPrivileges" : [ "INSERT", "SELECT" ],
  "policyType" : "SAC",
  "reserved1" : "추가 정보(1)",
  "reserved2" : "추가 정보(2)",
  "reserved3" : "추가 정보(3)",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}

1.3.2. Request fields

Name Type Description Required

policyId

String

정책코드

userId

String

사용자 ID

○

account

String

접속계정

clientIpBegin

String

사용자 IP (시작)

clientIpEnd

String

사용자 IP (종료)

serverAddress

String

서버 주소

serverPort

Number

서버 Port

sid

String

인스턴스

sqlPrivileges

Array

SQL 권한

policyType

String

정책 유형 식별값

reserved1

String

추가 정보(1)

reserved2

String

추가 정보(2)

reserved3

String

추가 정보(3)

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

1.3.3. HTTP response

HTTP/1.1 201 Created

1.3.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -d '{
  "policyId" : "POLICY_20230101001",
  "userId" : "user001",
  "account" : "account001",
  "clientIpBegin" : "1.1.1.1",
  "clientIpEnd" : "2.2.2.2",
  "serverAddress" : "1.1.1.1",
  "serverPort" : 3306,
  "sid" : "instance001",
  "sqlPrivileges" : [ "INSERT", "SELECT" ],
  "policyType" : "SAC",
  "reserved1" : "추가 정보(1)",
  "reserved2" : "추가 정보(2)",
  "reserved3" : "추가 정보(3)",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}'

1.4. 연동정책 수정

등록된 연동정책을 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.4.1. HTTP request

PUT /dbsafer/api/v1/policy/custom/access-policies/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 482
Host: localhost:3182

{
  "policyId" : "POLICY_20230101001",
  "userId" : "user001",
  "account" : "account001",
  "clientIpBegin" : "1.1.1.1",
  "clientIpEnd" : "2.2.2.2",
  "serverAddress" : "1.1.1.1",
  "serverPort" : 3306,
  "sid" : "instance001",
  "sqlPrivileges" : [ "INSERT", "SELECT" ],
  "policyType" : "SAC",
  "reserved1" : "추가 정보(1)",
  "reserved2" : "추가 정보(2)",
  "reserved3" : "추가 정보(3)",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}

1.4.2. Path parameters

Table 1. /dbsafer/api/v1/policy/custom/access-policies/{index}
Parameter Description

index

정책 Index

1.4.3. Request fields

Name Type Description Required

policyId

String

정책코드

userId

String

사용자 ID

account

String

접속계정

clientIpBegin

String

사용자 IP (시작)

clientIpEnd

String

사용자 IP (종료)

serverAddress

String

서버 주소

serverPort

Number

서버 Port

sid

String

인스턴스

sqlPrivileges

Array

SQL 권한

policyType

String

정책 유형 식별값

reserved1

String

추가 정보(1)

reserved2

String

추가 정보(2)

reserved3

String

추가 정보(3)

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

1.4.4. HTTP response

HTTP/1.1 200 OK

1.4.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies/1' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -d '{
  "policyId" : "POLICY_20230101001",
  "userId" : "user001",
  "account" : "account001",
  "clientIpBegin" : "1.1.1.1",
  "clientIpEnd" : "2.2.2.2",
  "serverAddress" : "1.1.1.1",
  "serverPort" : 3306,
  "sid" : "instance001",
  "sqlPrivileges" : [ "INSERT", "SELECT" ],
  "policyType" : "SAC",
  "reserved1" : "추가 정보(1)",
  "reserved2" : "추가 정보(2)",
  "reserved3" : "추가 정보(3)",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}'

1.5. 연동정책 잠금

등록된 연동정책을 잠금하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.5.1. HTTP request

PUT /dbsafer/api/v1/policy/custom/access-policies/lock?policyId=POLICY_20230101001&userId=user001&serverAddress=1.1.1.1&serverPort=3306&account=account001&policyType=SAC HTTP/1.1
Accept: application/json
Host: localhost:3182

1.5.2. Request parameters

Parameter Description

policyId

정책코드

userId

사용자 ID

serverAddress

서버 주소

serverPort

서버 Port

account

접속계정

policyType

정책 유형 식별값

1.5.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 105

{
  "results" : [ {
    "index" : 1,
    "result" : true,
    "resultMessage" : "lock completed."
  } ]
}

1.5.4. Response fields

Name Type Description Required

results.[].index

Number

Index

○

results.[].result

Boolean

처리 결과

○

results.[].resultMessage

String

결과 Message

○

1.5.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies/lock?policyId=POLICY_20230101001&userId=user001&serverAddress=1.1.1.1&serverPort=3306&account=account001&policyType=SAC' -i -X PUT \
    -H 'Accept: application/json'

1.6. 연동정책 잠금해제

등록된 연동정책을 잠금해제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.6.1. HTTP request

PUT /dbsafer/api/v1/policy/custom/access-policies/unlock?policyId=POLICY_20230101001&userId=user001&serverAddress=1.1.1.1&serverPort=3306&account=account001&policyType=SAC HTTP/1.1
Accept: application/json
Host: localhost:3182

1.6.2. Request parameters

Parameter Description

policyId

정책코드

userId

사용자 ID

serverAddress

서버 주소

serverPort

서버 Port

account

접속계정

policyType

정책 유형 식별값

1.6.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 107

{
  "results" : [ {
    "index" : 1,
    "result" : true,
    "resultMessage" : "unlock completed."
  } ]
}

1.6.4. Response fields

Name Type Description Required

results.[].index

Number

Index

○

results.[].result

Boolean

처리 결과

○

results.[].resultMessage

String

결과 Message

○

1.6.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies/unlock?policyId=POLICY_20230101001&userId=user001&serverAddress=1.1.1.1&serverPort=3306&account=account001&policyType=SAC' -i -X PUT \
    -H 'Accept: application/json'

1.7. 연동정책 삭제

등록된 연동정책을 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.7.1. HTTP request

DELETE /dbsafer/api/v1/policy/custom/access-policies/1 HTTP/1.1
Host: localhost:3182

1.7.2. Path parameters

Table 1. /dbsafer/api/v1/policy/custom/access-policies/{index}
Parameter Description

index

정책 Index

1.7.3. HTTP response

HTTP/1.1 204 No Content

1.7.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/policy/custom/access-policies/1' -i -X DELETE

1.8. (참고) 연동정책 SQL 권한 타입 정의

연동정책 SQL 권한(sqlPrivileges) 타입에 대한 정의입니다. 상세 내용은 아래를 참고합니다.

type

ALL

ALTER

AUDIT

BEGIN

COMMAND

COMMENT

COMMIT

CONNECT

CREATE

DELETE

DESC

DROP

EXECUTE

GRANT

INDEX

INSERT

LINK

LOCK

MERGE

RENAME

REVOKE

ROLLBACK

SELECT

SHOW

SYNONYM

TRUNCATE

UPDATE

(주)피앤피시큐어

대표이사   박천오

대표번호   1670-9295          영업문의   sales@pnpsecure.com

사업자등록번호   107-86-44093

서울특별시 강서구 마곡서로 182(마곡동, 피앤피스테이션)


Copyright ⓒ 2023 pnpsecure All rights reserved. ｜개인정보 처리방침