ユーザー管理 API メソッド

最終更新日: 2021-06-01
  • トピック:
  • API
    このトピックの詳細を表示

ユーザーを管理する(ユーザーオブジェクトの作成、更新、リスト、削除および返却を含む)ための 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 のユーザーオブジェクトを返す

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

このページ