Learn365 APIでは、ユーザーとグループのログイン名を取得することができます。
ここでは、Learn365 APIを通じて ユーザーとグループのログイン名を取得する手順を説明します。
注記:
API では、LoginName パラメータが「userLoginName」と称されることもあります。ここで説明する手順に従って取得したログイン名は、どちらの名称であっても、同じように使用できます。
手順:
1. https://api.365.systems/ にアクセスし、API キーで認証します。
2.Users セクションに移動し、GET /odata/v2/Users Returns the list of Users を選択し、右上の[Try it out]をクリックします。
3.[Execute]を選択してリクエストを実行します。
補足:クエリ オプション パラメータ を設定して レスポンス データの絞り込みや、追加のデータと詳細情報をレスポンスに含めることができます。
次の点に注意してください。
$expand パラメータで、UserFieldValues を指定すると、処理するデータ量が多くなるため、レスポンスが遅くなる可能性があります。
パフォーマンス低下を防ぐために、以下のパラメータの使用を推奨します。
- $select :必要な列(項目)だけ取得する(例:名前とメールアドレスだけなど)
- $skip :先頭から n 件をスキップする(例:1〜100件目を飛ばして、101件目から取得)
- $top :取得する件数を制限する(例:最初の10件だけ取得)
4.Responses ブロックで結果を確認します。
- Code 2xx(202など)は、リクエストが正しく動作したことを示します。
- Response body には、テナントのすべてのユーザーとそのデータが表示され、”LoginName”行に設定されたログイン名が表示されます。Ctrl+F で特定のユーザーまたはグループを検索できます。
- Download オプションを使用すると、API リクエストの結果を JSON フォーマットでローカルデバイスに保存できます。
以下は、Response body でのログイン名の表示例です。
- ユーザーのログイン名
- Microsoft 365 グループのログイン名
- セキュリティグループのログイン名
重要!DirectoryObjectId の使用
場合によっては、LoginName の代わりに DirectoryObjectId を使用することを推奨します。
DirectoryObjectId は、Microsoft Entra 上での一意の識別子(ID)です。
ユーザーのログイン名が変更された場合でも、この ID は変わらないため、システムはこの値を使って確実にユーザーを特定できます。
DirectoryObjectId は、ユーザーの LoginName と同じレスポンスで見つけることができます。