openIdConnectIdentityProvider-Ressourcentyp

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 .

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

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

Erbt von identityProviderBase.

Methoden

Methode Rückgabetyp Beschreibung
List IdentityProviderBase-Auflistung Rufen Sie alle in einem Mandanten konfigurierten Identitätsanbieter ab, einschließlich des openIdConnectIdentityProvider-Objekttyps. Es gibt keine Möglichkeit, nur die OpenID-Verbinden Identitätsanbieter in einem Mandanten abzurufen.
Create openIdConnectIdentityProvider Erstellen Sie ein neues openIdConnectIdentityProvider-Objekt.
Get openIdConnectIdentityProvider Dient zum Abrufen der Eigenschaften eines openIdConnectIdentityProvider-Objekts.
Update Keine Dient zum Aktualisieren eines openIdConnectIdentityProvider-Objekts.
Löschen Keine Löscht 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 String Der Client-Bezeichner für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter erhalten wurde. Erforderlich.
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, ist es nicht erforderlich, da kein Codeaustausch vorhanden ist. 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 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. Erforderlich.
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 in .well-known/openid-configuration endet. Geben Sie die Metadaten-URL für den OpenID-Verbinden Identitätsanbieter an, den Sie hinzufügen. Schreibgeschützt. Erforderlich.
responseMode openIdConnectResponseMode Der Antwortmodus definiert die Methode, die zum Senden von Daten vom benutzerdefinierten Identitätsanbieter an Azure AD B2C verwendet wird. Mögliche Werte: form_post , query . Erforderlich.
responseType openIdConnectResponseTypes Der Antworttyp beschreibt den Typ der Informationen, die im ersten Aufruf an die authorization_endpoint des benutzerdefinierten Identitätsanbieters zurückgesendet wurden. Mögliche Werte: code , id_token , token . Erforderlich.
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 angefügt werden, getrennt durch ein Leerzeichen. Weitere Informationen zu den Bereichseinschränkungen finden Sie in RFC6749 Abschnitt 3.3. Erforderlich.

openIdConnectResponseMode-Werte

Member Beschreibung
form_post Dieser Antwortmodus wird für optimale 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.
Abfrage Der Code oder token wird als Abfrageparameter zurückgegeben.
unknownFutureValue Ein Sentinelwert, der zukünftige Werte angibt.

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

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

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