MotionBoardは1つのボードをたくさんの人に共有することが得意です。多くの人が見られるよう、管理者は閲覧ユーザーを一人ひとり登録する必要があります。全社的に使う場合などは数十・数百といったユーザーの登録が必要になり手作業だと非常に大変です。このようなとき、MotionBoardのWeb APIを使って一括でユーザー登録ができます!
Web APIの概要・使い方についてはこちらの記事で紹介していますので、まだ読んでいない方はこちらをご一読ください。
リソースURIとパラメータ
ユーザーを登録するWeb APIを使う上でどんな情報が必要でしょうか。マニュアルを見てみましょう!
ここではリソースURIとパラメータについて紹介していきます。リソースURIは下記になります。
rest/directory/import/local/user
次にパラメータです。必須のパラメータとして、次の2つが挙げられます。
- uploadFile・・・ユーザー情報が書かれたCSVファイル
- command・・・ユーザー情報の取り込み方法。今回はユーザーの追加なので”add”でOK
テナントIDやユーザー名など、共通のパラメータについてはマニュアルおよび下記の記事で紹介しています。特にクラウドの場合はテナントIDをCookieで指定するか、URLパラメーターとして必ず指定する必要がありますので注意してください。
登録ユーザーのリストを作成する
リストはカンマ区切りで下記のようなフォーマットで記載します。ヘッダー(項目名)は不要です。
ユーザーID,ユーザー名,パスワード,次回ログイン時にパスワードを変更するか否か
今回はこのようなサンプルを作成してみました。こちらを、「C:\Users」直下に「add_user_list.csv」として保存してください。
"test_user1","test_user1","password123",true
"test_user2","test_user2","password123",true
"test_user3","test_user3","password123",false
実際にWeb APIを叩いてみる
Web APIを使う方法はたくさんありますが、今回はWindows・Linux標準で利用でき、かつ簡単に使えるcURLを使っていきます。cURLの起動方法や、使い方についてはこちらの記事をご覧ください。
Windowsの場合はコマンドブロンプトを開いて、次のコマンドを入力してみましょう。
curl -i -X POST -F "uploadFile=@C:/Users/add_user_list.csv" "https://cloud-up.motionboard.jp/motionboard/rest/directory/import/local/user?tenant=abcd1234&id=user&pw=password&command=add"
ここで、テナントやユーザーID、URLについては環境に合わせてご指定ください。
Enterを押して実行します。コマンドが成功すると、下記のような結果が返ります。特に、一行目の数値に「200」が出ていることを確認してください。
HTTP/1.1 200
Transfer-Encoding: chunked
Date: Thu, 18 May 2023 05:26:59 GMT
Server: MotionBoard 6.4
最後に、MotionBoard側にユーザーが作成されているかどうか確認します。MotionBoardへログインし、[管理]-[システム設定]-[ユーザー]-[ユーザー]とクリックします。
リストに記載したユーザーが登録されていますね!
まとめ
本記事では、大量のユーザーを一括で登録する方法について紹介しました。手作業だと大変な操作も、Web APIで大幅に効率化できます!今回はユーザーを登録するだけでしたが、実際は指名ユーザーへの追加や権限グループの紐づけなども必要になります。これらの設定に対してもWeb APIが用意されているので、引き続き紹介していきます!