名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
agentIdentity オブジェクトのリストを取得します。 他の種類のサービス プリンシパル オブジェクトは返しません。
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | AgentIdentity.Read.All | AgentIdentity.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | AgentIdentity.Read.All | AgentIdentity.ReadWrite.All |
重要
- エージェント ID ブループリントまたはブループリント プリンシパルを作成したプリンシパルは、自動的に所有者として割り当てられます。
- 所有者は、エージェントIDロールを割り当てなくても、所有するブループリントに関連付けられたエージェントIDを作成および変更できます。
- 非所有者が委任されたシナリオで職場または学校アカウントを使用してこの API を呼び出すには、管理者にサポートされている Microsoft Entra ロールが割り当てられている必要があります。 この操作では、次の最小特権の組み込みロールがサポートされます。
HTTP 要求
GET /servicePrincipals/microsoft.graph.agentIdentity
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするために、 $count、 $expand、 $filter、 $orderby、 $search、 $select、および $topOData クエリ パラメーター をサポートします。 既定および最大ページ サイズは、100 エージェント ID オブジェクトです。 クエリの中には、ConsistencyLevel ヘッダーの設定を eventual および $count に使用した場合にのみサポートされるものもあります。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| ConsistencyLevel | 最終的。 このヘッダーと $count は、$search を使用する場合、または $filter の特別な使用をする場合に必要です。
ConsistencyLevel と $count の使用方法の詳細については、「ディレクトリ オブジェクトの高度なクエリ機能」を参照してください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文の agentIdentity オブジェクトのコレクションを返します。
例
要求
GET https://graph.microsoft.com/beta/servicePrincipals/microsoft.graph.agentIdentity
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"id": "1b7313c4-05d0-4a08-88e3-7b76c003a0a2",
"displayName": "My Agent Identity",
"createdDateTime": "2019-09-17T19:10:35.2742618Z",
"createdByAppId": "00001111-aaaa-2222-bbbb-3333cccc4444",
"agentIdentityBlueprintId": "00001111-aaaa-2222-bbbb-3333cccc4444",
"accountEnabled": true,
"disabledByMicrosoftStatus": null,
"servicePrincipalType": "ServiceIdentity",
"tags": []
}
]
}