アプリケーションを更新する

[アーティクル]
03/10/2024

名前空間: microsoft.graph

重要

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

アプリケーションオブジェクトのプロパティを更新します。

重要

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

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

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

アクセス許可

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

アクセス許可の種類	最小特権アクセス許可	より高い特権のアクセス許可
委任 (職場または学校のアカウント)	Application.ReadWrite.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	Application.ReadWrite.All	注意事項なし。
アプリケーション	Application.ReadWrite.OwnedBy	Application.ReadWrite.All

HTTP 要求

アプリケーションのアドレスは、 その ID または appId を使用して行うことができます。 id と appId は、Microsoft Entra 管理センターのアプリ登録では、それぞれ オブジェクト ID と アプリケーション (クライアント) ID と呼ばれます。 {applicationObjectId}をアプリケーションオブジェクトの ID に置き換えます。

PATCH /applications/{applicationObjectId}
PATCH /applications(appId='{appId}')

ロゴを更新するには、次のように PUT メソッドを使用します。

PUT /applications/{applicationObjectId}/logo
PUT /applications(appId='{appId}')/logo

要求ヘッダー

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

要求本文

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

プロパティ	型	説明
api	apiApplication	Web API を実装するアプリケーションの設定を指定します。
appRoles	appRole コレクション	アプリケーションに対して定義されているロールのコレクション。これらのロールは、ユーザー、グループ、サービスプリンシパルなどに割り当てることができます。 null 許容型ではありません。
displayName	String	アプリケーションの表示名。
groupMembershipClaims	String	アプリケーションが予期するユーザーまたは OAuth 2.0 アクセストークンで発行されたグループ要求を構成します。この属性を設定するには、次のいずれかの有効な文字列値を使用します。 `None` `SecurityGroup`: セキュリティグループと Microsoft Entra ロールの場合 `All`: これにより、サインインしているユーザーがのメンバーであるセキュリティグループ、配布グループ、および Microsoft Entra ディレクトリロールがすべて取得されます。
identifierUris	String collection	Microsoft Entra テナント内のアプリケーションを識別する URI、またはアプリケーションがマルチテナントの場合は検証済みのカスタムドメイン内の URI。詳細については、「Application オブジェクトとサービスプリンシパルオブジェクト」を参照してください。複数値プロパティのフィルター式には any 演算子が必要です。 null 許容型ではありません。
info	informationalUrl	アプリのマーケティング、サポート、サービス条件、プライバシーに関する声明の URL など、アプリケーションの基本的なプロファイル情報。サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。詳細については、「登録済みの Microsoft Entra アプリのサービス条件とプライバシーに関する声明を追加する」を参照してください。
isFallbackPublicClient	Boolean	モバイルデバイスで実行するインストール済みアプリケーションなど、フォールバックアプリケーションの種類をパブリッククライアントとして指定します。既定値は `false`です。つまり、フォールバックアプリケーションの種類は Web アプリなどの機密クライアントです。 Microsoft Entra ID でクライアントアプリケーションの種類を特定できないシナリオがあります (たとえば、リダイレクト URI を指定せずに構成されている ROPC フロー)。このような場合、Microsoft Entra ID は、このプロパティの値に基づいてアプリケーションの種類を解釈します。
keyCredentials	keyCredential コレクション	アプリケーションに関連付けられているキー資格情報のコレクションです。 null 許容型ではありません。
logo	Stream	アプリケーションのメインロゴです。 null 許容ではありません。 PUT メソッドを使用してロゴを更新します。
nativeAuthenticationApisEnabled	String	ネイティブ認証 API をアプリケーションが使用してネイティブ認証を提供できるように、ネイティブ認証 API を有効にするかどうかを指定します。使用可能な値は `none`、`all`、および `unknownFutureValue` です。詳細については、「ネイティブ認証」を参照してください。
onPremisesPublishing	onPremisesPublishing	オンプレミスアプリケーションの Microsoft Entra アプリケーションプロキシを構成するためのプロパティのセットを表します。このプロパティは、アプリケーションが作成された後にのみ設定でき、他のアプリケーションプロパティと同じ要求で更新することはできません。
optionalClaims	optionalClaims	アプリケーション開発者は、Microsoft Entra アプリでオプションの要求を構成して、Microsoft セキュリティトークンサービスによってアプリケーションに送信されるトークンで必要な要求を指定できます。詳細については、「省略可能な要求」を参照してください。
parentalControlSettings	parentalControlSettings	アプリケーションにおける、保護者による制限設定を指定します。
publicClient	publicClientApplication	デスクトップやモバイルデバイスなど、インストールされているクライアントの設定を指定します。
requiredResourceAccess	requiredResourceAccess コレクション	アプリケーションがアクセスする必要があるリソースを指定します。このプロパティでは、各リソースに必要な委任されたアクセス許可とアプリケーションロールのセットも指定します。必要なリソースへのアクセスに対するこの構成によって、同意エクスペリエンスが促進されます。 50 を超えるリソースサービス (API) を構成できます。 2021 年 10 月中旬以降は、必要なアクセス許可の合計が 400 を超えることはできません。 null 許容ではありません。
samlMetadataUrl	String	サービスによりフェデレーション用の SAML メタデータが公開されている URL。このプロパティは、シングルテナントアプリケーションに対してのみ有効です。
signInAudience	String	現在のアプリケーションでサポートされている Microsoft アカウントを指定します。サポートされている値は次のとおりです。 `AzureADMyOrg`: 組織の Microsoft Entra テナントに Microsoft 職場または学校アカウントを持つユーザー (つまり、シングルテナント) `AzureADMultipleOrgs`: 任意の組織の Microsoft Entra テナント (マルチテナント) に Microsoft 職場または学校アカウントを持つユーザー `AzureADandPersonalMicrosoftAccount`: 個人の Microsoft アカウントを持つユーザー、または任意の組織の Microsoft Entra テナント内の職場または学校アカウントを持つユーザーこのプロパティの値は、他のアプリオブジェクトプロパティに影響します。その結果、このプロパティを変更する場合は、最初に他のプロパティを変更する必要があります。詳細については、「 signInAudience の検証の違い」を参照してください。
SPA	spaApplication	サインアウト URL、認証コードとアクセストークンのリダイレクト URI など、シングルページアプリケーションの設定を指定します。
tags	String コレクション	アプリケーションを分類および識別するために使用できるカスタム文字列です。 null 許容ではありません。
tokenEncryptionKeyId	String	keyCredentials コレクションにある公開キーの keyId を指定します。構成すると、Microsoft Entra ID は、このプロパティが指すキーを使用して、出力されるすべてのトークンを暗号化します。暗号化されたトークンを受け取るアプリケーションコードでは、一致する秘密キーを使用してトークンを複合化してから、サインインしているユーザーのトークンとして使用する必要があります。
uniqueName	String	アプリケーションに割り当て、代替キーとして使用できる一意の識別子。 `null`し、一度設定すると変更できない場合にのみ更新できます。
uniqueName	String	アプリケーションに代替識別子として割り当て可能な一意の識別子。不変です。読み取り専用です。
Web	webApplication	Web アプリケーションの設定を指定します。
SPA	spaApplication	サインアウト URL、認証コードとアクセストークンのリダイレクト URI など、シングルページアプリケーションの設定を指定します。
windows	windowsApplication	Microsoft Windows を実行し、Microsoft Store または Xbox ゲームストアで公開されているアプリの設定を指定します。承認コードとアクセストークンのパッケージ SID とリダイレクト URI が含まれています。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返し、応答本文では何も返しません。

