Mettre à jour un fournisseur d’identité

Article
08/23/2023

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettez à jour les propriétés du fournisseur d’identité spécifié configuré dans le locataire.

Parmi les types de fournisseurs dérivés d’identityProviderBase, vous pouvez actuellement mettre à jour une ressource socialIdentityProvider dans Microsoft Entra ID. Dans Azure AD B2C, cette opération peut actuellement mettre à jour une ressource socialIdentityProvider, openIdConnectIdentityProvider ou appleManagedIdentityProvider .

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)	IdentityProvider.ReadWrite.All	Non disponible.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	IdentityProvider.ReadWrite.All	Non disponible.

Le compte professionnel ou scolaire doit appartenir au moins au rôle Administrateur Microsoft Entra fournisseur d’identité externe.

Requête HTTP

PATCH /identity/identityProviders/{id}

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 un objet JSON avec une ou plusieurs propriétés qui doivent être mises à jour pour un objet socialIdentityProvider dans Microsoft Entra locataire.

Dans Azure AD B2C, fournissez un objet JSON avec une ou plusieurs propriétés qui doivent être mises à jour pour un objet socialIdentityProvider, openIdConnectIdentityProvider ou appleManagedIdentityProvider .

objet socialIdentityProvider

Propriété	Type	Description
clientId	String	Identificateur de client pour l’application obtenue lors de l’inscription de l’application auprès du fournisseur d’identité.
clientSecret	String	Clé secrète client pour l’application obtenue lorsque l’application est inscrite auprès du fournisseur d’identité. En écriture seule. Une opération de lecture retourne `****`.
displayName	Chaîne	Nom d’affichage du fournisseur d’identité.

objet openIdConnectIdentityProvider

Propriété	Type	Description
clientId	String	Identificateur de client pour l’application obtenue lors de l’inscription de l’application auprès du fournisseur d’identité.
clientSecret	String	Il s’agit d’une clé secrète client pour l’application obtenue lors de l’inscription de l’application auprès du fournisseur d’identité. ClientSecret a une dépendance sur responseType. Lorsque responseType a la valeur `code`, un secret est requis pour l’échange de code d’authentification. Lorsque responseType est `id_token` le secret n’est pas obligatoire, car il n’y a pas d’échange de code. Le id_token est retourné directement à partir de la réponse d’autorisation.
displayName	Chaîne	Nom d’affichage du fournisseur d’identité.
domainHint	Chaîne	L’indicateur de domaine peut être utilisé pour passer directement à la page de connexion du fournisseur d’identité spécifié, au lieu de faire une sélection par l’utilisateur dans la liste des fournisseurs d’identité disponibles.
claimsMapping	claimsMapping	Une fois que le fournisseur OIDC a renvoyé un jeton d’ID à Microsoft Entra ID, Microsoft Entra ID doit être en mesure de mapper les revendications du jeton reçu aux revendications que Microsoft Entra ID reconnaît et utilise. Ce type complexe capture ce mappage.
metadataUrl	Chaîne	URL du document de métadonnées du fournisseur d’identité OpenID Connect. Chaque fournisseur d’identité OpenID Connect décrit un document de métadonnées qui contient la plupart des informations requises pour effectuer la connexion. Cela inclut des informations telles que les URL à utiliser et l’emplacement des clés de signature publiques du service. Le document de métadonnées OpenID Connect se trouve toujours sur un point de terminaison qui se termine par `.well-known/openid-configuration`. Fournissez l’URL des métadonnées pour le fournisseur d’identité OpenID Connect que vous ajoutez.
responseMode	Chaîne	Le mode de réponse définit la méthode utilisée pour renvoyer des données du fournisseur d’identité personnalisé vers Azure AD B2C. Valeurs possibles : `form_post`, `query`.
responseType	Chaîne	Le type de réponse décrit le type d’informations renvoyées dans l’appel initial à l’authorization_endpoint du fournisseur d’identité personnalisé. Valeurs possibles : `code` , `id_token` , `token`.
étendue	Chaîne	L’étendue définit les informations et les autorisations que vous souhaitez collecter à partir de votre fournisseur d’identité personnalisé.

objet appleManagedIdentityProvider

