Mettre à jour une application

Espace de noms: microsoft.graph

Mettez à jour les propriétés d’un objet application .

Importante

L’utilisation d’un correctif pour établir passwordCredential n’est pas prise en charge. Utilisez les méthodes addPassword et removePassword pour mettre à jour le mot de passe ou le secret d’une application.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Application.ReadWrite.All	Non disponible.
Déléguée (compte Microsoft personnel)	Application.ReadWrite.All	Non disponible.
Application	Application.ReadWrite.OwnedBy	Application.ReadWrite.All

Requête HTTP

Vous pouvez traiter l’application à l’aide de son id ou de son id d’application. id et appId sont respectivement appelés ID d’objet et ID d’application (client) dans les inscriptions d’applications dans le centre d'administration Microsoft Entra. Remplacez par {applicationObjectId}l’ID de l’objet application.

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

Pour mettre à jour le logo, utilisez la méthode PUT comme suit.

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

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Propriété	Type	Description
api	apiApplication	Spécifie les paramètres d’une application qui implémente une API Web.
appRoles	Collection de appRole	Collection de rôles définis pour l’application. Ces rôles peuvent être affectés à des utilisateurs, des groupes ou des principaux de service. Ne pouvant accepter la valeur null.
displayName	String	Nom d’affichage de l’application.
groupMembershipClaims	String	Configure la revendication de groupes émise dans un jeton d’accès utilisateur ou OAuth 2.0 attendu par l’application. Pour définir cet attribut, utilisez l’une des valeurs de chaîne valides suivantes : None SecurityGroup: pour les groupes de sécurité et les rôles Microsoft Entra All: obtient tous les groupes de sécurité, groupes de distribution et rôles d’annuaire Microsoft Entra dont l’utilisateur connecté est membre
identifierUris	String collection	URI qui identifient l’application au sein de son locataire Microsoft Entra ou au sein d’un domaine personnalisé vérifié si l’application est multilocataire. Pour en savoir plus, consultez l’article Objets application et principal du service. L’opérateur any est requis pour les expressions de filtre sur des propriétés à valeurs multiples. Ne peut accepter une valeur null.
info	informationalUrl	Informations de profil de base de l’application, telles que le marketing, le support, les conditions d’utilisation et les URL de déclaration de confidentialité de l’application. Les conditions d’utilisation et la déclaration de confidentialité sont présentées aux utilisateurs par le biais de l’expérience de consentement de l’utilisateur. Pour plus d’informations, consultez Ajouter des conditions d’utilisation du service et déclaration de confidentialité pour les applications Microsoft Entra inscrites.
isFallbackPublicClient	Boolean	Désigne le type d’application de base comme étant client public (une application installée exécutée sur un appareil mobile, par exemple). La valeur par défaut est false, ce qui signifie que le type d’application de secours est un client confidentiel tel que l’application web. Il existe certains scénarios dans lesquels Microsoft Entra ID ne peuvent pas déterminer le type d’application cliente (par exemple, le flux ROPC où il est configuré sans spécifier d’URI de redirection). Dans ce cas, Microsoft Entra ID interprétera le type d’application en fonction de la valeur de cette propriété.
keyCredentials	Collection keyCredential	Collection d’informations d’identification clés associées à l’application. Ne pouvant accepter la valeur null.
logo	Stream	Logo principal de l’application. Ne pouvant accepter la valeur null. Utilisez la méthode PUT pour mettre à jour le logo.
optionalClaims	optionalClaims	Les développeurs d’applications peuvent configurer des revendications facultatives dans leurs applications Microsoft Entra pour spécifier les revendications qu’ils souhaitent dans les jetons envoyés à leur application par le service de jeton de sécurité Microsoft. Pour plus d’informations , consultez revendications facultatives .
parentalControlSettings	parentalControlSettings	Spécifie les paramètres de contrôle parental d’une application.
publicClient	publicClientApplication	Spécifie les paramètres des clients installés, tels que les appareils mobiles ou de bureau.
requiredResourceAccess	collection requiredResourceAccess	Spécifie les ressources auxquelles l’application doit accéder. Cette propriété spécifie également l’ensemble des autorisations déléguées et des rôles d’application dont elle a besoin pour chacune de ces ressources. Cette configuration de l'accès aux ressources requises détermine l'expérience du consentement. Vous ne pouvez pas configurer plus de 50 services de ressources (API). À compter de la mi-octobre 2021, le nombre total d’autorisations requises ne doit pas dépasser 400. Ne pouvant accepter la valeur null.
samlMetadataUrl	Chaîne	L’URL dans laquelle le service affiche les métadonnées SAML pour la fédération. Cette propriété est valide uniquement pour les applications monolocataires.
signInAudience	String	Indique les comptes Microsoft pris en charge pour l’application en cours. Les valeurs prises en charge sont : AzureADMyOrg: utilisateurs disposant d’un compte professionnel ou scolaire Microsoft dans le locataire Microsoft Entra de mon organization (c’est-à-dire un seul locataire) AzureADMultipleOrgs: utilisateurs disposant d’un compte professionnel ou scolaire Microsoft dans le locataire Microsoft Entra de n’importe quel organization (c’est-à-dire multilocataire) AzureADandPersonalMicrosoftAccount: utilisateurs disposant d’un compte Microsoft personnel ou d’un compte professionnel ou scolaire dans le locataire Microsoft Entra d’un organization La valeur de cette propriété a des implications sur d’autres propriétés d’objet d’application. Par conséquent, si vous modifiez cette propriété, vous devrez peut-être d’abord modifier d’autres propriétés. Pour plus d’informations, consultez Différences de validation pour signInAudience.
SPA	spaApplication	Spécifie les paramètres d’une application à page unique, y compris les URL de connexion et les URLs de redirection des codes d’autorisation et des jetons d’accès.
étiquettes	String collection	Chaînes personnalisées qui peuvent servir à catégoriser et à identifier l’application. Ne pouvant accepter la valeur null.
tokenEncryptionKeyId	String	Spécifie la keyId d’une clé publique de la collection keyCredentials. Une fois configuré, Microsoft Entra ID chiffre tous les jetons qu’il émet à l’aide de la clé vers laquelle pointe cette propriété. Le code d'application qui reçoit le jeton chiffré doit utiliser la clé privée correspondante pour déchiffrer le jeton avant de pouvoir l'utiliser pour l'utilisateur connecté.
web	WebApplication	Spécifie les paramètres d’une application web.

Réponse

Si elle réussit, cette méthode renvoie un 204 No Content code de réponse et ne retourne rien dans le corps de la réponse.

Exemples

Exemple 1 : Mettre à jour le displayName pour une application

Demande

L’exemple suivant illustre la demande.

HTTP

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

{
  "displayName": "New display name"
}

C#

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

// Dependencies
using Microsoft.Graph.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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc applications patch --application-id {application-id} --body '{\
  "displayName": "New display name"\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

applications, err := graphClient.Applications().ByApplicationId("application-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// 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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

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

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\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();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Applications

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

Update-MgApplication -ApplicationId $applicationId -BodyParameter $params

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.application import Application

graph_client = GraphServiceClient(credentials, scopes)

request_body = Application(
	display_name = "New display name",
)

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

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

HTTP/1.1 204 No Content

Exemple 2 : Mettre à jour les rôles d’application pour une application

L’exemple suivant met à jour la collection appRoles pour une application. Pour conserver les rôles d’application existants, incluez-les dans la demande. Tous les objets existants dans la collection qui ne sont pas inclus dans la requête sont remplacés par les nouveaux objets. Cet objet est synchronisé avec la propriété correspondante du principal de service dans le locataire.

Demande

HTTP

PATCH https://graph.microsoft.com/v1.0/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"
        }
    ]
}

C#

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

// Dependencies
using Microsoft.Graph.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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc 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"\
        }\
    ]\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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)

applications, err := graphClient.Applications().ByApplicationId("application-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// 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);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

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')
	.update(application);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Application;
use Microsoft\Graph\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();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.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-MgApplication -ApplicationId $applicationId -BodyParameter $params

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.application import Application
from msgraph.generated.models.app_role import AppRole

graph_client = GraphServiceClient(credentials, scopes)

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)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

HTTP/1.1 204 No Content