oidcIdentityProvider-Ressourcentyp

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 Microsoft Entra externen Mandanten dar.

Durch das Konfigurieren eines OpenID Connect-Anbieters in einem externen Mandanten können sich Benutzer mit ihrem benutzerdefinierten OpenID Connect-Identitätsanbieter bei jeder Anwendung registrieren und anmelden.

Erbt von identityProviderBase.

Methoden

Keine.

Eine Liste der API-Vorgänge zum Verwalten der oidcIdentityProvider-Ressource finden Sie unter dem Ressourcentyp identityProviderBase .

Eigenschaften

Eigenschaft	Typ	Beschreibung
clientAuthentication	oidcClientAuthentication	Die Einstellungen für die Clientauthentifizierung. Verwenden Sie den abgeleiteten komplexen Typ oidcClientSecretAuthentication , um Ihren Identitätsanbieter mit client_secret_post - oder client_secret_jwt authentication -Methoden einzurichten. Verwenden Sie den oidcPrivateJwtKeyClientAuthentication-Typ , um Ihren Identitätsanbieter mit private_key_jwt Authentifizierungsmethode einzurichten. Aus Sicherheitsgründen wird die client_secret_basic Authentifizierungsmethode nicht unterstützt.
clientId	String	Die Client-ID für die Anwendung, die bei der Registrierung der Anwendung beim Identitätsanbieter abgerufen wird.
displayName	Zeichenfolge	Der Anzeigename des Identitätsanbieters. Geerbt von identityProviderBase.
id	String	Der Bezeichner des Identitätsanbieters. Erforderlich. Geerbt von identityProviderBase. Erbt von der Entität
inboundClaimMapping	oidcInboundClaimMappingOverride	Nachdem der OIDC-Anbieter ein ID-Token zurück an Microsoft Entra External ID gesendet hat, muss Microsoft Entra External 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.
Emittent	String	Der Aussteller-URI. Der Aussteller-URI ist eine URL, bei der die Groß-/Kleinschreibung beachtet wird, bei der das HTTPS-Schema verwendet wird, das Schema, den Host und optional die Komponenten der Portnummer und des Pfads enthält und keine Abfrage- oder Fragmentkomponenten enthält. Anmerkung: Das Konfigurieren anderer Microsoft Entra Mandanten als externer Identitätsanbieter wird derzeit nicht unterstützt. Daher wird die microsoftonline.com Domäne im Aussteller-URI nicht akzeptiert.
responseType	oidcResponseType	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: Gemäß dem Autorisierungscodeflow wird ein Code an Entra External ID zurückgegeben. Entra External ID fährt mit dem Aufruf des token_endpoint fort, um den Code gegen das Token auszutauschen. id_token: Ein ID-Token wird vom benutzerdefinierten Identitätsanbieter zurück an Entra External ID zurückgegeben. (Dieser Wert wird derzeit nicht unterstützt.) token: Ein Zugriffstoken wird vom benutzerdefinierten Identitätsanbieter zurück an Entra External ID zurückgegeben. Dieser Wert wird derzeit nicht unterstützt.
Bereich	String	Bereich definiert die Informationen und Berechtigungen, die Sie von Ihrem benutzerdefinierten Identitätsanbieter sammeln möchten.
wellKnownEndpoint	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-configurationendet. Anmerkung: Das Metadatendokument sollte mindestens die folgenden Eigenschaften enthalten: issuer, authorization_endpoint, , token_endpointtoken_endpoint_auth_methods_supported, response_types_supportedsubject_types_supported und jwks_uri. Weitere Informationen finden Sie unter OpenID Connect Discovery-Spezifikationen .

Beziehungen

Keine.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.oidcIdentityProvider",
  "id": "String (identifier)",
  "displayName": "String",
  "supportedTenantTypes": "String",
  "clientId": "String",
  "issuer": "String",
  "wellKnownEndpoint": "String",
  "responseType": "String",
  "scope": "String",
  "clientAuthentication": {
    "@odata.type": "microsoft.graph.oidcClientAuthentication"
  },
  "inboundClaimMapping": {
    "@odata.type": "microsoft.graph.oidcInboundClaimMappingOverride"
  }
}