Propriété	Type	Description
displayName	Chaîne	Nom d’affichage du fournisseur d’identité.
developerId	Chaîne	Identificateur de développeur Apple.
serviceId	Chaîne	L’identificateur de service Apple.
keyId	Chaîne	L’identificateur de la clé Apple.
certificateData	Chaîne	Les données de certificat, qui sont une longue chaîne de texte du certificat, peuvent être null.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content. Si elle échoue, une erreur 4xx est renvoyée avec des détails spécifiques.

Exemples

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "clientSecret": "1111111111111"
}


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

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

var requestBody = new SocialIdentityProvider
{
	OdataType = "#microsoft.graph.socialIdentityProvider",
	ClientSecret = "1111111111111",
};

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

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

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).



mgc-beta identity identity-providers patch --identity-provider-base-id {identityProviderBase-id} --body '{\
  "@odata.type": "#microsoft.graph.socialIdentityProvider",\
  "clientSecret": "1111111111111"\
}\
'

Importante



// 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.NewIdentityProviderBase()
clientSecret := "1111111111111"
requestBody.SetClientSecret(&clientSecret) 

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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SocialIdentityProvider identityProviderBase = new SocialIdentityProvider();
identityProviderBase.setOdataType("#microsoft.graph.socialIdentityProvider");
identityProviderBase.setClientSecret("1111111111111");
IdentityProviderBase result = graphClient.identity().identityProviders().byIdentityProviderBaseId("{identityProviderBase-id}").patch(identityProviderBase);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const identityProviderBase = {
  '@odata.type': '#microsoft.graph.socialIdentityProvider',
  clientSecret: '1111111111111'
};

await client.api('/identity/identityProviders/Amazon-OAUTH')
	.version('beta')
	.update(identityProviderBase);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SocialIdentityProvider;


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

$requestBody = new SocialIdentityProvider();
$requestBody->setOdataType('#microsoft.graph.socialIdentityProvider');
$requestBody->setClientSecret('1111111111111');

$result = $graphServiceClient->identity()->identityProviders()->byIdentityProviderBaseId('identityProviderBase-id')->patch($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.socialIdentityProvider"
	clientSecret = "1111111111111"
}

Update-MgBetaIdentityProvider -IdentityProviderBaseId $identityProviderBaseId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.social_identity_provider import SocialIdentityProvider

graph_client = GraphServiceClient(credentials, scopes)

request_body = SocialIdentityProvider(
	odata_type = "#microsoft.graph.socialIdentityProvider",
	client_secret = "1111111111111",
)

result = await graph_client.identity.identity_providers.by_identity_provider_base_id('identityProviderBase-id').patch(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : Mettre à jour un fournisseur d’identité OpenID Connect spécifique (uniquement pour Azure AD B2C)

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/identity/identityProviders/OIDC-V1-Nam_AD_Test-3e393390-ed2d-4794-97f6-5c999ccc61f7
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "responseType": "id_token"
}


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

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

var requestBody = new SocialIdentityProvider
{
	OdataType = "#microsoft.graph.socialIdentityProvider",
	AdditionalData = new Dictionary<string, object>
	{
		{
			"responseType" , "id_token"
		},
	},
};

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

Importante



mgc-beta identity identity-providers patch --identity-provider-base-id {identityProviderBase-id} --body '{\
  "@odata.type": "#microsoft.graph.socialIdentityProvider",\
  "responseType": "id_token"\
}\
'

Importante



// 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.NewIdentityProviderBase()
additionalData := map[string]interface{}{
	"responseType" : "id_token", 
}
requestBody.SetAdditionalData(additionalData)

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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SocialIdentityProvider identityProviderBase = new SocialIdentityProvider();
identityProviderBase.setOdataType("#microsoft.graph.socialIdentityProvider");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("responseType", "id_token");
identityProviderBase.setAdditionalData(additionalData);
IdentityProviderBase result = graphClient.identity().identityProviders().byIdentityProviderBaseId("{identityProviderBase-id}").patch(identityProviderBase);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const identityProviderBase = {
  '@odata.type': '#microsoft.graph.socialIdentityProvider',
  responseType: 'id_token'
};

await client.api('/identity/identityProviders/OIDC-V1-Nam_AD_Test-3e393390-ed2d-4794-97f6-5c999ccc61f7')
	.version('beta')
	.update(identityProviderBase);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SocialIdentityProvider;


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

