openIdConnectIdentityProvider-Ressourcentyp

Artikel
04/21/2024

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.

Stellt OpenID Connect-Identitätsanbieter in einem Azure Active Directory (Azure AD) B2C-Mandanten dar.

Wenn Sie einen OpenID Connect-Anbieter in einem Azure AD B2C-Mandanten konfigurieren, können sich Benutzer mit ihrem benutzerdefinierten Identitätsanbieter bei jeder Anwendung registrieren und anmelden.

Erbt von identityProviderBase.

Methoden

Methode	Rückgabetyp	Beschreibung
List	identityProviderBase-Sammlung	Rufen Sie alle identitätsanbieter ab, die in einem Mandanten konfiguriert sind, einschließlich des openIdConnectIdentityProvider-Objekttyps . Es gibt keine Möglichkeit, nur die OpenID Connect-Identitätsanbieter in einem Mandanten abzurufen.
Create	openIdConnectIdentityProvider	Erstellen Sie ein neues openIdConnectIdentityProvider-Objekt .
Get	openIdConnectIdentityProvider	Ruft die Eigenschaften eines openIdConnectIdentityProvider-Objekts ab.
Update	Keine	Aktualisieren eines openIdConnectIdentityProvider-Objekts .
Delete	Keine	Löschen Sie ein openIdConnectIdentityProvider-Objekt .
Auflisten der verfügbaren Anbietertypen	String-Sammlung	Rufen Sie alle verfügbaren Identitätsanbietertypen ab, die im Mandanten verfügbar sind.

Eigenschaften

Eigenschaft	Typ	Beschreibung
clientId	Zeichenfolge	Der Client-Bezeichner für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter erhalten wird. Erforderlich.
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. Die id_token wird direkt von der Autorisierungsantwort zurückgegeben. Dieser verfügt nur über Schreibzugriff. Ein Lesevorgang gibt `****` zurück.
id	String	Der Bezeichner des Identitätsanbieters. Erforderlich. Geerbt von identityProviderBase. Schreibgeschützt.
displayName	Zeichenfolge	Der Anzeigename des Identitätsanbieters.
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. Erforderlich.
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 auf `.well-known/openid-configuration`endet. Geben Sie die Metadaten-URL für den OpenID Connect-Identitätsanbieter an, den Sie hinzufügen. Schreibgeschützt. Erforderlich.
responseMode	openIdConnectResponseMode	Der Antwortmodus definiert die Methode, mit der Daten vom benutzerdefinierten Identitätsanbieter an Azure AD B2C zurückgesendet werden. Mögliche Werte: `form_post`, `query`. Erforderlich.
responseType	openIdConnectResponseTypes	Der Antworttyp beschreibt den Typ der Informationen, die beim ersten Aufruf des authorization_endpoint des benutzerdefinierten Identitätsanbieters zurückgesendet wurden. Mögliche Werte: `code` , `id_token` , `token`. Erforderlich.
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 angefügt werden, getrennt durch ein Leerzeichen. Weitere Informationen zu den Bereichseinschränkungen finden Sie unter RFC6749 Abschnitt 3.3. Erforderlich.

openIdConnectResponseMode-Werte

Member	Beschreibung
form_post	Dieser Antwortmodus wird aus Sicherheitsgründen 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.
Abfrage	Der Code oder das Token wird als Abfrageparameter zurückgegeben.
unknownFutureValue	Ein Sentinelwert zum Angeben zukünftiger Werte.

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. (Dieser Wert wird von Azure AD B2C derzeit nicht unterstützt.)

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
  "id": "String (identifier)",
  "displayName": "String",
  "clientId": "String",
  "clientSecret": "String",
  "scope": "String",
  "metadataUrl": "String",
  "domainHint": "String",
  "responseType": "String",
  "responseMode": "String",
  "claimsMapping": {
    "@odata.type": "microsoft.graph.claimsMapping"
  }
}

Share via