Motimate：パブリックAPIを使用してユーザーとグループをプロビジョニングおよび管理するには？

ソースシステムを Motimate の REST API に接続すると、Motimate でユーザーをプロビジョニングおよび管理できます。 これにより、ユーザーの作成、ユーザーの更新、ユーザーの削除、グループの作成、適切なグループへのユーザーのプロビジョニングなど、Motimateのいくつかのコアジョブを処理できるようになります。 

背景情報 

• すべてのユーザーとグループには、APIで使用できる固有のMotimate IDがありますが、APIで使用できる「外部ID」を定義することもできます。 この'外部ID'は通常、ユーザーまたはグループのデータ・ソースにあるIDと一致するように設定される。 
   
• グループは、階層またはグループツリーを作成するために使用されます。 これは通常、あなたの組織構造を忠実に反映したものであり、トレーニングの委任やレポートの取得に使用される。 これは多くの場合、部門やチーム、あるいは地域に基づいている。 ユーザーを作成する前にグループを作成し、作成時にユーザーを直接グループに割り当てることができるようにすることをお勧めします。 グループ構成についてはこちらを参照。
   
• ユーザーのポジションでは、組織での役割に基づいてトレーニングを委任することができます。 ユーザーポジションの詳細はこちらをご覧ください。
   
• 本番環境に移行する前に、テスト環境を設定して、コールと統合全体をテストすることをお勧めします。 カスタマー・サクセス・マネージャーまたはsupport@motimateapp.com までお問い合わせください。 
   
• Motimate の API は JSON 形式です。 

グループの作成

グループを作成するには、以下の呼び出しを使用します：
POST https://motimateapp.com/public_api/groups

ペイロードをボディに追加し、必要な情報をグループとともに追加する。 parent_id」フィールドは、グループ構造を作成するために使用される。 このフィールドに別のグループのIDを入力すると、そのグループが親として設定される。

注意：グループのレベルは親グループより下位の階層でなければならず、「レベル1」が最上位となります。 これにより、グループ構造をMotimateアカウントにインポートできます。 

グループの更新 

Motimateでグループを更新するには、以下の呼び出しが必要です。 この例で使用されているidは、Motimateのグループidです。 

パッチ https://motimateapp.com/public_api/groups/{group_id}

ボディにペイロードを追加し、グループ上で更新したい必要なデータを追加する。 これは、グループを別のレベルに移動する必要がある場合や、構造を調整する必要がある場合に使用できる。 

 

グループの削除

Motimateでグループを削除するには、以下の呼び出しが必要です。 この例で使用されているidは、Motimateのグループidです。 フォースを´1´に設定すると、記録はハード的に破壊され、このシナリオではグループを回復する方法はありません。

削除 https://motimateapp.com/public_api/groups/{group_id}

このコールを実行すると、選択されたグループは削除されるが、応答は返されない：

 

ユーザーの作成

ユーザーを作成するには、以下のコールを使用する： 

ポスト https://motimateapp.com/public_api/users

ボディにペイロードを追加し、ユーザーの必要な情報を追加する。 Motimateアカウントの設定に応じて、メールアドレスまたは電話番号のいずれかが必須フィールドになります。 グループ割り当てフィールドを使用して、ユーザーのグループを選択できます。 ユーザーを所属させたいグループIDと、グループ内での役割（メンバー、管理者、オブザーバー）を入力します。 大半のシナリオでは、assing_ancestorsを'true'に設定することを推奨する。 これにより、ユーザーは割り当てられたグループの親グループのメンバーとなる。 

 

ユーザーの更新

Motimateでユーザー情報を更新するには、以下の呼び出しが必要です。 この例で使用するidは、Motimateのユーザーidです。 

パッチ https://motimateapp.com/public_api/users/{user_id}?identifier_type=id

ユーザーのために更新したい必要なデータだけを本文に追加する。

 

ユーザーの削除

Motimateでユーザーを削除するには、以下の呼び出しが必要です。 この例で使用するidは、Motimateのユーザーidです。 フォースを´1´に設定すると、記録はハード的に破壊され、このシナリオではグループを回復する方法はありません。 0´に設定すると、レコードはソフト的に削除され、必要であれば復元できるようになる。 

削除 https://motimateapp.com/public_api/users/{user_id}?force=1&identifier_type=id

このコールを実行すると、レスポンスは返されないが、選択されたユーザーが削除される： 

ユーザーの復元

ユーザーを誤って削除してしまい、復元する必要がある場合があります。 もし、ハード的な破棄ではなく、ソフト的に削除されているのであれば、次のようにすればよい。 この例で使用するidは、Motimateのユーザーidです。 

パッチ https://motimateapp.com/public_api/users/{user_id}/restore?identifier_type=id