알림
뒤로
DBSAFER 사용자 관리 API

DBSAFER 사용자(보안계정) 관리 API를 소개합니다.

1. 사용자 관리

1.1. 사용자 목록 조회

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

1.1.1. HTTP request

GET /dbsafer/api/v1/users HTTP/1.1
Accept: application/json
Host: localhost:3182

1.1.2. HTTP response

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

{
  "results" : [ {
    "id" : "gdhong",
    "name" : "홍길동",
    "department" : "개발 1팀",
    "departmentCode" : "0001",
    "jobPosition" : "책임연구원",
    "jobTitle" : "파트장",
    "phoneNumber" : "031-123-4567",
    "mobilePhoneNumber" : "010-1234-5678",
    "email" : "gdhong@pnpsecure.com",
    "firstAuthType" : "NONE",
    "secondAuthType" : "NONE",
    "comment" : "Sample Account",
    "startDate" : "2022-01-01T00:00:00",
    "endDate" : "2022-12-31T23:59:59",
    "createDate" : "2024-05-08T16:42:46.193569",
    "passwordChangeDate" : "2022-06-01T00:00:00",
    "lock" : false
  } ]
}

1.1.3. Response fields

Name Type Description Required

results.[].id

String

사용자 ID

○

results.[].name

String

사용자 명

○

results.[].department

String

부서 명

○

results.[].departmentCode

String

부서코드

○

results.[].jobPosition

String

직급

○

results.[].jobTitle

String

직책

○

results.[].phoneNumber

String

전화번호

○

results.[].mobilePhoneNumber

String

휴대폰 번호

○

results.[].email

String

이메일 주소

○

results.[].firstAuthType

String

1차 인증

○

results.[].secondAuthType

String

2차 인증

○

results.[].comment

String

설명

○

results.[].startDate

String

유효기간 시작일

○

results.[].endDate

String

유효기간 종료일

○

results.[].createDate

String

생성일

○

results.[].passwordChangeDate

String

패스워드 변경일

○

results.[].lock

Boolean

잠금 여부

○

results.[].lockDate

String

잠금일

results.[].lockReason

String

잠금 사유

1.1.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users' -i -X GET \
    -H 'Accept: application/json'

1.2. 사용자 조회

등록된 사용자를 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.2.1. HTTP request

GET /dbsafer/api/v1/users/gdhong HTTP/1.1
Accept: application/json
Host: localhost:3182

1.2.2. Path parameters

Table 1. /dbsafer/api/v1/users/{id}
Parameter Description

id

사용자 ID

1.2.3. HTTP response

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

{
  "id" : "gdhong",
  "name" : "홍길동",
  "department" : "개발 1팀",
  "departmentCode" : "0001",
  "jobPosition" : "책임연구원",
  "jobTitle" : "파트장",
  "phoneNumber" : "031-123-4567",
  "mobilePhoneNumber" : "010-1234-5678",
  "email" : "gdhong@pnpsecure.com",
  "firstAuthType" : "NONE",
  "secondAuthType" : "NONE",
  "comment" : "Sample Account",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "createDate" : "2024-05-08T16:42:46.184209",
  "passwordChangeDate" : "2022-06-01T00:00:00",
  "lock" : false
}

1.2.4. Response fields

Name Type Description Required

id

String

사용자 ID

○

name

String

사용자 명

○

department

String

부서 명

○

departmentCode

String

부서코드

○

jobPosition

String

직급

○

jobTitle

String

직책

○

phoneNumber

String

전화번호

○

mobilePhoneNumber

String

휴대폰 번호

○

email

String

이메일 주소

○

firstAuthType

String

1차 인증

○

secondAuthType

String

2차 인증

○

comment

String

설명

○

startDate

String

유효기간 시작일

○

endDate

String

유효기간 종료일

○

createDate

String

생성일

○

passwordChangeDate

String

패스워드 변경일

○

lock

Boolean

잠금 여부

○

lockDate

String

잠금일

lockReason

String

잠금 사유

1.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong' -i -X GET \
    -H 'Accept: application/json'

1.3. 사용자 추가

신규 사용자를 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.3.1. HTTP request

POST /dbsafer/api/v1/users HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 478
Host: localhost:3182

{
  "id" : "gdhong",
  "password" : "cGFzc3dvcmQ=",
  "name" : "홍길동",
  "department" : "개발 1팀",
  "departmentCode" : "0001",
  "jobPosition" : "책임연구원",
  "jobTitle" : "파트장",
  "phoneNumber" : "031-123-4567",
  "mobilePhoneNumber" : "010-1234-5678",
  "email" : "gdhong@pnpsecure.com",
  "firstAuthType" : "NONE",
  "secondAuthType" : "NONE",
  "comment" : "Sample Account",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}