例

例 1: アプリケーションの displayName を更新する

要求

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

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

{
  "displayName": "New display name"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Application
{
	DisplayName = "New display name",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Applications["{application-id}"].PatchAsync(requestBody);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta applications patch --application-id {application-id} --body '{\
  "displayName": "New display name"\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewApplication()
displayName := "New display name"
requestBody.SetDisplayName(&displayName) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
applications, err := graphClient.Applications().ByApplicationId("application-id").Patch(context.Background(), requestBody, nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Application application = new Application();
application.setDisplayName("New display name");
Application result = graphClient.applications().byApplicationId("{application-id}").patch(application);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const application = {
  displayName: 'New display name'
};

await client.api('/applications/{id}')
	.version('beta')
	.update(application);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Application;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Application();
$requestBody->setDisplayName('New display name');

$result = $graphServiceClient->applications()->byApplicationId('application-id')->patch($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Applications

$params = @{
	displayName = "New display name"
}

Update-MgBetaApplication -ApplicationId $applicationId -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.application import Application
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Application(
	display_name = "New display name",
)

result = await graph_client.applications.by_application_id('application-id').patch(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

HTTP/1.1 204 No Content

例 2: アプリケーションの appRoles を更新する

次の例では、アプリケーションの appRoles コレクションを更新します。既存のアプリロールを保持するには、それらを要求に含めます。要求に含まれていないコレクション内の既存のオブジェクトは、新しいオブジェクトに置き換えられます。このオブジェクトは、テナント内のサービスプリンシパルの対応するプロパティと同期されます。

要求

PATCH https://graph.microsoft.com/beta/applications/fda284b5-f0ad-4763-8289-31a273fca865
Content-type: application/json

{
    "appRoles": [
        {
            "allowedMemberTypes": [
                "User",
                "Application"
            ],
            "description": "Survey.Read",
            "displayName": "Survey.Read",
            "id": "ebb7c86c-fb47-4e3f-8191-420ff1b9de4a",
            "isEnabled": false,
            "origin": "Application",
            "value": "Survey.Read"
        }
    ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Application
{
	AppRoles = new List<AppRole>
	{
		new AppRole
		{
			AllowedMemberTypes = new List<string>
			{
				"User",
				"Application",
			},
			Description = "Survey.Read",
			DisplayName = "Survey.Read",
			Id = Guid.Parse("ebb7c86c-fb47-4e3f-8191-420ff1b9de4a"),
			IsEnabled = false,
			Origin = "Application",
			Value = "Survey.Read",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Applications["{application-id}"].PatchAsync(requestBody);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



mgc-beta applications patch --application-id {application-id} --body '{\
    "appRoles": [\
        {\
            "allowedMemberTypes": [\
                "User",\
                "Application"\
            ],\
            "description": "Survey.Read",\
            "displayName": "Survey.Read",\
            "id": "ebb7c86c-fb47-4e3f-8191-420ff1b9de4a",\
            "isEnabled": false,\
            "origin": "Application",\
            "value": "Survey.Read"\
        }\
    ]\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewApplication()


appRole := graphmodels.NewAppRole()
allowedMemberTypes := []string {
	"User",
	"Application",
}
appRole.SetAllowedMemberTypes(allowedMemberTypes)
description := "Survey.Read"
appRole.SetDescription(&description) 
displayName := "Survey.Read"
appRole.SetDisplayName(&displayName) 
id := uuid.MustParse("ebb7c86c-fb47-4e3f-8191-420ff1b9de4a")
appRole.SetId(&id) 
isEnabled := false
appRole.SetIsEnabled(&isEnabled) 
origin := "Application"
appRole.SetOrigin(&origin) 
value := "Survey.Read"
appRole.SetValue(&value) 

appRoles := []graphmodels.AppRoleable {
	appRole,
}
requestBody.SetAppRoles(appRoles)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
applications, err := graphClient.Applications().ByApplicationId("application-id").Patch(context.Background(), requestBody, nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Application application = new Application();
LinkedList<AppRole> appRoles = new LinkedList<AppRole>();
AppRole appRole = new AppRole();
LinkedList<String> allowedMemberTypes = new LinkedList<String>();
allowedMemberTypes.add("User");
allowedMemberTypes.add("Application");
appRole.setAllowedMemberTypes(allowedMemberTypes);
appRole.setDescription("Survey.Read");
appRole.setDisplayName("Survey.Read");
appRole.setId(UUID.fromString("ebb7c86c-fb47-4e3f-8191-420ff1b9de4a"));
appRole.setIsEnabled(false);
appRole.setOrigin("Application");
appRole.setValue("Survey.Read");
appRoles.add(appRole);
application.setAppRoles(appRoles);
Application result = graphClient.applications().byApplicationId("{application-id}").patch(application);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const application = {
    appRoles: [
        {
            allowedMemberTypes: [
                'User',
                'Application'
            ],
            description: 'Survey.Read',
            displayName: 'Survey.Read',
            id: 'ebb7c86c-fb47-4e3f-8191-420ff1b9de4a',
            isEnabled: false,
            origin: 'Application',
            value: 'Survey.Read'
        }
    ]
};

await client.api('/applications/fda284b5-f0ad-4763-8289-31a273fca865')
	.version('beta')
	.update(application);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Application;
use Microsoft\Graph\Beta\Generated\Models\AppRole;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Application();
$appRolesAppRole1 = new AppRole();
$appRolesAppRole1->setAllowedMemberTypes(['User', 'Application', 	]);
$appRolesAppRole1->setDescription('Survey.Read');
$appRolesAppRole1->setDisplayName('Survey.Read');
$appRolesAppRole1->setId('ebb7c86c-fb47-4e3f-8191-420ff1b9de4a');
$appRolesAppRole1->setIsEnabled(false);
$appRolesAppRole1->setOrigin('Application');
$appRolesAppRole1->setValue('Survey.Read');
$appRolesArray []= $appRolesAppRole1;
$requestBody->setAppRoles($appRolesArray);


$result = $graphServiceClient->applications()->byApplicationId('application-id')->patch($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Applications

$params = @{
	appRoles = @(
		@{
			allowedMemberTypes = @(
			"User"
		"Application"
	)
	description = "Survey.Read"
	displayName = "Survey.Read"
	id = "ebb7c86c-fb47-4e3f-8191-420ff1b9de4a"
	isEnabled = $false
	origin = "Application"
	value = "Survey.Read"
}
)
}

Update-MgBetaApplication -ApplicationId $applicationId -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.application import Application
from msgraph_beta.generated.models.app_role import AppRole
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Application(
	app_roles = [
		AppRole(
			allowed_member_types = [
				"User",
				"Application",
			],
			description = "Survey.Read",
			display_name = "Survey.Read",
			id = UUID("ebb7c86c-fb47-4e3f-8191-420ff1b9de4a"),
			is_enabled = False,
			origin = "Application",
			value = "Survey.Read",
		),
	],
)

result = await graph_client.applications.by_application_id('application-id').patch(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

HTTP/1.1 204 No Content

次の方法で共有

アプリケーションを更新する

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

例 1: アプリケーションの displayName を更新する

要求

応答

例 2: アプリケーションの appRoles を更新する

要求

応答

フィードバック

その他のリソース