agentIdentityBlueprint リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

エージェント ID ブループリントは、Microsoft Entra ID エコシステム内でエージェント ID を作成するためのテンプレートとして機能します。

アプリケーションから継承します。

このリソースは、ここに記載されているもの以外の追加のプロパティを許可するオープン型です。

メソッド

メソッド 戻り値の種類 説明
List agentIdentityBlueprint コレクション agentIdentityBlueprint オブジェクトとそのプロパティのリストを取得します。
Create agentIdentityBlueprint 新しい agentIdentityBlueprint を作成 (登録) します。
Get agentIdentityBlueprint agentIdentityBlueprint オブジェクトのプロパティと関係を読み取ります。
Update agentIdentityBlueprint agentIdentityBlueprint オブジェクトのプロパティを更新します。
Upsert agentIdentityBlueprint 新しいエージェント ID ブループリントが存在しない場合は作成するか、既存のブループリントのプロパティを更新します。
Delete なし agentIdentityBlueprint オブジェクトを削除します。
資格情報
パスワードを追加する passwordCredential エージェント ID ブループリントに強力なパスワードまたはシークレットを追加します。
パスワードを削除する passwordCredential エージェント ID ブループリントからパスワードまたはシークレットを削除します。
キーの追加 keyCredential エージェント ID ブループリントにキー資格情報を追加します。
キーの削除 なし エージェント ID ブループリントからキー資格情報を削除します。
フェデレーション ID 資格情報を一覧表示する federatedIdentityCredential のコレクション フェデレーテッド ID 資格情報オブジェクトとそのプロパティの一覧を取得します。
フェデレーション ID 資格情報の作成 federatedIdentityCredential 新しい federatedIdentityCredential オブジェクトを作成します。
フェデレーション ID 資格情報を取得する federatedIdentityCredential フェデレーション ID 資格情報オブジェクトのプロパティと関係を読み取ります。
フェデレーション ID 資格情報を更新する なし フェデレーション ID 資格情報オブジェクトのプロパティを更新します。
UPSERT フェデレーション ID 資格情報 federatedIdentityCredential 新しい federatedIdentityCredential が存在しない場合は作成するか、既存の federatedIdentityCredential オブジェクトのプロパティを更新します。
フェデレーション ID 資格情報の削除 なし フェデレーション ID 資格情報オブジェクトを削除します。
通信構成
通信を構成する agentCommunicationConfiguration このエージェント ID ブループリントの既定の通信構成を取得します。
communicationConfiguration を更新する agentCommunicationConfiguration このエージェント ID ブループリントの既定の通信構成を更新します。
削除済みアイテム
List directoryObject コレクション 最近削除されたエージェント ID のリストを取得します。
Get directoryObject 最近削除されたエージェント ID のプロパティを取得します。
復元 directoryObject 最近削除したエージェント ID を復元します。
完全に削除 なし エージェント ID を完全に削除します。
所有者
所有者を一覧表示する directoryObject コレクション このエージェント ID ブループリント プリンシパルの所有者を取得します。
所有者の追加 directoryObject このエージェント ID ブループリント プリンシパルに所有者を割り当てます。
所有者を削除する なし このエージェント ID ブループリント プリンシパルから所有者を削除します。
Sponsors
List sponsors directoryObject コレクション このエージェント ID ブループリントのスポンサーを入手してください。 スポンサーは、エージェント ID インスタンスのライフサイクルを承認および管理できるユーザーまたはサービス プリンシパルです。
スポンサーを追加する directoryObject スポンサー コレクションに投稿して、スポンサーを追加します。
Remove sponsors なし directoryObject オブジェクトを削除します。
認証済発行元
Set なし アプリケーションの認証済みの発行元を設定する。
設定解除する なし アプリケーションの認証済み発行元を解除します。

プロパティ

重要

このリソースは アプリケーションから継承されますが、一部のプロパティは適用できず、 null 値または既定値を返します。 これらのプロパティは、次の表から除外されています。

プロパティ 型 説明
api apiApplication Web API を実装するエージェント ID ブループリントの設定を指定します。 アプリケーションから継承されます。
appId String Microsoft Entra ID によって割り当てられるエージェント ID ブループリントの一意識別子。 null 許容ではありません。 読み取り専用です。 アプリケーションから継承されます。
appRoles appRole コレクション エージェント ID ブループリントに対して定義されたロールのコレクション。 アプリ ロールの割り当てを使用して、ユーザー、グループ、または他のアプリケーションのサービス プリンシパルにロールを割り当てることができます。 null 許容ではありません。 アプリケーションから継承されます。
認定 認定 エージェント ID ブループリントのサーティフィケーション状態を指定します。 アプリケーションから継承されます。
createdByAppId String このエージェント ID ブループリントを作成したアプリケーションの appId 。 Microsoft Entra ID によって内部的に設定されます。 読み取り専用です。 アプリケーションから継承されます。
createdDateTime DateTimeOffset エージェント ID ブループリントが登録された日時。 DateTimeOffset 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 読み取り専用です。 アプリケーションから継承されます。
説明 String エージェント ID ブループリントの説明をエンド ユーザーに提供する自由テキスト フィールド。 最大許容サイズは 1,024 文字です。 このプロパティを更新するための最小特権アクセス許可は AgentIdentityBlueprint.UpdateBranding.All です。 アプリケーションから継承されます。
disabledByMicrosoftStatus String Microsoft が登録エージェント ID ブループリントを無効にしたかどうかを指定します。 可能な値は、 null (既定値)、 NotDisabled、 DisabledDueToViolationOfServicesAgreement です (理由として、疑わしい、虐待的、悪意のあるアクティビティ、または Microsoft サービス規約の違反が含まれる場合があります)。 アプリケーションから継承されます。
displayName 文字列 エージェント ID ブループリントの表示名。 最大文字数は 256 文字です。 このプロパティを更新するための最小特権アクセス許可は AgentIdentityBlueprint.UpdateBranding.All です。 アプリケーションから継承されます。
groupMembershipClaims 文字列 エージェント ID ブループリントが想定するユーザーまたは OAuth 2.0 アクセス トークンで発行される groups クレームを構成します。 この属性を設定するには、None、SecurityGroup (セキュリティ グループおよびMicrosoft Entra ロールの場合)、All (これにより、サインインしたユーザーがメンバーであるすべてのセキュリティ グループ、配布グループ、およびMicrosoft Entra ディレクトリの役割が取得されます) のいずれかの文字列値を使用します。 アプリケーションから継承されます。
id 文字列 エージェント ID ブループリント オブジェクトの一意識別子。 このプロパティは、Microsoft Entra 管理センターではオブジェクト ID と呼ばれます。 キー。 null 許容ではありません。 読み取り専用です。 directoryObject から継承されます。
identifierUris String collection アプリ ID URI とも呼ばれるこの値は、エージェント ID ブループリントがリソース アプリとして使用されるときに設定されます。 identifierUris は、API のコードで参照するスコープのプレフィックスとして機能し、Microsoft Entra ID 全体でグローバルに一意である必要があります。 null 許容ではありません。 アプリケーションから継承されます。
info informationalUrl エージェント ID ブループリントの基本的なプロファイル情報 (マーケティング、サポート、サービス利用規約、プライバシーに関する声明の URL など)。 サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。 アプリケーションから継承されます。
isDisabled ブール型 エージェント ID ブループリントを削除せずに非アクティブ化します。 この構成では、エージェント ID ブループリントに関連付けられているサービス プリンシパルが新しいアクセス トークンを取得できるかどうか、または保護されたリソースにアクセスできるかどうかを指定します。 true に設定すると、既存のトークンは、構成された有効期間に基づいて有効期限が切れるまで有効です。 true エージェント ID ブループリントが非アクティブ化されている場合。それ以外の場合は false。 アプリケーションから継承されます。
keyCredentials keyCredential コレクション エージェント ID ブループリントに関連付けられたキー資格情報の収集。 null 許容ではありません。 このプロパティを更新するための最小特権アクセス許可は AgentIdentityBlueprint.AddRemoveCreds.All です。 アプリケーションから継承されます。
managerApplications Guid コレクション このエージェント ID ブループリントのマネージャーとして指定されているアプリケーションのアプリケーション ID のコレクション。 マネージャー・アプリケーションは、 AgentIdentityBlueprintPrincipal.ReadWrite.Allなどの高権限権限の権限を必要とせずに、管理対象ブループリントのエージェント・ブループリント・プリンシパル、エージェントID、エージェント・ユーザーを作成できます。 現時点では、値として設定できるのは Microsoft のファースト パーティ アプリケーション ID のみです。 最大 10 個の値。 null 許容型ではありません。
optionalClaims optionalClaims アプリケーション開発者は、Microsoft Entra エージェント ID ブループリントでオプションの要求を構成して、Microsoft セキュリティ トークン サービスによってアプリケーションに送信される要求を指定できます。 アプリケーションから継承されます。
passwordCredentials passwordCredential コレクション エージェント ID ブループリントに関連付けられたパスワード資格情報の収集。 null 許容ではありません。 このプロパティを更新するための最小特権アクセス許可は AgentIdentityBlueprint.AddRemoveCreds.All です。 アプリケーションから継承されます。