1.3.2. Request fields

Name Type Description Required

id

String

사용자 ID

○

password

String

패스워드 (Base64 인코딩 필요)

name

String

사용자 명

○

department

String

부서 명

departmentCode

String

부서코드

jobPosition

String

직급

jobTitle

String

직책

phoneNumber

String

전화번호

mobilePhoneNumber

String

휴대폰 번호

email

String

이메일 주소

comment

String

설명

firstAuthType

String

1차 인증

secondAuthType

String

2차 인증

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/users' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "id" : "gdhong",
  "password" : "cGFzc3dvcmQ=",
  "name" : "홍길동",
  "department" : "개발 1팀",
  "departmentCode" : "0001",
  "jobPosition" : "책임연구원",
  "jobTitle" : "파트장",
  "phoneNumber" : "031-123-4567",
  "mobilePhoneNumber" : "010-1234-5678",
  "email" : "gdhong@pnpsecure.com",
  "firstAuthType" : "NONE",
  "secondAuthType" : "NONE",
  "comment" : "Sample Account",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}'

1.4. 사용자 수정

등록된 사용자 정보를 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.4.1. HTTP request

PUT /dbsafer/api/v1/users/gdhong HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 455
Host: localhost:3182

{
  "password" : "cGFzc3dvcmQ=",
  "name" : "홍길동",
  "department" : "개발 1팀",
  "departmentCode" : "0001",
  "jobPosition" : "책임연구원",
  "jobTitle" : "파트장",
  "phoneNumber" : "031-123-4567",
  "mobilePhoneNumber" : "010-1234-5678",
  "email" : "gdhong@pnpsecure.com",
  "firstAuthType" : null,
  "secondAuthType" : null,
  "comment" : "Sample Account",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}

1.4.2. Path parameters

Table 1. /dbsafer/api/v1/users/{id}
Parameter Description

id

사용자 ID

1.4.3. Request fields

Name Type Description Required

password

String

패스워드 (Base64 인코딩 필요)

name

String

사용자 명

department

String

부서 명

departmentCode

String

부서코드

jobPosition

String

직급

jobTitle

String

직책

phoneNumber

String

전화번호

mobilePhoneNumber

String

휴대폰 번호

email

String

이메일 주소

firstAuthType

String

1차 인증

secondAuthType

String

2차 인증

comment

String

설명

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/users/gdhong' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "password" : "cGFzc3dvcmQ=",
  "name" : "홍길동",
  "department" : "개발 1팀",
  "departmentCode" : "0001",
  "jobPosition" : "책임연구원",
  "jobTitle" : "파트장",
  "phoneNumber" : "031-123-4567",
  "mobilePhoneNumber" : "010-1234-5678",
  "email" : "gdhong@pnpsecure.com",
  "firstAuthType" : null,
  "secondAuthType" : null,
  "comment" : "Sample Account",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59"
}'

1.5. 사용자 삭제

등록된 사용자를 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.5.1. HTTP request

DELETE /dbsafer/api/v1/users/gdhong HTTP/1.1
Host: localhost:3182

1.5.2. Path parameters

Table 1. /dbsafer/api/v1/users/{id}
Parameter Description

id

사용자 ID

1.5.3. HTTP response

HTTP/1.1 204 No Content

1.5.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong' -i -X DELETE

1.6. 사용자 잠금

사용자를 잠금하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.6.1. HTTP request

POST /dbsafer/api/v1/users/gdhong/lock HTTP/1.1
Host: localhost:3182

1.6.2. Path parameters

Table 1. /dbsafer/api/v1/users/{id}/lock
Parameter Description

id

사용자 ID

1.6.3. HTTP response

HTTP/1.1 200 OK

1.6.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/lock' -i -X POST

1.7. 사용자 잠금해제

잠금된 사용자를 잠금해제 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.7.1. HTTP request

POST /dbsafer/api/v1/users/gdhong/unlock HTTP/1.1
Host: localhost:3182

1.7.2. Path parameters

Table 1. /dbsafer/api/v1/users/{id}/unlock
Parameter Description

id

사용자 ID

1.7.3. HTTP response

HTTP/1.1 200 OK

1.7.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/unlock' -i -X POST

1.8. 사용자의 그룹 추가

사용자의 그룹을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.8.1. HTTP request

POST /dbsafer/api/v1/users/gdhong/groups/1 HTTP/1.1
Host: localhost:3182

1.8.2. Path parameters