$requestBody = new SocialIdentityProvider();
$requestBody->setOdataType('#microsoft.graph.socialIdentityProvider');
$additionalData = [
	'responseType' => 'id_token',
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->identity()->identityProviders()->byIdentityProviderBaseId('identityProviderBase-id')->patch($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.socialIdentityProvider"
	responseType = "id_token"
}

Update-MgBetaIdentityProvider -IdentityProviderBaseId $identityProviderBaseId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.social_identity_provider import SocialIdentityProvider

graph_client = GraphServiceClient(credentials, scopes)

request_body = SocialIdentityProvider(
	odata_type = "#microsoft.graph.socialIdentityProvider",
	additional_data = {
			"response_type" : "id_token",
	}
)

result = await graph_client.identity.identity_providers.by_identity_provider_base_id('identityProviderBase-id').patch(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 3 : Mettre à jour un fournisseur d’identité Apple spécifique (uniquement pour Azure AD B2C)

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/identity/identityProviders/Apple-Managed-OIDC
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "displayName": "Apple"
}


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

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

var requestBody = new SocialIdentityProvider
{
	OdataType = "#microsoft.graph.socialIdentityProvider",
	DisplayName = "Apple",
};

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

Importante



mgc-beta identity identity-providers patch --identity-provider-base-id {identityProviderBase-id} --body '{\
  "@odata.type": "#microsoft.graph.socialIdentityProvider",\
  "displayName": "Apple"\
}\
'

Importante



// 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.NewIdentityProviderBase()
displayName := "Apple"
requestBody.SetDisplayName(&displayName) 

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

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SocialIdentityProvider identityProviderBase = new SocialIdentityProvider();
identityProviderBase.setOdataType("#microsoft.graph.socialIdentityProvider");
identityProviderBase.setDisplayName("Apple");
IdentityProviderBase result = graphClient.identity().identityProviders().byIdentityProviderBaseId("{identityProviderBase-id}").patch(identityProviderBase);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const identityProviderBase = {
  '@odata.type': '#microsoft.graph.socialIdentityProvider',
  displayName: 'Apple'
};

await client.api('/identity/identityProviders/Apple-Managed-OIDC')
	.version('beta')
	.update(identityProviderBase);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SocialIdentityProvider;


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

$requestBody = new SocialIdentityProvider();
$requestBody->setOdataType('#microsoft.graph.socialIdentityProvider');
$requestBody->setDisplayName('Apple');

$result = $graphServiceClient->identity()->identityProviders()->byIdentityProviderBaseId('identityProviderBase-id')->patch($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.socialIdentityProvider"
	displayName = "Apple"
}

Update-MgBetaIdentityProvider -IdentityProviderBaseId $identityProviderBaseId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.social_identity_provider import SocialIdentityProvider

graph_client = GraphServiceClient(credentials, scopes)

request_body = SocialIdentityProvider(
	odata_type = "#microsoft.graph.socialIdentityProvider",
	display_name = "Apple",
)

result = await graph_client.identity.identity_providers.by_identity_provider_base_id('identityProviderBase-id').patch(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Share via

Mettre à jour un fournisseur d’identité

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

objet socialIdentityProvider

objet openIdConnectIdentityProvider

objet appleManagedIdentityProvider

Réponse

Exemples

Demande

Réponse

Exemple 2 : Mettre à jour un fournisseur d’identité OpenID Connect spécifique (uniquement pour Azure AD B2C)

Demande

Réponse

Exemple 3 : Mettre à jour un fournisseur d’identité Apple spécifique (uniquement pour Azure AD B2C)

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires

Share via

Mettre à jour un fournisseur d’identité

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

objet socialIdentityProvider

objet openIdConnectIdentityProvider

objet appleManagedIdentityProvider

Réponse

Exemples

Exemple 1 : Mettre à jour un fournisseur d’identité sociale spécifique (Microsoft Entra ID ou Azure AD B2C)

Demande

Réponse

Exemple 2 : Mettre à jour un fournisseur d’identité OpenID Connect spécifique (uniquement pour Azure AD B2C)

Demande

Réponse

Exemple 3 : Mettre à jour un fournisseur d’identité Apple spécifique (uniquement pour Azure AD B2C)

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires