Show Menu
화제×

사용자 관리 API 메서드

사용자 객체 만들기, 업데이트, 목록 작성, 삭제 및 반환 등 사용자를 관리하는 나머지 API 방법입니다.

Create a User

새 사용자를 만드는 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"> 
 
}

true isAdmin 로 설정하면 사용자가 파트너 관리자로 생성됩니다. 또한 이 속성을 사용하여 사용자가 파트너 관리자인지 알 수 있습니다.
사용자 이름 409 Conflict 이 이미 수행된 경우 반환합니다.

사용자 업데이트

사용자를 업데이트하는 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 이 이미 수행된 경우 반환합니다.

로그인한 사용자 업데이트

현재 로그인한 사용자를 업데이트하는 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 이 이미 수행된 경우 반환합니다.

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

현재 로그인한 사용자를 업데이트하는 PUT 방법입니다.
대부분의 API 메서드는 파트너 관리자만 호출할 수 있는 반면 관리자가 아닌 사용자는 이 메서드를 호출할 수 있습니다.

요청

POST /users/self/update-password

샘플 요청 본문

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

성공한 경우 200 OK 반환합니다. 두 암호 중 하나에 잘못된 400 Bad Request 경우 반환합니다.

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

현재 로그인한 사용자를 재설정하는 PUT 방법입니다. Audience Management 사용자에게 시스템 생성 암호를 보냅니다.
대부분의 API 메서드는 파트너 관리자만 호출할 수 있는 반면 관리자가 아닌 사용자는 이 메서드를 호출할 수 있습니다.

요청

POST /self/reset-password
성공한 경우 200 OK 반환합니다.

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

사용자 ID에 대한 사용자 개체를 반환하는 Get 방법입니다.

요청

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>, ...] 
 
}

로그인한 사용자의 사용자 개체 반환

현재 로그인한 사용자의 사용자 개체를 반환하는 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>, ...] 
 
}

사용자 목록

사용자를 나열하는 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>, ...] 
 
}

Delete a User

사용자를 삭제하는 DELETE 방법입니다.

요청

DELETE /api/v1/users/ <user_id>
성공한 경우 204 No Content 반환합니다. 충돌이 재발할 경우 409 Conflict .

사용자 일괄 삭제

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

요청

POST /api/v1/users/bulk-delete

샘플 요청 본문

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