メンバー配置転換APIとは
LINE WORKSにはグループ会社機能といってマルチドメインをひとつのテナントにまとめる機能があります。（申込には諸条件があり、各販売パートナーへご相談ください）
出向や転籍など様々な理由から、所属するドメインを移動させたい（グループ会社テナント内のＡ社ドメイン⇒Ｂ社ドメインへの移動など）場合、LINE WORKSの標準機能では、いちどＡ社ドメインからアカウントを削除し、Ｂ社ドメインで作成し直す必要があります。つまり、これまで該当のアカウントで利用していた、過去のトークやカレンダーなどのデータ履歴を引き継ぐことができません。
そこで「メンバー配置転換API」を使えば、過去のデータを保持したまま、在籍をドメインＡ→ドメインＢに移すことができます。
本記事では、メンバー配置転換に必要な情報をGoogle Sheetにまとめ、一括でAPIを実行するツールを紹介します
配置転換APIを実行するとログインIDが変更になるので、強制ログアウトがかかり、再ログインが必要になります。
外部LINE、LINE WORKS連携用のQRコードや招待URLも変更になります。
トークやカレンダー、外部LINE友だちのトークなど、過去のデータを引き継ぐことが可能ですが、
組織のデータとグループのデータは、API実行時に維持するかを指定する必要があります。
その他制約事項についてドキュメントを参照し、必ず事前検証してください。
必要なもの
・グループ会社環境のLINE WORKS
※移動先ドメインで契約しているライセンス数に、移動するID数ぶんの猶予が必要です
・各グループ会社ドメインのLINE WORKS Developers Consoleへのアクセス権限
・Google Sheetをコピーして、ご自身のGoogle Driveに保存
事前準備
1. LINE WORKS Developersから認証情報をコピー
LINE WORKS Developers Console へアクセスして、アプリを新規追加します
「アプリの説明」に任意のテキストを入力します
「Client ID」をコピーしてメモしておきます
「Client Secret」をコピーしてメモしておきます
「Redirect URL」に任意のURLを入力します
「Domain ID」をコピーしてメモしておきます
「OAuth Scopes」の管理にて、以下のスコープを選択して保存します。
user
directory
「Service Account」をコピーします
「Private Key」の発行ボタンを押してkeyファイルをダウンロードします
2. Google Sheetの設定
Google Sheetをコピーします。
シート「jwtGenerator」を開き、
「事前設定」のフィールドに先ほどコピーした
- Client ID
- Client Secret
- Service Account
- Private Keyのファイル名 (「private_2023xxxxxxxx.key」というような名称)
-
OAuth Scopesはそのまま
を、それぞれ入力します
Private KeyファイルをDriveにアップロードする
つぎに、先ほどLINE WORKS Developers Consoleからダウンロードした
Private Keyファイルを、「LINE WORKS 便利ツール」と同じGoogle Driveのロケーションに配置します。
ロケーションへの移動の仕方は以下
ドラッグ＆ドロップで.keyファイルをアップロード
3. token発行のテスト
jwtGeneratorシートにもどり、
「トークンを発行」ボタンを押します
Access Token と Refresh Tokenに何やら文字列が表示されたら、テスト成功
以後はボタン押せばいつでもTokenを再発行できます
なおAccess Tokenの有効期限は24時間です
文字列がなにも表示されない場合は、
手順を最初から見直してみてください。
これでLINE WORKSのAPIを実行する準備ができました。
移動するユーザIDのデータを入力
Google Sheetの「userMove」シートを開きます
以下のガイドを参照し、移行対象のユーザのデータを入力します
externalKeyやDomainIDといった情報はLINE WORKS Developers Consoleの組織設定 にて設定、参照できます。
| 項目名 | 説明 | サンプル値 | |
|---|---|---|---|
| A | 現在のID | 移動元ドメインのログインID | user@domainA |
| B | 移行後のID | 移動先ドメインのログインID | user@domainB |
| C | 新しいドメインID | 移動先ドメインのID。 | 1000xxxx |
| D | 新しい職級 | 移動先ドメインの職級のexternalKey。（任意） | level101 |
| E | 新しい組織 | 移動先ドメインの組織のexternalKey。（任意） | orgUnit101 |
| F | 新しい役職 | 移動先ドメインの役職のexternalKey。（任意） | position101 |
| G | 旧いドメインID | 移動元ドメインのID。 | 1000yyyy |
| H | 旧い組織 | 移動元ドメインの組織のexternalKey。これまでの組織およびトークルームに残りたい場合に指定する（任意） | orgUnit201 |
| I | 旧い役職 | 移動元ドメインの役職のexternalKey。これまでの組織に残りたい場合に指定する（任意） | position201 |
| J | 旧いドメインのemail | 移行元ドメインの所属組織の兼職emailアドレス。アドバンストプランで必須。@以前のIDパートのテナント内重複不可 | subuser@domainA |
| K | 所属グループの維持 | これまで所属していたグループのトークルームを維持するかどうか。falseにすると過去のグループのデータ閲覧不可 | true |
移動先ドメインの所属組織と、移動元ドメインの所属組織は、それぞれ１つまで指定可能です
（例）
〇 B社営業部に異動し、A社営業部に籍を残す
✖ B社営業部と人事部に兼職し、A社営業部に籍を残す
✖ B社営業部に異動し、A社営業部と人事部に籍を残す
複数の組織に所属させたい場合は、実行後に手動で設定いただくか、適宜コードを改修してください。
移動元ドメインで外部LINE連携を行っていた場合、移動先ドメインでも外部LINE連携が有効になっている必要があります。
配置転換APIを実行
データが入力できたら、「配置転換実行」ボタンを押します
ポップアップ→OK
成功
エラー発生時は、エラーの内容を確認します
また、「log」シートに実行結果のログが保存されます
実行完了後、LINE WORKS の管理画面から、移行が正しく成功していることを確認してください。