Freigeben über


Aktualisieren eines Identitätsanbieters

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.

Aktualisieren Sie die Eigenschaften des angegebenen externen Identitätsanbieters, der im Mandanten konfiguriert ist.

Unter den Von identityProviderBase abgeleiteten Anbietertypen kann dieser Vorgang in Microsoft Entra eine socialIdentityProvider-, appleManagedIdentityProvider-Ressource (nur externer Mandant) oder eine oidcIdentityProvider-Ressource (nur externer Mandant) aktualisieren.

In Azure AD B2C kann dieser Vorgang eine socialIdentityProvider-, appleManagedIdentityProvider-, builtinIdentityProvider- oder openIdConnectIdentityProvider-Ressource aktualisieren.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) IdentityProvider.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung IdentityProvider.ReadWrite.All Nicht verfügbar.

Wichtig

In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. Der Externe Identitätsanbieteradministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.

HTTP-Anforderung

PATCH /identity/identityProviders/{id}

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie in Microsoft Entra External ID ein JSON-Objekt als Anforderungstext mit mindestens einer Eigenschaft an, die für ein socialIdentityProviderappleManagedIdentityProvider- oder oidcIdentityProvider-Objekt aktualisiert werden muss.

Stellen Sie in Azure AD B2C ein JSON-Objekt als Anforderungstext mit mindestens einer Eigenschaft bereit, die für ein socialIdentityProvider-, appleManagedIdentityProvider- oder openIdConnectIdentityProvider-Objekt aktualisiert werden muss.

socialIdentityProvider-Objekt

Eigenschaft Typ Beschreibung
clientId Zeichenfolge Der Client-Bezeichner für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter erhalten wird.
clientSecret Zeichenfolge Der geheime Clientschlüssel für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter erhalten wird. Dieser verfügt nur über Schreibzugriff. Ein Lesevorgang gibt **** zurück.
displayName Zeichenfolge Der Anzeigename des Identitätsanbieters.
identityProviderType Zeichenfolge Mögliche Werte für externe Mandanten und Mitarbeitermandanten: Facebook, Google.
Mögliche Werte für Azure AD B2C-Mandanten: Microsoft, Google, , AmazonLinkedIn, FacebookGitHub, Twitter, Weibo, QQ, , . WeChat

appleManagedIdentityProvider-Objekt

Eigenschaft Typ Beschreibung
certificateData Zeichenfolge Die Zertifikatsdaten, die eine lange Textfolge aus dem Zertifikat sind, können NULL sein.
developerId Zeichenfolge Der Apple-Entwicklerbezeichner.
displayName Zeichenfolge Der Anzeigename des Identitätsanbieters.
keyId Zeichenfolge Der Apple-Schlüsselbezeichner.
ServiceID Zeichenfolge Der Apple-Dienstbezeichner.

openIdConnectIdentityProvider-Objekt

Eigenschaft Typ Beschreibung
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.
clientId Zeichenfolge Der Client-Bezeichner für die Anwendung, der beim Registrieren der Anwendung beim Identitätsanbieter erhalten wird.
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 es keinen Codeaustausch in der Authentifizierungspipeline gibt. In diesem Modus wird die id_token direkt von der Autorisierungsantwort zurückgegeben.
displayName Zeichenfolge Der Anzeigename des Identitätsanbieters.
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-configurationendet. Geben Sie die Metadaten-URL für den OpenID Connect-Identitätsanbieter an, den Sie hinzufügen.
responseMode String 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.
responseType String 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.
Bereich String Bereich definiert die Informationen und Berechtigungen, die Sie von Ihrem benutzerdefinierten Identitätsanbieter sammeln möchten.

oidcIdentityProvider-Objekt

Eigenschaft Typ Beschreibung
clientAuthentication clientAuthentication Die Einstellungen für die Clientauthentifizierung.
  • Verwenden Sie den Typ oidcClientSecretAuthentication , um Ihren Identitätsanbieter mit client_secret_post - oder client_secret_jwt authentication -Methoden einzurichten.
  • Verwenden Sie den oidcPrivateJwtKeyClientAuthentication-Typ zum Einrichten Ihres Identitätsanbieters mit private_key_jwt Authentifizierungsmethode.
  • 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.
    inboundclaimMapping inboundclaimMapping 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 String 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.
    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 .

    Antwort

    Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben. Wenn die Methode nicht erfolgreich ist, wird ein 4xx-Fehler mit bestimmten Details zurückgegeben.

    Beispiele

    Beispiel 1: Aktualisieren eines Identitätsanbieters für soziale Netzwerke

    Anforderung

    Das folgende Beispiel zeigt eine Anfrage.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.socialIdentityProvider",
      "clientSecret": "4294967296"
    }
    

    Antwort

    Das folgende Beispiel zeigt die Antwort.

    HTTP/1.1 204 No Content
    

    Beispiel 2: Aktualisieren eines Apple-Identitätsanbieters

    Anforderung

    Das folgende Beispiel zeigt eine Anfrage.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Apple-Managed-OIDC
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.socialIdentityProvider",
      "displayName": "Apple"
    }
    

    Antwort

    Das folgende Beispiel zeigt die Antwort.

    HTTP/1.1 204 No Content
    

    Beispiel 3: Aktualisieren eines OpenID Connect-Identitätsanbieters (Azure AD B2C-Mandant)

    Anforderung

    Das folgende Beispiel zeigt eine Anfrage.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Contoso-OIDC-00001111-aaaa-2222-bbbb-3333cccc4444
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
      "responseType": "id_token"
    }
    

    Antwort

    Das folgende Beispiel zeigt die Antwort.

    HTTP/1.1 204 No Content
    

    Beispiel 4: Aktualisieren eines OpenID Connect-Identitätsanbieters (externer Mandant)

    Anforderung

    Das folgende Beispiel zeigt eine Anfrage.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/ContosoOIDCIdentityProvider
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.oidcIdentityProvider",
      "displayName": "Contoso"
    }
    

    Antwort

    Das folgende Beispiel zeigt die Antwort.

    HTTP/1.1 204 No Content