사용자 관리 API 메서드

Rest API 사용자 개체 작성, 업데이트, 나열, 삭제 및 반환을 포함하여 사용자를 관리하는 방법입니다.

사용자 만들기

A POST 메서드를 사용하여 새 사용자를 만들 수 있습니다.

요청

POST /api/v1/users/

샘플 요청 본문

{
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>,
  "groups" : [<group_1_id>, ...],
  "isAdmin" : true | false
}

응답

{
  "pid" : <integer>,
  "userId": <integer>,
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>,
  "groups" : [<group_1_id>, ...],
  "isAdmin" : <"true"|"false">

}

If isAdmin 가 true로 설정되어 있으면 사용자가 파트너 관리자로 만들어집니다. 이 속성을 사용하면 사용자가 파트너 관리자인지 여부도 알 수 있습니다.

반환 409 Conflict 사용자 이름을 이미 사용 중인 경우.

사용자 업데이트

A PUT 사용자를 업데이트하는 방법입니다.

요청

PUT /api/v1/users/<userId>

샘플 요청 본문

{
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>,
  "groups" : [<group_1_id>, ...]
}

응답

{
  "pid" : <integer>,
  "userId": <integer>,
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "groups" : [<group_1_id>, ...]

}

반환 409 Conflict 사용자 이름을 이미 사용 중인 경우.

로그인한 사용자 업데이트

A PUT 현재 로그인한 사용자를 업데이트하는 방법입니다.

요청

PUT /self/update

샘플 요청 본문

{
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>
}

응답

{
  "userId": <integer>,,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>
}

반환 409 Conflict 사용자 이름을 이미 사용 중인 경우.

로그인한 사용자 암호 업데이트

A PUT 현재 로그인한 사용자를 업데이트하는 방법입니다.

요청

POST /users/self/update-password

샘플 요청 본문

{ "oldPassword" : "old password", "newPassword" : "new password" }

반환 200 OK 성공하면 반환 400 Bad Request 두 암호 중 하나에 문제가 있는 경우.

로그인한 사용자 암호 재설정

A PUT 현재 로그인한 사용자를 재설정하는 방법. Audience Management 시스템에서 생성한 암호를 사용자에게 보냅니다.

요청

POST /self/reset-password

반환 200 OK 성공하면

사용자 ID에 대한 사용자 개체 반환

A Get 메서드를 사용하여 사용자 ID에 대한 사용자 개체를 반환합니다.

요청

GET /api/v1/users/<userId>

응답

{
  "pid" : <integer>,
  "userId": <integer>,
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>,
  "groups" : [<groupd_id_1>, ...]

}

로그인한 사용자에 대한 사용자 개체 반환

A Get 현재 로그인한 사용자의 사용자 개체를 반환하는 메서드입니다.

요청

GET /api/v1/users/self

응답

{
  "pid" : <integer>,
  "userId": <integer>,
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email" : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>,
  "groups" : [<groupd_id_1>, ...]

}

사용자 나열

A GET 사용자를 나열하는 메서드입니다.

요청

GET /api/v1/users/

쿼리 매개 변수에서 여러 그룹 ID를 지정할 수 있습니다.

GET /api/v1/users/?groupId=343&groupdId=12

이 쿼리는 지정된 그룹의 모든 사용자 목록을 반환합니다.

응답

{
  "pid" : <integer>,
  "userId": <integer>,
  "username" : <string>,
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
  "firstName" : <string>,
  "lastName" : <string>,
  "email : <string>,
  "title" : <string_may_be_null>,
  "phoneNumber" : <string_may_be_null>,
  "groups" : [<group_1_id>, ...]

}

사용자 삭제

A DELETE 메서드를 사용하여 사용자를 삭제할 수 있습니다.

요청

DELETE /api/v1/users/<user_id>

반환 204 No Content 성공하면 충돌 반환 시 409 Conflict.

일괄 사용자 삭제

A POST 여러 사용자를 일괄 삭제하는 방법입니다.

요청

POST /api/v1/users/bulk-delete

샘플 요청 본문

{[<user_id_1>, <user_id_2>, ...]}