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形式で設定します。

項目名	フィールド	検索方法 / 設定値
ユーザーID	user_id	部分一致
氏名	user_name	部分一致
メールアドレス	user_mail_address	部分一致
初期表示言語	user_def_disp_langid	0,1,2 0:日本語,1:英語,2:中国語 ※複数検索するときはカンマ指定
所属なし	group_unaffiliated	0 0:所属なし
グループセット名	groupset_name	複数検索（画面ではチェックボックスから選択して検索） ※複数検索するときはカンマ指定
グループ名	group_name	部分一致
種別	user_type	0,1 0:ユーザー,1:ライトユーザー
多要素認証	user_forcemfa	Y 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一括更新動作設定の設定によって異なります。
詳細は、5章管理モード > CSV一括更新動作設定： CSV一括更新動作設定をご参照ください。