Share via


Type de ressource openIdConnectProvider (déconseillé)

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

Représente les fournisseurs d’identité OpenID Connect dans un locataire Azure Active Directory B2C.

La configuration d’un fournisseur OpenID Connect dans un locataire B2C permet aux utilisateurs de s’inscrire et de se connecter à l’aide de leur fournisseur d’identité personnalisé dans une application.

Hérite d’identityProvider.

Méthodes

Méthode Type renvoyé Description
List collection identityProvider Récupérer tous les fournisseurs d’identité configurés dans un client.
Créer openIdConnectProvider Créez un fournisseur d’identité OpenID Connect.
Obtenir openIdConnectProvider Récupérer les propriétés d’un fournisseur d’identité OpenID Connect.
Mettre à jour Aucun Mettez à jour un fournisseur d’identité OpenID Connect.
Supprimer Aucune Supprimez un fournisseur d’identité OpenID Connect.
Répertorier les types de fournisseurs disponibles Collection de chaînes Récupérer tous les types de fournisseurs d’identité disponibles.

Propriétés

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é. Hérité de identityProvider. Il s’agit d’une propriété obligatoire.
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. En écriture seule. Une opération de lecture retourne « **** ». Hérité de identityProvider.
id Chaîne ID du fournisseur d’identité. Il s’agit d’une propriété obligatoire qui est en lecture seule après sa création.
nom Chaîne Nom d’affichage du fournisseur d’identité. Il s’agit d’une propriété obligatoire qui est en lecture seule après sa création.
type Chaîne Type de fournisseur d’identité. Il doit être OpenIDConnect. Il s’agit d’une propriété obligatoire qui est en lecture seule après sa création.
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. Il s’agit d’une propriété obligatoire.
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 parmi la liste des fournisseurs d’identité disponibles.
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 une configuration connue/openid-configuration. Pour le fournisseur d’identité OpenID Connect que vous souhaitez ajouter, vous devez fournir l’URL des métadonnées. Il s’agit d’une propriété obligatoire qui est en lecture seule après sa création.
responseMode openIdConnectResponseMode Le mode de réponse définit la méthode qui doit être utilisée pour renvoyer les données du fournisseur d’identité personnalisé à Azure AD B2C. Les modes de réponse suivants peuvent être utilisés : form_post, query. query le mode réponse signifie que le code ou le jeton est retourné en tant que paramètre de requête. form_post le mode 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. Il s’agit d’une propriété obligatoire.
responseType openIdConnectResponseTypes Le type de réponse décrit le type d’informations qui est renvoyé dans l’appel initial au authorization_endpoint du fournisseur d’identité personnalisé. Les types de réponse suivants peuvent être utilisés : code , id_token , token. Il s’agit d’une propriété obligatoire.
étendue Chaîne L’étendue définit les informations et les autorisations que vous souhaitez collecter à partir de votre fournisseur d’identité personnalisé. Les demandes OpenID Connect doivent contenir la valeur d’étendue openid pour recevoir le jeton d’ID du fournisseur d’identité. Sans le jeton d’ID, les utilisateurs ne peuvent pas se connecter à Azure AD B2C à l’aide du fournisseur d’identité personnalisé. D’autres étendues peuvent être ajoutées séparées par un espace. Pour plus d’informations sur les limitations d’étendue, consultez RFC6749 Section 3.3. Il s’agit d’une propriété obligatoire.

Valeurs openIdConnectResponseTypes

Member Description
code Conformément au flux de code d’autorisation, un code est renvoyé à 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é.
jeton Un jeton d’accès est renvoyé à Azure AD B2C à partir du fournisseur d’identité personnalisé. Actuellement non pris en charge par Azure AD B2C.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

{
  "id": "String",
  "name": "String",
  "type": "String",
  "clientId": "String",
  "clientSecret": "String",
  "claimsMapping": {
      "@odata.type": "#microsoft.graph.claimsMapping",
      "userId": "String",
      "givenName": "String",
      "surname": "String",
      "email": "String",
      "displayName": "String"
  },
  "domainHint": "String",
  "metadataUrl": "String",
  "responseMode": "String",
  "responseType": "String",
  "scope": "String"
}