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
현재 로그인한 사용자를 업데이트하는 방법입니다.
반면 대부분 API 메서드는 파트너 관리자만 호출할 수 있으며, 관리자가 아닌 사용자도 호출할 수 있습니다.
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
현재 로그인한 사용자를 업데이트하는 방법입니다.
반면 대부분 API 메서드는 파트너 관리자만 호출할 수 있으며, 관리자가 아닌 사용자도 호출할 수 있습니다.
POST /users/self/update-password
{ "oldPassword" : "old password", "newPassword" : "new password" }
반환 200 OK
성공하면 반환 400 Bad Request
두 암호 중 하나에 문제가 있는 경우.
A PUT
현재 로그인한 사용자를 재설정하는 방법. Audience Management 시스템에서 생성한 암호를 사용자에게 보냅니다.
반면 대부분 API 메서드는 파트너 관리자만 호출할 수 있으며, 관리자가 아닌 사용자도 호출할 수 있습니다.
POST /self/reset-password
반환 200 OK
성공하면
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
현재 로그인한 사용자의 사용자 개체를 반환하는 메서드입니다.
반면 대부분 API 메서드는 파트너 관리자만 호출할 수 있으며, 관리자가 아닌 사용자도 호출할 수 있습니다.
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>, ...]}