ユーザーを管理する(ユーザーオブジェクトの作成、更新、リスト、削除および返却を含む)ための Rest API メソッド。
新しいユーザーを作成するための 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
が返されます。
ユーザーを更新するための 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 のユーザーオブジェクトを返すための 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
メソッド。
DELETE /api/v1/users/
<user_id>
成功すると 204 No Content
が返されます。競合が発生する場合、409 Conflict
が返されます。
複数のユーザーを一括削除するための POST
メソッド。
POST /api/v1/users/bulk-delete
{[<user_id_1>, <user_id_2>, ...]}