また、 パスワードの追加 API を呼び出して、エージェント ID ブループリントを作成した後にパスワードを追加することもできます。
publisherDomain String エージェント ID ブループリントの検証済みパブリッシャー ドメイン。 読み取り専用です。 アプリケーションから継承されます。
requiredResourceAccess requiredResourceAccess コレクション agentIdentityBlueprint がアクセスする必要があるリソースを指定します。 このプロパティでは、各リソースに必要な委任されたアクセス許可とアプリケーション ロールのセットも指定します。 必要なリソースへのアクセスに対するこの構成によって、同意エクスペリエンスが促進されます。

50 を超えるリソース サービス (API) を構成できます。 必要なアクセス許可の合計数は 400 を超えてはなりません。 詳細については、「 アプリごとに要求されるアクセス許可の制限」を参照してください。 null 許容ではありません。 アプリケーションから継承されます。

$filter (eq、not、ge、le) をサポートします。
serviceManagementReference String サービスまたは資産管理データベースからアプリケーションまたはサービスの連絡先情報を参照します。 Null 許容型。 アプリケーションから継承されます。
signInAudience 文字列 現在のエージェント ID ブループリントでサポートされる Microsoft アカウントを指定します。 指定できる値は、 AzureADMyOrg (既定値)、 AzureADMultipleOrgs、 AzureADandPersonalMicrosoftAccount、 PersonalMicrosoftAccount です。 アプリケーションから継承されます。
tags String collection エージェント ID ブループリントの分類と識別に使用できるカスタム文字列。 null 許容ではありません。 アプリケーションから継承されます。
tokenEncryptionKeyId Guid keyCredentials コレクションにある公開キーの keyId を指定します。 構成されている場合、Microsoft Entra ID は、このプロパティが指すキーを使用して、出力するすべてのトークンを暗号化します。 アプリケーションから継承されます。
uniqueName String エージェント ID ブループリントに割り当てて代替キーとして使用できる一意の識別子。 不変です。 読み取り専用です。 アプリケーションから継承されます。
verifiedPublisher verifiedPublisher エージェント ID ブループリントの検証済み発行元を指定します。 アプリケーションから継承されます。
Web webApplication Web アプリケーションの設定を指定します。 アプリケーションから継承されます。

アプリごとの要求されたアクセス許可の制限

Microsoft Entra ID は、クライアント アプリが要求および同意できるアクセス許可の数を制限します。 これらの制限は、アプリのマニフェストに表示されるアプリのsignInAudience値によって異なります。

