사용자 관리 API 메서드 user-management-api-methods

사용자 개체 만들기, 업데이트, 목록, 삭제 및 반환을 포함하여 사용자를 관리하는 나머지 API 메서드입니다.

사용자 만들기 create-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">

}

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

사용자 이름을 이미 사용한 경우 409 Conflict을(를) 반환합니다.

사용자 업데이트 update-user

사용자를 업데이트하는 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을(를) 반환합니다.

로그인한 사용자 업데이트 update-logged-in-user

현재 로그인한 사용자를 업데이트하는 PUT 메서드입니다.

NOTE
대부분의 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을(를) 반환합니다.

로그인한 사용자 암호 업데이트 update-logged-in-user-pw

현재 로그인한 사용자를 업데이트하는 PUT 메서드입니다.

NOTE
대부분의 API 메서드는 파트너 관리자만 호출할 수 있지만 이 메서드는 관리자가 아닌 사용자도 호출할 수 있습니다.

요청

POST /users/self/update-password

샘플 요청 본문

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

성공하면 200 OK을(를) 반환합니다. 암호가 잘못되면 400 Bad Request을(를) 반환합니다.

로그인한 사용자 암호 재설정 reset-logged-in-user-pw

현재 로그인한 사용자를 재설정하는 PUT 메서드입니다. Audience Management이(가) 시스템에서 생성한 암호를 사용자에게 보냅니다.

NOTE
대부분의 API 메서드는 파트너 관리자만 호출할 수 있지만 이 메서드는 관리자가 아닌 사용자도 호출할 수 있습니다.

요청

POST /self/reset-password

성공하면 200 OK을(를) 반환합니다.

사용자 ID에 대한 사용자 개체 반환 return-user-object-for-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>, ...]

}

로그인한 사용자에 대한 사용자 개체 반환 return-user-object-for-logged-in-user

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

NOTE
대부분의 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>, ...]

}

사용자 나열 list-users

사용자를 나열하는 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-users

사용자를 삭제하는 DELETE 메서드입니다.

요청

DELETE /api/v1/users/<user_id>

성공하면 204 No Content을(를) 반환합니다. 충돌이 발생하면 409 Conflict을(를) 반환합니다.

일괄 사용자 삭제 delete-users-bulk

여러 사용자를 일괄 삭제하는 POST 메서드입니다.

요청

POST /api/v1/users/bulk-delete

샘플 요청 본문

{[<user_id_1>, <user_id_2>, ...]}
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695