agentIdentity の更新

名前空間: microsoft.graph

重要

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

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

agentIdentity オブジェクトのプロパティを更新します。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AgentIdentity.EnableDisable.All AgentIdentity.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AgentIdentity.EnableDisable.All, AgentIdentity.CreateAsManager AgentIdentity.ReadWrite.All

重要

  • エージェント ID ブループリントまたはブループリント プリンシパルを作成したプリンシパルは、自動的に所有者として割り当てられます。
  • 所有者は、エージェントIDロールを割り当てなくても、所有するブループリントに関連付けられたエージェントIDを作成および変更できます。
  • 非所有者が委任されたシナリオで職場または学校アカウントを使用してこの API を呼び出すには、管理者にサポートされている Microsoft Entra ロールが割り当てられている必要があります。 この操作では、次の最小特権の組み込みロールがサポートされます。

特定のシナリオのアクセス許可

  • customSecurityAttributes プロパティを更新するには:
    • 委任されたシナリオでは、管理者に 属性割り当て管理者 ロールを割り当て、アプリに CustomSecAttributeAssignment.ReadWrite.All と AgentIdentity.ReadWrite.All の委任されたアクセス許可を付与する必要があります。
    • Microsoft Graph のアクセス許可を使用するアプリのみのシナリオでは、アプリに CustomSecAttributeAssignment.ReadWrite.All アプリケーションのアクセス許可を付与する必要があります。

HTTP 要求

PATCH /servicePrincipals/{id}/microsoft.graph.agentIdentity

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。 最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。

displayName を変更する場合は、エージェント ID の表示名文字ルールに従う必要があります。 displayName を変更しない Updates は、この文字検証の対象ではありません。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

displayName を禁止文字が含まれる値に変更する要求は、displayName のプロパティ固有のProhibitedCharactersInDisplayNameエラー コードを含む400 Bad Requestを返します。 エラー メッセージは、禁止されている Unicode コード ポイントを識別します。

エージェント ID API によって返されるエラーの詳細については、「 エージェント ID エラー コード」を参照してください。

例

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/servicePrincipals/{id}/microsoft.graph.agentIdentity
Content-type: application/json

{
  "displayName": "My New Name"
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content
  • 最終更新: