Mettre à jour un fournisseur d’identité

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é externe spécifié configuré dans le client.

Parmi les types de fournisseurs dérivés d’identityProviderBase, dans Microsoft Entra, cette opération peut mettre à jour une ressource socialIdentityProvider, appleManagedIdentityProvider (client externe uniquement) ou une ressource oidcIdentityProvider (client externe uniquement).

Dans Azure AD B2C, cette opération peut mettre à jour une ressource socialIdentityProvider, appleManagedIdentityProvider, builtinIdentityProvider ou openIdConnectIdentityProvider.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

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

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
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.

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Le rôle le moins privilégié est pris en charge pour cette opération, car l’administrateur du fournisseur d’identités externe est pris en charge.

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 les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans l’ID externe Microsoft Entra, fournissez à un objet JSON, au corps de la demande, une ou plusieurs propriétés qui doivent être mises à jour pour un objet socialIdentityProvider, appleManagedIdentityProvider ou oidcIdentityProvider.

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

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é.
identityProviderType Chaîne Pour les locataires externes et de main-d’œuvre, les valeurs possibles : Facebook, Google.
Pour les locataires Azure AD B2C, valeurs possibles : Microsoft, Google, Amazon, WeChatWeiboGitHubQQLinkedInFacebookTwitter.

objet appleManagedIdentityProvider

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

objet openIdConnectIdentityProvider

Propriété Type Description
claimsMappage claimsMappage 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.
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 est code, un secret est requis pour l’échange de code d’authentification.
  • Lorsque responseType est id_token le cas, le secret n’est pas requis car il n’y a pas d’échange de code dans le pipeline d’authentification. Dans ce mode, le id_token est retourné directement à partir de la réponse d’autorisation.
displayName Chaîne Nom d’affichage du fournisseur d’identité.
domainHint String L’indication de domaine permet de passer directement à la page de connexion du fournisseur d’identité spécifié au lieu de demander à l’utilisateur d’effectuer une sélection dans la liste des fournisseurs d’identité disponibles.
metadataUrl String 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 est toujours situé à un point final se terminant par .well-known/openid-configuration. Indiquez l’URL des métadonnées du fournisseur d’identité OpenID Connect que vous ajoutez.
responseMode String Le mode de réponse définit la méthode utilisée pour renvoyer des données du fournisseur d’identité personnalisé à Azure AD B2C. Valeurs possibles : form_post, query.
responseType String Le type de réponse décrit le type d’informations renvoyées lors de l’appel initial au authorization_endpoint du fournisseur d’identité personnalisée. Valeurs possibles : code , , id_tokentoken.
étendue String L’étendue définit les informations et les autorisations que vous cherchez à obtenir auprès de votre fournisseur d’identité personnalisé.

objet oidcIdentityProvider

Propriété Type Description
clientAuthentication clientAuthentication Les paramètres d’authentification du client.
  • Utilisez le type oidcClientSecretAuthentication pour configurer votre fournisseur d’identité avec client_secret_post les méthodes OR client_secret_jwt authentication .
  • utilisez le type oidcPrivateJwtKeyClientAuthentication pour configurer votre fournisseur d’identité avec private_key_jwt la méthode d’authentification.
  • Pour des raisons de sécurité, la client_secret_basic méthode d’authentification n’est pas prise en charge.
  • clientId String Il s’agit de l’ID client de l’application obtenue lors de l’enregistrement de l’application auprès du fournisseur d’identité.
    displayName Chaîne Nom d’affichage du fournisseur d’identité.
    inboundclaimMapping inboundclaimMapping Une fois que le fournisseur OIDC a renvoyé un jeton d’ID à l’ID externe Microsoft Entra, l’ID externe Microsoft Entra 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.
    de l’émetteur String L’URI de l’émetteur. L’URI de l’émetteur est une URL sensible à la casse qui utilise le schéma https et contient les composants schéma, hôte et, éventuellement, numéro de port et chemin d’accès, sans aucun composant de requête ou de fragment.
    Remarque : La configuration d’autres locataires Microsoft Entra en tant que fournisseur d’identité externe n’est actuellement pas prise en charge. Par conséquent, le microsoftonline.com domaine dans l’URI de l’émetteur n’est pas accepté.
    responseType String Le type de réponse décrit le type d’informations renvoyées lors de l’appel initial au authorization_endpoint du fournisseur d’identité personnalisée. Valeurs possibles : code , , id_tokentoken.
    étendue String L’étendue définit les informations et les autorisations que vous cherchez à obtenir auprès de votre fournisseur d’identité personnalisé.
    wellKnownEndpoint String 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 est toujours situé à un point final se terminant par .well-known/openid-configuration.
    Remarque : Le document de métadonnées doit, au minimum, contenir les propriétés suivantes : issuer, , token_endpoint_auth_methods_supportedauthorization_endpointresponse_types_supportedtoken_endpointsubject_types_supported , , et .jwks_uri Pour plus d’informations, consultez les spécifications d’OpenID Connect Discovery .

    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 fournisseur d’identité sociale

    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": "4294967296"
    }
    

    Réponse

    L’exemple suivant illustre la réponse.

    HTTP/1.1 204 No Content
    

    Exemple 2 : mise à jour d’un fournisseur d’identité Apple

    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"
    }
    

    Réponse

    L’exemple suivant illustre la réponse.

    HTTP/1.1 204 No Content
    

    Exemple 3 : Mettre à jour un fournisseur d’identité OpenID Connect (locataire Azure AD B2C)

    Demande

    L’exemple suivant illustre une demande.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Contoso-OIDC-00001111-aaaa-2222-bbbb-3333cccc4444
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
      "responseType": "id_token"
    }
    

    Réponse

    L’exemple suivant illustre la réponse.

    HTTP/1.1 204 No Content
    

    Exemple 4 : Mettre à jour un fournisseur d’identité OpenID Connect (client externe)

    Demande

    L’exemple suivant illustre une demande.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/ContosoOIDCIdentityProvider
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.oidcIdentityProvider",
      "displayName": "Contoso"
    }
    

    Réponse

    L’exemple suivant illustre la réponse.

    HTTP/1.1 204 No Content