Table 1. /dbsafer/api/v1/users/{userId}/groups/{groupIndex}
Parameter Description

userId

사용자 ID

groupIndex

그룹 Index

1.8.3. HTTP response

HTTP/1.1 200 OK

1.8.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/groups/1' -i -X POST

1.9. 사용자의 그룹 제거

사용자의 그룹을 제거하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.9.1. HTTP request

DELETE /dbsafer/api/v1/users/gdhong/groups/1 HTTP/1.1
Host: localhost:3182

1.9.2. Path parameters

Table 1. /dbsafer/api/v1/users/{userId}/groups/{groupIndex}
Parameter Description

userId

사용자 ID

groupIndex

그룹 Index

1.9.3. HTTP response

HTTP/1.1 200 OK

1.9.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/groups/1' -i -X DELETE

2. 사용자 그룹 관리

2.1. 사용자 그룹 목록 조회

등록된 사용자 그룹 목록을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.1.1. HTTP request

GET /dbsafer/api/v1/user/groups HTTP/1.1
Accept: application/json
Host: localhost:3182

2.1.2. HTTP response

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

{
  "results" : [ {
    "index" : 1,
    "name" : "SampleUserGroup001",
    "comment" : "comment"
  } ]
}

2.1.3. Response fields

Name Type Description Required

results.[].index

Number

그룹 Index

○

results.[].name

String

그룹 명

○

results.[].comment

String

설명

○

2.1.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups' -i -X GET \
    -H 'Accept: application/json'

2.2. 사용자 그룹 조회

등록된 사용자 그룹을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.2.1. HTTP request

GET /dbsafer/api/v1/user/groups/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

2.2.2. Path parameters

Table 1. /dbsafer/api/v1/user/groups/{index}
Parameter Description

index

그룹 Index

2.2.3. HTTP response

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

{
  "index" : 1,
  "name" : "SampleUserGroup001",
  "comment" : "comment"
}

2.2.4. Response fields

Name Type Description Required

index

Number

그룹 Index

○

name

String

그룹 명

○

comment

String

설명

○

2.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups/1' -i -X GET \
    -H 'Accept: application/json'

2.3. 사용자 그룹 추가

신규 사용자 그룹을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.3.1. HTTP request

POST /dbsafer/api/v1/user/groups HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 60
Host: localhost:3182

{
  "name" : "SampleUserGroup001",
  "comment" : "comment"
}

2.3.2. Request fields

Name Type Description Required

name

String

그룹 명

○

comment

String

설명

2.3.3. HTTP response

HTTP/1.1 201 Created

2.3.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "SampleUserGroup001",
  "comment" : "comment"
}'

2.4. 사용자 그룹 수정

등록된 사용자 그룹 정보를 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.4.1. HTTP request

PUT /dbsafer/api/v1/user/groups/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 55
Host: localhost:3182

{
  "name" : "gdhong",
  "comment" : "Sample Account"
}

2.4.2. Path parameters

Table 1. /dbsafer/api/v1/user/groups/{index}
Parameter Description

index

그룹 Index

2.4.3. Request fields

Name Type Description Required

name

String

그룹 명

comment

String

설명

2.4.4. HTTP response

HTTP/1.1 200 OK

2.4.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups/1' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "gdhong",
  "comment" : "Sample Account"
}'

2.5. 사용자 그룹 삭제

등록된 사용자 그룹을 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.5.1. HTTP request

DELETE /dbsafer/api/v1/user/groups/1 HTTP/1.1
Host: localhost:3182

2.5.2. Path parameters

Table 1. /dbsafer/api/v1/user/groups/{index}
Parameter Description

index

그룹 Index

2.5.3. HTTP response

HTTP/1.1 204 No Content

2.5.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups/1' -i -X DELETE

2.6. 사용자 그룹 내 사용자 추가

사용자 그룹 내 사용자를 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.6.1. HTTP request

POST /dbsafer/api/v1/user/groups/1/users/gdhong HTTP/1.1
Host: localhost:3182

2.6.2. Path parameters

Table 1. /dbsafer/api/v1/user/groups/{groupIndex}/users/{userId}
Parameter Description

groupIndex

그룹 Index

userId

사용자 ID

2.6.3. HTTP response

HTTP/1.1 200 OK

2.6.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups/1/users/gdhong' -i -X POST

2.7. 사용자 그룹 내 사용자 제거

사용자 그룹 내 사용자를 제거하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.7.1. HTTP request

DELETE /dbsafer/api/v1/user/groups/1/users/gdhong HTTP/1.1
Host: localhost:3182

2.7.2. Path parameters

Table 1. /dbsafer/api/v1/user/groups/{groupIndex}/users/{userId}
Parameter Description

