upsert agentIdentityBlueprint

名前空間: microsoft.graph

重要

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

新しい エージェント ID ブループリント オブジェクトが存在しない場合は作成するか、既存のオブジェクトのプロパティを更新します。

重要

PATCH を使用して passwordCredential を設定することはサポートされていません。 addPassword メソッドと removePassword メソッドを使用して、エージェント ID ブループリントのパスワードまたはシークレットを更新します。

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

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

アクセス許可

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

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

重要

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

HTTP 要求

アプリケーションを作成または更新するには、クライアント指定の代替キーに uniqueName を指定します。

PATCH /applications(uniqueName='{uniqueName}')/microsoft.graph.agentIdentityBlueprint

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. Required.
Prefer create-if-missing. UPSERT 動作に必須です。それ以外の場合、要求は更新操作として扱われます。

要求本文

リクエストの本文には、 agentIdentityBlueprint オブジェクトの JSON 表現を指定します。 要求本文には、必須プロパティである displayName を含める必要があります。 作成または更新のために、agentIdentityBlueprint に必要な他の書き込み可能なプロパティを指定します。

応答

uniqueName を持つオブジェクトが存在しない場合、このメソッドは応答本文で201 Created応答コードと新しいエージェント ID ブループリント オブジェクトを返します。 エージェント ID ブループリントには、uniqueName 値が割り当てられます。

uniqueName を持つオブジェクトが存在せず、Prefer: create-if-missing ヘッダーが指定されていない場合、このメソッドは404 Not Foundエラー コードを返します。

uniqueName を持つアプリケーション オブジェクトが既に存在する場合、このメソッドはオブジェクトを更新し、204 No Content応答コードを返します。

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

例

要求

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

PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint
Content-Type: application/json
Prefer: create-if-missing

{
  "displayName": "Display name"
}

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#applications/$entity",
    "id": "03ef14b0-ca33-4840-8f4f-d6e91916010e",
    "deletedDateTime": null,
    "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
    "identifierUris": [],
    "createdDateTime": "2019-09-17T19:10:35.2742618Z",
    "displayName": "Display name",
    "groupMembershipClaims": null,
    "optionalClaims": null,
    "publisherDomain": "contoso.onmicrosoft.com",
    "requiredResourceAccess": [],
    "signInAudience": "AzureADandPersonalMicrosoftAccount",
    "tags": [],
    "tokenEncryptionKeyId": null,
    "api": {
        "requestedAccessTokenVersion": 2,
        "acceptMappedClaims": null,
        "knownClientApplications": [],
        "oauth2PermissionScopes": [],
        "preAuthorizedApplications": []
    },
    "appRoles": [],
    "info": {
        "termsOfServiceUrl": null,
        "supportUrl": null,
        "privacyStatementUrl": null,
        "marketingUrl": null,
        "logoUrl": null
    },
    "keyCredentials": [],
    "passwordCredentials": [],
    "uniqueName": "app-65278",
    "web": {
        "redirectUris": [],
        "homePageUrl": null,
        "logoutUrl": null,
        "implicitGrantSettings": {
            "enableIdTokenIssuance": false,
            "enableAccessTokenIssuance": false
        }
    }, 
}
  • 最終更新: