Mettre à jour identityProvider (déconseillé)

Article
01/28/2024

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 .

Attention

Cette API de fournisseur d’identité est déconseillée et cessera de renvoyer des données après mars 2023. Veuillez utiliser la nouvelle API de fournisseur d’identité.

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

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 /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 identityProvider ou openIdConnectProvider (uniquement pour Azure AD B2C).

objet identityProvider

Propriété	Type	Description
clientId	Chaîne	ID client pour l’application. Il s’agit de l’ID client obtenu lors de l’inscription de l’application avec le fournisseur d’identité.
clientSecret	Chaîne	Clé secrète client pour l’application. Il s’agit de la clé secrète client obtenue lors de l’inscription de l’application avec le fournisseur d’identité.
name	Chaîne	Nom d’affichage du fournisseur d’identité.
type	Chaîne	Type de fournisseur d’identité. Pour le scénario B2B : Google Facebook Pour le scénario B2C :Microsoft Google Amazon LinkedIn Facebook GitHub Twitter Weibo QQ WeChat OpenIDConnect

objet openIdConnectProvider

Propriété	Type	Description
clientId	Chaîne	ID client pour l’application. Il s’agit de l’ID client obtenu lors de l’inscription de l’application avec le fournisseur d’identité.
clientSecret	Chaîne	Clé secrète client pour l’application. Il s’agit de la clé secrète client obtenue lors de l’inscription de l’application avec le fournisseur d’identité.
name	Chaîne	Nom d’affichage du fournisseur d’identité.
type	Chaîne	Type de fournisseur d’identité. La valeur doit être `OpenIdConnect`.
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.
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.
metadataUrl	Chaîne	URL du document de métadonnées du fournisseur d’identité OpenID Connect.
responseMode	Chaîne	Définit la méthode qui doit être utilisée pour renvoyer les données du fournisseur d’identité personnalisé vers Azure AD B2C. Les modes de réponse suivants peuvent être utilisés : `form_post` : ce mode de réponse est recommandé pour une sécurité optimale. La réponse est transmise via la méthode HTTP POST, le code ou le jeton étant encodé dans le corps à l’aide du format application/x-www-form-urlencoded. `query` : le code ou le jeton est retourné en tant que paramètre de requête.
responseType	Chaîne	Décrit le type d’informations qui sont renvoyées dans l’appel initial au authorization_endpoint du fournisseur d’identité personnalisé. Les types de réponse suivants peuvent être utilisés : `code` : conformément au flux de code d’autorisation, un code est retourné à Azure AD B2C. Azure AD B2C continue d’appeler le token_endpoint pour échanger le code contre le jeton. `id_token` : un jeton d’ID est retourné à Azure AD B2C à partir du fournisseur d’identité personnalisé. `token` : un jeton d’accès est renvoyé à Azure AD B2C à partir du fournisseur d’identité personnalisé. (Cette valeur n’est pas prise en charge par Azure AD B2C pour le moment)
étendue	Chaîne	L’étendue définit les informations et les autorisations que vous souhaitez collecter à partir de votre fournisseur d’identité personnalisé.

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

Exemple 1 : Mettre à jour un identityProvider spécifique

Demande

L’exemple suivant illustre une demande.

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

{
  "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 IdentityProvider
{
	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.IdentityProviders["{identityProvider-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).


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta identity-providers patch --identity-provider-id {identityProvider-id} --body '{\
  "clientSecret": "1111111111111"\
}\
'

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewIdentityProvider()
clientSecret := "1111111111111"
requestBody.SetClientSecret(&clientSecret) 

identityProviders, err := graphClient.IdentityProviders().ByIdentityProviderId("identityProvider-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);

IdentityProvider identityProvider = new IdentityProvider();
identityProvider.setClientSecret("1111111111111");
IdentityProvider result = graphClient.identityProviders().byIdentityProviderId("{identityProvider-id}").patch(identityProvider);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const identityProvider = {
  clientSecret: '1111111111111'
};

await client.api('/identityProviders/Amazon-OAuth')
	.version('beta')
	.update(identityProvider);

Importante


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


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

$requestBody = new IdentityProvider();
$requestBody->setClientSecret('1111111111111');

$result = $graphServiceClient->identityProviders()->byIdentityProviderId('identityProvider-id')->patch($requestBody)->wait();

Importante


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

$params = @{
	clientSecret = "1111111111111"
}

Update-MgBetaIdentityProvider -IdentityProviderId $identityProviderId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.identity_provider import IdentityProvider

graph_client = GraphServiceClient(credentials, scopes)

request_body = IdentityProvider(
	client_secret = "1111111111111",
)

result = await graph_client.identity_providers.by_identity_provider_id('identityProvider-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 openIDConnectProvider spécifique (uniquement pour Azure AD B2C)

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/identityProviders/OIDC-V1-MyTest-085a8a0c-58cb-4b6d-8e07-1328ea404e1a
Content-type: application/json

{
  "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 IdentityProvider
{
	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.IdentityProviders["{identityProvider-id}"].PatchAsync(requestBody);

Importante


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta identity-providers patch --identity-provider-id {identityProvider-id} --body '{\
  "responseType": "id_token"\
}\
'

Importante



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewIdentityProvider()
additionalData := map[string]interface{}{
	"responseType" : "id_token", 
}
requestBody.SetAdditionalData(additionalData)

identityProviders, err := graphClient.IdentityProviders().ByIdentityProviderId("identityProvider-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);

IdentityProvider identityProvider = new IdentityProvider();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("responseType", "id_token");
identityProvider.setAdditionalData(additionalData);
IdentityProvider result = graphClient.identityProviders().byIdentityProviderId("{identityProvider-id}").patch(identityProvider);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const identityProvider = {
  responseType: 'id_token'
};

await client.api('/identityProviders/OIDC-V1-MyTest-085a8a0c-58cb-4b6d-8e07-1328ea404e1a')
	.version('beta')
	.update(identityProvider);

Importante


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


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

$requestBody = new IdentityProvider();
$additionalData = [
	'responseType' => 'id_token',
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->identityProviders()->byIdentityProviderId('identityProvider-id')->patch($requestBody)->wait();

Importante


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

$params = @{
	responseType = "id_token"
}

Update-MgBetaIdentityProvider -IdentityProviderId $identityProviderId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.identity_provider import IdentityProvider

graph_client = GraphServiceClient(credentials, scopes)

request_body = IdentityProvider(
	additional_data = {
			"response_type" : "id_token",
	}
)

result = await graph_client.identity_providers.by_identity_provider_id('identityProvider-id').patch(request_body)

Importante

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Mettre à jour identityProvider (déconseillé)

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

objet identityProvider

objet openIdConnectProvider

Réponse

Exemples

Exemple 1 : Mettre à jour un identityProvider spécifique

Demande

Réponse

Exemple 2 : Mettre à jour un openIDConnectProvider spécifique (uniquement pour Azure AD B2C)

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires