API によるユーザー情報の更新

  • 更新

Learn365 では Learn365 API を使用して、カスタム列とシステム列(一部を除く)のユーザー情報を更新することができます。

ここでは、その方法について説明します。

 

注記:

  • 「ユーザー名」列と「ユーザーはコースカタログにます」列の編集はできません。
  • カスタム同期オプションは、各列に対して個別に有効にできます。特定の列でカスタム同期を有効にした場合、Learn365 はその列に対して Microsoft Azure AD と同期せず、ユーザ列に表示されるデータを構成できます。カスタム同期が無効の列については、データは自動的にMicrosoft Entra ID (Azure Active Directory) から取得されます。
  • Learn365 と Flow365 の両方のユーザーアカウントを更新できます。

 

システム列およびカスタム列のユーザー情報の更新

システム列とカスタム列の両方でユーザーの詳細を更新するには、

PUT /odata/v2/Users('{LoginName}' update user's info  エンドポイントを使用します。

ユーザー情報を更新するには、以下の情報が必要です。

注記:

ユーザー情報の更新に使用する PUT メソッドは、入力された更新情報だけでなく、すべてのユーザー情報を更新します。

そのため、パラメータの現在の情報を維持するには、それらをすべて入力する必要があります。

入力されていないパラメータは、null(つまり、元の情報は削除されます)で上書きされますので注意してください。

 

システム列およびカスタム列のユーザー情報の更新は、以下の手順に沿って行います。

1.https://api.365.systems/  にアクセスし、API キーで認証します。

2.Users セクションに移動し、 PUT /odata/v2/Users('{LoginName}') update user's info エンドポイントを選択し、右上の「Try it out」をクリックします。

3.パラメータを入力します。

  • LoginName:「key: LoginName」フィールドに、情報を更新するユーザーのログイン名を入力します。
  • user:「Edit Value」フィールドに、セッションの詳細情報を入力します。
    • "Title": "string": このリクエストでは、唯一このパラメータが必須です。「string」をシステムに表示されるユーザーのフルネームに置き換えます。

注記:

ユーザー情報の更新に使用する PUT メソッドは、入力された更新情報だけでなく、すべてのユーザー情報を更新します。

そのため、パラメータの現在の情報を維持するには、それらをすべて入力する必要があります。

「Edit Value」フィールドで入力されていないパラメータは、null(つまり、元の情報は削除されます)で上書きされますので注意してください。

システム列のすべてのパラメーターは、ManagerId を除き、文字列です。ManagerId を更新するには、マネージャーのユーザ ーID を入力します。

カスタム列のユーザーの情報を変更するには、”UserFieldValues”の 配列に 「FieldId」パラメーターと 「Value」パラメーターを入力します(FieldId はカスタム列の ID、Value は新しい値)。

入力例:すべてのシステム列と 1 つのカスタム列のユーザーの情報を更新する場合のリクエスト

 

{
"Department": "Research",
"Title": "Joanne Stefani",
"Email": "jstefani@compafi464.onmicrosoft.com",
"City": "Paris",
"Country": "France",
"Office": "Paris",
"JobTitle": "Researcher",
"Company": "Test Ltd.",
"ManagerId": "a98cf457-b3cc-4314-b995-d756fea98de3",
"UserFieldValues":
[
{"FieldId": "1c737e52-ee3b-45b1-aaec-cf981ade934c", "Value": "Senior"}
]
}

 

 

UpdateDetailsRequest.png

 

4.「Execute」を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code 2xx(例:200)は、リクエストが正しく動作したことを示します。
  • エラーが発生した場合、Responses bodyには、問題を説明するコードキーとメッセージキーを含むエラーオブジェクトが含まれます。

UpdateDetailsResponse.png

 

 

カスタム列のユーザー情報の更新

ユーザー情報を更新するには、以下の情報が必要です。

カスタム列のユーザー情報の更新は、以下の手順に沿って行います。

1. https://api.365.systems/  にアクセスし、API キーで認証します。

2.Users セクションを展開し、 POST /odata/v2/Users('{LoginName}')/UpdateUserFieldValues Update user's field values エンドポイントを選択し、右上の「Try it out」をクリックします。

3.パラメータを入力します。

  • LoginName:「key: LoginName」フィールドに、情報を更新するユーザーのログイン名を入力します。
  • 「Edit Value」フィールドに、以下を入力します。
    • "UserFieldValues[]:この配列、に次のパラメータを入力します。
    • "FieldId":"guid":「guid」をカスタム列の ID に置き換えます。
    • "Value": "{}": この列の新しい値を入力します。

UserFieldValues 配列に複数のオブジェクトを配置することで、複数のカスタム列を一度に更新できます。

入力例:複数のカスタム列を更新する

{
"UserFieldValues": [
{ "FieldId": "1c737e52-ee3b-45b1-aaec-cf981ade934c", "Value": "Middle"},
{ "FieldId": "d6ba00b6-692a-4b32-aa55-8cf12cd35fc7", "Value": 12}
]
}

 

UpdateCustomRequest2.png

 

4.「Execute」を選択してリクエストを実行します。

5.Responses ブロックで結果を確認します。

  • Code 2xx(200など)は、リクエストが正しく動作したことを示します。
  • エラーが発生した場合、Responses bodyには、問題を説明するコードキーとメッセージキーを含むエラーオブジェクトが含まれます。