groupIndex

그룹 Index

userId

사용자 ID

2.7.3. HTTP response

HTTP/1.1 200 OK

2.7.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/user/groups/1/users/gdhong' -i -X DELETE

3. 사용자 IP/MAC 관리

3.1. 사용자 IP/MAC 조회

등록된 사용자의 IP/MAC 목록을 조회하는 API를 소개합니다. Request param이 없다면 모든 IP/MAC 정보를 조회합니다.
상세 내용은 아래를 참고합니다.

3.1.1. HTTP request

GET /dbsafer/api/v1/users/gdhong/ipmac HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: localhost:3182

3.1.2. Path parameters

Table 1. /dbsafer/api/v1/users/{userId}/ipmac
Parameter Description

userId

사용자 ID

3.1.3. HTTP response

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

{
  "results" : [ {
    "index" : 1,
    "sno" : "gdhong",
    "ipAddr" : "10.10.10.10",
    "ipAddrEnd" : "10.10.10.255",
    "macAddr" : ""
  } ]
}

3.1.4. Response fields

Name Type Description Required

results.[].index

Number

IP/MAC 정보 Index

○

results.[].sno

String

IP/MAC의 사용자

○

results.[].ipAddr

String

IP 주소

○

results.[].ipAddrEnd

String

IP 범위 주소

○

results.[].macAddr

String

MAC 주소

○

3.1.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/ipmac' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json'

3.2. 사용자 IP/MAC 추가

등록된 사용자의 IP/MAC을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.2.1. HTTP request

POST /dbsafer/api/v1/users/gdhong/ipmac HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 121
Host: localhost:3182

{
  "index" : 0,
  "sno" : null,
  "ipAddr" : "2.2.2.2",
  "ipAddrEnd" : "2.2.2.255",
  "macAddr" : "00:00:00:00:00:00"
}

3.2.2. Path parameters

Table 1. /dbsafer/api/v1/users/{userId}/ipmac
Parameter Description

userId

사용자 ID

3.2.3. Request fields

Name Type Description Required

index

Number

IP/MAC의 index

sno

String

IP/MAC의 사용자

ipAddr

String

IP 주소
(범위 설정 1.1.1.1~1.1.1.255)

○

ipAddrEnd

String

IP 범위 주소

macAddr

String

MAC 주소

○

3.2.4. HTTP response

HTTP/1.1 200 OK

3.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/ipmac' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "index" : 0,
  "sno" : null,
  "ipAddr" : "2.2.2.2",
  "ipAddrEnd" : "2.2.2.255",
  "macAddr" : "00:00:00:00:00:00"
}'

3.3. 사용자 IP/MAC 수정

등록된 사용자의 IP/MAC을 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.3.1. HTTP request

PUT /dbsafer/api/v1/users/gdhong/ipmac HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 121
Host: localhost:3182

{
  "index" : 0,
  "sno" : null,
  "ipAddr" : "2.2.2.2",
  "ipAddrEnd" : "2.2.2.255",
  "macAddr" : "00:00:00:00:00:00"
}

3.3.2. Path parameters

Table 1. /dbsafer/api/v1/users/{userId}/ipmac
Parameter Description

userId

사용자 ID

3.3.3. Request fields

Name Type Description Required

index

Number

IP/MAC의 index

○

sno

String

IP/MAC의 사용자

ipAddr

String

IP 주소
(범위 설정 1.1.1.1~1.1.1.255)

○

ipAddrEnd

String

IP 범위 주소

macAddr

String

MAC 주소

○

3.3.4. HTTP response

HTTP/1.1 200 OK

3.3.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/ipmac' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "index" : 0,
  "sno" : null,
  "ipAddr" : "2.2.2.2",
  "ipAddrEnd" : "2.2.2.255",
  "macAddr" : "00:00:00:00:00:00"
}'

3.4. 사용자 IP/MAC 삭제

등록된 사용자의 IP/MAC을 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.4.1. HTTP request

DELETE /dbsafer/api/v1/users/gdhong/ipmac/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

3.4.2. Path parameters

Table 1. /dbsafer/api/v1/users/{userId}/ipmac/{ipMacIdx}
Parameter Description

userId

사용자 ID

ipMacIdx

삭제 대상인 IP/MAC의 index
값이 0인 경우 보안계정의 모든 IP/MAC 삭제

3.4.3. HTTP response

HTTP/1.1 200 OK

3.4.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/users/gdhong/ipmac/1' -i -X DELETE \
    -H 'Accept: application/json'

(주)피앤피시큐어

대표이사   박천오

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

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

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


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