openIdConnectProvider-Ressourcentyp (veraltet)

Artikel
10/19/2023

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

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 Connect-Identitätsanbieter in einem Azure Active Directory B2C-Mandanten dar.

Das Konfigurieren eines OpenID Connect-Anbieters in einem B2C-Mandanten ermöglicht Benutzern die Registrierung und Anmeldung mit ihrem benutzerdefinierten Identitätsanbieter 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 Connect-Identitätsanbieter.
Get	openIdConnectProvider	Ruft Eigenschaften eines OpenID Connect-Identitätsanbieters ab.
Update	Keine	Aktualisieren eines OpenID Connect-Identitätsanbieters.
Delete	Keine	Löschen sie einen OpenID Connect-Identitätsanbieter.
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. ClientSecret weist eine Abhängigkeit von responseType auf. Wenn responseType ist `code`, ist ein Geheimnis für den Authentifizierungscodeaustausch erforderlich. Wenn responseType ist, ist `id_token` das Geheimnis nicht erforderlich, da kein Codeaustausch erfolgt, `id_token` wird 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 schreibgeschützt ist.
name	Zeichenfolge	Der Anzeigename des Identitätsanbieters. Es handelt sich um eine erforderliche Eigenschaft, die nach der Erstellung schreibgeschützt ist.
type	Zeichenfolge	Der Typ des Identitätsanbieters. Muss `OpenIDConnect` sein. Es handelt sich um eine erforderliche Eigenschaft, die nach der Erstellung schreibgeschützt ist.
claimsMapping	claimsMapping	Nachdem der OIDC-Anbieter ein ID-Token zurück an Microsoft Entra ID gesendet hat, muss Microsoft Entra ID in der Lage sein, die Ansprüche aus dem empfangenen Token den Ansprüchen zuzuordnen, die Microsoft Entra ID erkennt und verwendet. Dieser komplexe Typ erfasst diese Zuordnung. Dies ist eine erforderliche Eigenschaft.
domainHint	String	Der Domänenhinweis kann verwendet werden, um direkt zur Anmeldeseite des angegebenen Identitätsanbieters zu springen, anstatt dass der Benutzer eine Auswahl in der Liste der verfügbaren Identitätsanbieter trifft.
metadataUrl	String	Die URL für das Metadatendokument des OpenID Connect-Identitätsanbieters. Jeder OpenID Connect-Identitätsanbieter beschreibt ein Metadatendokument, das die meisten Informationen enthält, die für die Anmeldung erforderlich sind. Dies umfasst Informationen wie die zu verwendenden URLs und den Speicherort der öffentlichen Signaturschlüssel des Diensts. Das OpenID Connect-Metadatendokument befindet sich immer an einem Endpunkt, der mit einer bekannten/openid-Konfiguration endet. Für den OpenID Connect-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 schreibgeschützt ist.
responseMode	openIdConnectResponseMode	Der Antwortmodus definiert die Methode, die verwendet werden soll, um die Daten vom benutzerdefinierten Identitätsanbieter an Azure AD B2C zurückzusenden. Die folgenden Antwortmodi können verwendet werden: `form_post`, `query`. `query` Antwortmodus bedeutet, dass der Code oder das 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 das Token im Text im Format application/x-www-form-urlencoded codiert wird. Dies ist eine erforderliche Eigenschaft.
responseType	openIdConnectResponseTypes	Der Antworttyp beschreibt, welche Art von Informationen beim ersten Aufruf des authorization_endpoint des benutzerdefinierten Identitätsanbieters zurückgesendet werden. Die folgenden Antworttypen können verwendet werden: `code` , `id_token` , `token`. Dies ist eine erforderliche Eigenschaft.
Bereich	String	Bereich definiert die Informationen und Berechtigungen, die Sie von Ihrem benutzerdefinierten Identitätsanbieter sammeln möchten. OpenID Connect-Anforderungen müssen den openid-Bereichswert enthalten, um das ID-Token vom Identitätsanbieter zu empfangen. Ohne das ID-Token können sich Benutzer nicht mit dem benutzerdefinierten Identitätsanbieter bei Azure AD B2C anmelden. Andere Bereiche können durch Leerzeichen getrennt angefügt werden. Weitere Informationen zu den Bereichseinschränkungen finden Sie unter RFC6749 Abschnitt 3.3. Dies ist eine erforderliche Eigenschaft.

openIdConnectResponseTypes-Werte

Member	Beschreibung
code	Gemäß dem Autorisierungscodeflow wird ein Code an Azure AD B2C zurückgegeben. Azure AD B2C ruft die token_endpoint auf, um den Code gegen 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. Derzeit nicht von Azure AD B2C unterstützt.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

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

Share via