openIdConnectProvider-Ressourcentyp (veraltet)

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Achtung

Diese Identitätsanbieter-API ist veraltet und wird nach März 2023 keine Daten mehr zurückgeben. Bitte verwenden Sie die neue Identitätsanbieter-API.

Stellt OpenID Verbinden Identitätsanbieter in einem Azure Active Directory B2C-Mandanten dar.

Das Konfigurieren eines OpenID-Verbinden-Anbieters in einem B2C-Mandanten ermöglicht Benutzern die Registrierung und Anmeldung mithilfe ihres benutzerdefinierten Identitätsanbieters in einer Anwendung.

Erbt von IdentityProvider.

Methoden

Methode Rückgabetyp Beschreibung
List identityProvider-Sammlung Abrufen aller in einem Mandanten konfigurierten Identitätsanbieter.
Create openIdConnectProvider Erstellen Sie einen neuen OpenID-Verbinden Identitätsanbieter.
Get openIdConnectProvider Dient zum Abrufen von Eigenschaften eines OpenID-Verbinden Identitätsanbieters.
Update Keine Aktualisieren eines OpenID-Verbinden Identitätsanbieters.
Löschen Keine Löschen Eines OpenID-Verbinden Identitätsanbieters.
Auflisten der verfügbaren Anbietertypen String-Sammlung Abrufen aller verfügbaren Identitätsanbietertypen.

Eigenschaften

Eigenschaft Typ Beschreibung
clientId Zeichenfolge Der Client-Bezeichner für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter erhalten wird. Geerbt von IdentityProvider. Dies ist eine erforderliche Eigenschaft.
clientSecret String Der geheime Clientschlüssel für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter abgerufen wird. Der clientSecret weist eine Abhängigkeit von responseType auf. Wenn responseType code ist, ist ein geheimer Schlüssel für den Authentifizierungscodeaustausch erforderlich. Wenn responseType id_token der geheime Schlüssel ist nicht erforderlich, da es keinen Codeaustausch gibt, wird der id_token direkt von der Autorisierungsantwort zurückgegeben. Dieser verfügt nur über Schreibzugriff. Ein Lesevorgang gibt „****“ zurück. Geerbt von IdentityProvider.
id String Die ID des Identitätsanbieters. Es handelt sich um eine erforderliche Eigenschaft, die nach der Erstellung nur gelesen wird.
name Zeichenfolge Der Anzeigename des Identitätsanbieters. Es handelt sich um eine erforderliche Eigenschaft, die nach der Erstellung nur gelesen wird.
type Zeichenfolge Der Typ des Identitätsanbieters. Es muss OpenIDConnect . Es handelt sich um eine erforderliche Eigenschaft, die nach der Erstellung nur gelesen wird.
claimsMapping claimsMapping Nachdem der OIDC-Anbieter ein ID-Token zurück an Azure AD gesendet hat, muss Azure AD in der Lage sein, die Ansprüche aus dem empfangenen Token den Ansprüchen zuzuordnen, die Azure AD erkennt und verwendet. Dieser komplexe Typ erfasst diese Zuordnung. Es handelt sich um eine erforderliche Eigenschaft.
domainHint String Der Domänenhinweis kann verwendet werden, um direkt zur Anmeldeseite des angegebenen Identitätsanbieters zu springen, anstatt den Benutzer in der Liste der verfügbaren Identitätsanbieter eine Auswahl treffen zu lassen.
metadataUrl String Die URL für das Metadatendokument des OpenID-Verbinden Identitätsanbieters. Jeder OpenID-Verbinden Identitätsanbieter beschreibt ein Metadatendokument, das die meisten informationen enthält, die für die Anmeldung erforderlich sind. Dazu gehören Informationen wie die zu verwendenden URLs und der Speicherort der öffentlichen Signaturschlüssel des Diensts. Das OpenID-Verbinden-Metadatendokument befindet sich immer an einem Endpunkt, der mit .well-known/openid-configuration endet. Für den OpenID-Verbinden Identitätsanbieter, den Sie hinzufügen möchten, müssen Sie die Metadaten-URL angeben. Es handelt sich um eine erforderliche Eigenschaft, die nach der Erstellung nur gelesen wird.
responseMode openIdConnectResponseMode Der Antwortmodus definiert die Methode, die verwendet werden soll, um die Daten vom benutzerdefinierten Identitätsanbieter zurück an Azure AD B2C zu senden. Die folgenden Antwortmodi können verwendet werden: form_post , query . query der Antwortmodus bedeutet, dass der Code oder token als Abfrageparameter zurückgegeben wird. form_post Der Antwortmodus wird für die beste Sicherheit empfohlen. Die Antwort wird über die HTTP POST-Methode übertragen, wobei der Code oder token im Textkörper mithilfe des anwendungs-/x-www-form-url-codierten Formats codiert wird. Es handelt sich um eine erforderliche Eigenschaft.
responseType openIdConnectResponseTypes Der Antworttyp beschreibt, welche Art von Informationen im ersten Aufruf an die authorization_endpoint des benutzerdefinierten Identitätsanbieters zurückgesendet wird. Die folgenden Antworttypen können verwendet werden: code , id_token , token . Es handelt sich um eine erforderliche Eigenschaft.
scope String Der Bereich definiert die Informationen und Berechtigungen, die Sie von Ihrem benutzerdefinierten Identitätsanbieter erfassen möchten. OpenID Verbinden Anforderungen müssen den OpenID-Bereichswert enthalten, um das ID-Token vom Identitätsanbieter zu erhalten. Ohne das ID-Token können sich Benutzer nicht mithilfe des benutzerdefinierten Identitätsanbieters bei Azure AD B2C anmelden. Andere Bereiche können durch Leerzeichen getrennt angefügt werden. Weitere Informationen zu den Bereichseinschränkungen finden Sie in RFC6749 Abschnitt 3.3. Es handelt sich um eine erforderliche Eigenschaft.

openIdConnectResponseTypes-Werte

Member Beschreibung
code Gemäß dem Autorisierungscodefluss wird ein Code zurück an Azure AD B2C zurückgegeben. Azure AD B2C ruft die token_endpoint auf, um den Code für das Token auszutauschen.
id_token Ein ID-Token wird vom benutzerdefinierten Identitätsanbieter an Azure AD B2C zurückgegeben.
token Ein Zugriffstoken wird vom benutzerdefinierten Identitätsanbieter an Azure AD B2C zurückgegeben. Wird derzeit nicht von Azure AD B2C unterstützt.

JSON-Darstellung

Es folgt eine JSON-Darstellung der 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"
}