signInAudience 許可されたユーザー アプリが要求できるアクセス許可の最大数 アプリが要求できる Microsoft Graph アクセス許可の最大数 1 つの要求で同意できるアクセス許可の最大数
AzureADMyOrg アプリが登録されている組織のユーザー 400 400 約 155 の委任されたアクセス許可と約 300 のアプリケーションのアクセス許可
AzureADMultipleOrgs あらゆるMicrosoft Entra organizationからのユーザー 400 400 約 155 の委任されたアクセス許可と約 300 のアプリケーションのアクセス許可
PersonalMicrosoftAccount コンシューマー ユーザー (Outlook.com、Live.com アカウントなど) 30 30 30
AzureADandPersonalMicrosoftAccount コンシューマー ユーザーと任意のMicrosoft Entra organizationからのユーザー 30 30 30

注:

Microsoft Entra エージェント ID の場合、一部のリスクの高い Microsoft Graph アクセス許可はエージェントに対してグローバルにブロックされ、エージェント ID に付与することはできません。

ブロックされた Microsoft Graph 委任アクセス許可スコープまたはアプリ ロールをrequiredResourceAccessエントリのresourceAccessコレクションに含めると、要求は HTTP 400 Bad Request応答で拒否され、アクセス許可がブロックされ、エージェント ID に付与できないことを示すエラーが表示されます。

エージェントに対してブロックされた Microsoft Graph アクセス許可の一覧については、「 エージェントに対してブロックされている Microsoft Graph アクセス許可」を参照してください。

リレーションシップ

リレーションシップ 型 説明
appManagementPolicies appManagementPolicy コレクション このエージェント ID ブループリントに適用された appManagementPolicy。 microsoft.graph.application から継承
communicationConfiguration agentCommunicationConfiguration このエージェント ID ブループリントから作成されたエージェント ID の既定の通信構成。 エージェント ID は、独自のオーバーライドを定義しない限り、この構成を継承します。
federatedIdentityCredentials federatedIdentityCredential のコレクション エージェント ID ブループリントのフェデレーション ID。 microsoft.graph.application から継承
inheritablePermissions inheritablePermission コレクション 追加の同意なしにエージェント ID に自動的に付与されるリソース アプリケーションのスコープを定義します。
owners directoryObject コレクション このエージェント ID ブループリントの所有者であるディレクトリ オブジェクト。 所有者は、このオブジェクトの変更が許可されている管理者以外のユーザーまたはサービス プリンシパルのセットです。 読み取り専用です。 Null 許容型。 microsoft.graph.application から継承
スポンサー directoryObject コレクション このエージェント ID ブループリントのスポンサー。 スポンサーは、エージェント ID インスタンスのライフサイクルを承認および管理できるユーザーまたはグループです。 作成操作中に必要です。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "@odata.type": "#microsoft.graph.agentIdentityBlueprint",
  "id": "String (identifier)",
  "appId": "String",
  "identifierUris": ["String"],
  "createdByAppId": "String",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "groupMembershipClaims": "String",
  "publisherDomain": "String",
  "requiredResourceAccess": [{"@odata.type": "microsoft.graph.requiredResourceAccess"}],
  "signInAudience": "String",
  "tags": ["String"],
  "tokenEncryptionKeyId": "Guid",
  "uniqueName": "String",
  "serviceManagementReference": "String",
  "certification": {
    "@odata.type": "microsoft.graph.certification"
  },
  "optionalClaims": {
    "@odata.type": "microsoft.graph.optionalClaims"
  },
  "api": {
    "@odata.type": "microsoft.graph.apiApplication"
  },
  "appRoles": [
    {
      "@odata.type": "microsoft.graph.appRole"
    }
  ],
  "info": {
    "@odata.type": "microsoft.graph.informationalUrl"
  },
  "isDisabled": "Boolean",
  "keyCredentials": [
    {
      "@odata.type": "microsoft.graph.keyCredential"
    }
  ],
  "managerApplications": ["Guid"],
  "passwordCredentials": [
    {
      "@odata.type": "microsoft.graph.passwordCredential"
    }
  ],
  "verifiedPublisher": {
    "@odata.type": "microsoft.graph.verifiedPublisher"
  },
  "web": {
    "@odata.type": "microsoft.graph.webApplication"
  }
}
  • 最終更新: