user-csv/getOption

ユーザ情報をCSVファイルで取得します。パラメータ指定で絞り込みが可能です。

APIを使用するには、 WebAPIオプションが必要です。

POST
http://example.com/RakWDB/webapi/v1/user-csv/get

リクエスト

ヘッダー

content-type
application/x-www-form-urlencoded
もしくは
multipart/form-data

パラメータ

webapikey 必須
API で設定した認証キーを設定します。
lang 任意
言語区分を設定します。
未設定時は実行ユーザの初期表示言語を使用します。
以下の表示言語を変更できます。
  • CSV のヘッダー部
  • レスポンスのエラーメッセージ
param 任意
検索条件をJSON形式で設定します。
項目名フィールド検索方法 / 設定値
ユーザIDuser_id部分一致
氏名user_name部分一致
メールアドレスuser_mail_address部分一致
初期表示言語user_def_disp_langid0,1,2
0:日本語,1:英語,2:中国語
※複数検索するときはカンマ指定
所属なしgroup_unaffiliated0
0:所属なし
グループセット名groupset_name複数検索
（画面ではチェックボックスから選択して検索）
※複数検索するときはカンマ指定
グループ名group_name部分一致
種別user_type0,1
0:ユーザ,1:ライトユーザ
多要素認証user_forcemfaY
Y:多要素認証を強制する
{
  user_id: "useid",
  user_name:"住友",
  user_mail_address:"sumitomo",
  user_def_disp_langid:"0,1",
  group_unaffiliated:"あ",
  groupset_name:"aaa,bbb",
  group_name:"グループ指定",
  user_type:"0",
  user_forcemfa:"Y"
}

レスポンス

ヘッダー

content-disposition
attachment; filename="user.csv"
content-type
text/x-comma-separated-values;charset=UTF-8

レスポンス

CSVファイルを返却します。CSV書式は、CSV一括更新動作設定 の設定によって異なります。
詳細は、 管理モード / CSV一括更新動作設定： CSV一括更新動作設定 をご参照ください。