Freigeben über

Erstellen oder Aktualisieren von Client-IDs und geheimen Schlüsseln im Partner Center

  • Artikel

Wichtig

Sie benötigen einen Microsoft Azure AD/Entra-Mandanten, um den Dienst ab dem 1. März 2023ohne Unterbrechung weiter nutzen zu können. Wechseln Sie zu den Einstellungen für Mandant in Ihrem Partner Center-Konto und erstellen Sie eine neue Microsoft Entra-ID oder ordnen Sie Ihre aktuelle ID zu.

Ablaufendes Clientgeheimnis in SharePoint-Add-Ins aktualisieren

  1. Generieren und Hinzufügen eines neuen geheimen Clientschlüssels im Partner Center, um ihn dieser bestimmten Add-In-Client-ID zuzuordnen. Spezifische Schritte finden Sie unter Generieren von anderen Clientgeheimnissen.
  2. Aktualisieren Sie Ihre Remotewebanwendung so, dass der neue geheime Clientschlüssel verwendet wird. Weitere Informationen finden Sie im Abschnitt "Aktualisieren der Remote-Webanwendung in Visual Studio, um den neuen geheimen Abschnitt zu verwenden" in "Ersetzen eines ablaufenden geheimen Clientschlüssels in einem SharePoint-Add-In".
  3. Veröffentlichen Sie Ihre Remotewebanwendung erneut.

Wichtig

Microsoft Office Developer Tools für Visual Studio unterstützt das Festlegen eines sekundären geheimen Clientschlüssels, mit dem Sie Ihren ablaufenden geheimen Clientschlüssel aktualisieren können.

Verwenden von OAuth zum Authentifizieren und Autorisieren von Add-Ins

OAuth (Open Authorization) ist ein offener Standard für die Autorisierung. OAuth ermöglicht die sichere Autorisierung von Desktop- und Webanwendungen auf einfache und standardmäßige Weise. Es ermöglicht Benutzern, zu genehmigen, dass eine Anwendung in ihrem Namen handelt, ohne den Benutzernamen und das Kennwort freizugeben. Beispielsweise können Benutzer ihre privaten Ressourcen oder Daten (Kontaktliste, Dokumente, Fotos, Videos usw.) freigeben, die auf einer Website mit einer anderen Website gespeichert sind, ohne ihre Anmeldeinformationen (in der Regel Benutzername und Kennwort) angeben zu müssen.

Mit OAuth können Benutzer einen Dienstanbieter (z. B. SharePoint) autorisieren, Token anstelle von Anmeldeinformationen (z. B. Benutzername und Kennwort) für ihre Daten bereitzustellen, die von einem bestimmten Dienstanbieter gehostet werden (z. B. SharePoint). Jedes Token gewährt Zugriff auf eine bestimmte Website (z. B. ein SharePoint-Dokument-Repository), für bestimmte Ressourcen (z. B. Dokumente aus einem Ordner) und für eine definierte Dauer. Benutzer können dann einer Nicht-Microsoft-Website Zugriff auf Informationen gewähren, die mit einem anderen Dienstanbieter (z. B. SharePoint) gespeichert sind, ohne ihren Benutzernamen und ihr Kennwort freizugeben und ohne alle Daten freizugeben, die sie in SharePoint haben.

Wenn Ihr Add-In diesen Autorisierungstyp erfordert, müssen Sie OAuth-Client-ID und geheime Clientschlüssel Ihrem Add-In zuordnen. Sie können OAuth-Clientschlüssel im Partner Center generieren und dann ihrem Add-In-Code hinzufügen.

Wenn ein Benutzer ein Add-In installiert, das über eine zugeordnete Client-ID und einen geheimen Clientschlüssel verfügt, wird ein Zustimmungsdialogfeld angezeigt. Wenn der Benutzer die Zustimmung erteilt, kann das Add-In im Namen des Benutzers handeln, um auf die Daten zuzugreifen, die das Add-In benötigt. Benutzer können nur die Berechtigungen erteilen, die sie besitzen. Grant stellt die Berechtigungen dar, die ein Benutzer an ein Add-In delegiert.

Ihr Add-In könnte beispielsweise ein Reisekalender-Add-In sein, das als IFRAME auf einer Microsoft 365 SharePoint-Website geöffnet wird. Mit OAuth kann das Add-In den Benutzer identifizieren, zu dem der Reisekalender gehört. Oder wenn das Reisekalender-Add-In auf andere Aspekte von Microsoft 365 zugreifen muss, z. B. Ressourcen oder Kalenderinformationen, kann es im Namen des angemeldeten Benutzers darauf zugreifen.

Hinweis

Weitere Informationen zu OAuth, Client-ID und geheimen Clientschlüsseln finden Sie unter Autorisierung und Authentifizierung von SharePoint-Add-Ins, OAuth-Fluss für Kontexttoken für SharePoint-Add-Insund Registrieren von SharePoint-Add-Ins 2013.

OAuth-Client-ID und geheimer Clientschlüssel

Sie können nur eine Client-ID ihrem Add-In zuordnen, sie können jedoch mehrere geheime Clientschlüssel einer Client-ID zuordnen. Für Sicherheits- und Verwaltungszwecke empfehlen wir, die Anzahl der geheimen Clientschlüssel zu beschränken, die einer Client-ID zugeordnet sind.

Wichtig

Um ein SharePoint-Add-In zu übermitteln, das OAuth verwendet und an China verteilt, müssen Sie Folgendes ausführen:

  • Verwenden Sie eine separate Client-ID und einen geheimen Clientschlüssel für China.
  • Fügen Sie ein separates Add-In-Paket speziell für China hinzu.
  • Zugriff für alle Länder/Regionen außer China blockieren.
  • Erstellen Sie einen separaten Add-In-Eintrag für China.

Weitere Informationen zum Verteilen von Add-Ins nach China finden Sie unter Übermitteln von Apps für Office 365, betrieben von 21Vianet in China.

Eingehende Daten an Ihr Add-In werden nur mit einem geheimen Clientschlüssel signiert. Im Partner Center ist es das Client-Geheimnis mit einem grünen Häkchen neben Active in der Spalte Status auf der Seite Client-IDs. Wenn Sie den Signaturclientschlüssel löschen, den Ihr Add-In verwendet, wird stattdessen der nächste gültige geheime Clientschlüssel verwendet.

Ihr Add-In kann alle gültigen geheimen Clientschlüssel als Kennwörter verwenden, um mit Microsoft zu kommunizieren. Wenn ein geheimer Clientschlüssel abläuft, kann er nicht mehr als Kennwort verwendet werden. Wenn ihrer Client-ID nur ein geheimer Clientschlüssel zugeordnet ist, kann das Löschen dieses Geheimschlüssels verhindern, dass Ihr Add-In auf die benötigten Daten zugreift.

Wenn Ihr Add-In ein Dienst ist und OAuth-Client-IDs und geheime Clientschlüssel benötigt, führen Sie die folgenden Schritte aus.

Hinzufügen einer neuen Client-ID

Wichtig

Das Angebot muss in den Microsoft Stores veröffentlicht werden, bevor die "Client-IDs" in der Produktion verwendet werden. Dies kann sich negativ auf die Benutzerfreundlichkeit Ihrer App durch Ihre Kunden auswirken. Es wird empfohlen, nicht veröffentlichte Apps in SharePoint-Lösungen zu verschieben,, da die SharePoint-Add-Ins auslaufen.

  1. Melden Sie sich mit Ihrem Entwicklerkonto bei Partner Center an, und wechseln Sie zur Seite Produktübersicht für Ihr Add-In.

  2. Wählen Sie auf der Registerkarte Client-IDs die Option Neue Client-ID hinzufügen aus.

  3. Geben Sie im Dialogfeld Neue Client-ID die folgenden Informationen an.

    Element Informationen zur Bereitstellung
    Anzeigename Wählen Sie einen Namen aus, um zu erkennen, welches Add-In die Client-ID verwendet; Beispiel: "Kalender-App"
    App-Domäne Geben Sie die Domäne an, auf der Ihr Add-In ausgeführt wird. Beispiel: app.contoso.com.
    Es muss ein gültiger Domänenname sein, den Sie besitzen; sie darf nicht http:// oder https://enthalten,
    und darf kein internationaler Domänenname sein.
    Hinzufügen einer App-Umleitungs-URL Geben Sie die Umleitungs-URL an, an die Benutzer verwiesen werden sollen, nachdem sie den Zugriffsanforderungen Ihres Add-Ins im Dialogfeld „Einwilligung“ zugestimmt haben.
    Diese URL muss mit https://, oder http://ms-app://

  4. Wählen Sie Geheimen Schlüssel jetzt erstellen aus.

  5. Wählen Sie aus, wie lange Ihr geheimer Clientschlüssel gültig ist. Die Optionen sind ein, zwei oder drei Jahre. Es wird empfohlen, ein Jahr auszuwählen, da es möglicherweise einfacher ist, innerhalb Ihrer Geschäftsprozesse nachzuverfolgen als längere Zeiträume. Es gibt jedoch keine Sicherheitsrisiken, wenn man zwei oder drei Jahre wählt. Wenn der geheime Clientschlüssel abläuft, müssen Sie Ihr Add-In aktualisieren.

  6. Wählen Sie aus, wie Ihr Client-Geheimnis verfügbar sein soll:

    • Diese Client-ID wird für eine weltweit verfügbare App verwendet.
    • Diese Client-ID wird für eine weltweit verfügbare App verwendet.

  7. Wählen Sie Geheimen Schlüssel jetzt erstellen aus.

  8. Kopieren Sie auf der SeiteGeheimen Clientschlüssel abrufen Ihre Client-ID und den geheimen Clientschlüssel an einen sicheren Speicherort, damit Sie später darauf zurückgreifen können.

    Wichtig

    Der geheime Clientschlüssel ist Ihrer Client-ID zugeordnet, wird aber nicht erneut im Partner Center angezeigt, daher achten Sie darauf, ihn aufzuzeichnen. Notieren Sie sich außerdem die Anfangs- und Enddaten, damit Sie den Gültigkeitszeitraum des geheimen Clientschlüssels und das Ablaufdatum kennen. Wenn Ihr geheimer Clientschlüssel bald abläuft, müssen Sie einen neuen geheimen Clientschlüssel generieren und Ihr Add-In aktualisieren. Weitere Informationen finden Sie unter Aktualisieren des geheimen Clientschlüssels, der Ihrer Client-ID zugeordnet ist.

  9. Wählen Sie Fertigaus.

Der geheime Clientschlüssel, der Ihrer Anwendung zugeordnet ist

Aktualisieren Sie Ihren geheimen Clientschlüssel in den folgenden Situationen:

  • Ihr geheimer Clientschlüssel läuft ab

    Es wird empfohlen, einen neuen geheimen Clientschlüssel im Partner Center hinzuzufügen, während Ihr aktueller geheimer Clientschlüssel weiterhin gültig ist. Aktualisieren Sie Ihr Add-In mit dem neuen geheimen Clientschlüssel, und löschen Sie dann den geheimen Clientschlüssel, der bald abläuft, indem Sie Löschen neben diesem Eintrag auf der Seite Client-IDs im Partner Center auswählen.

    Hinweis

    Microsoft Office Developer Tools für Visual Studio unterstützt das Festlegen eines sekundären geheimen Clientschlüssels, mit dem Sie Ihren ablaufenden geheimen Clientschlüssel aktualisieren können.

  • Die Sicherheit Ihres geheimen Clientschlüssels ist kompromittiert

    Um schnell auf eine Sicherheitskompromittierung zu reagieren, können Sie zuerst den kompromittierten geheimen Clientschlüssel aus Partner Center löschen, einen neuen geheimen Clientschlüssel hinzufügen und dann Ihr Add-In mit dem neuen geheimen Clientschlüssel aktualisieren.

    Wichtig

    Nachdem Sie einen kompromittierten geheimen Clientschlüssel gelöscht haben und bevor Sie den neuen geheimen Clientschlüssel hinzufügen, ist Das Add-In möglicherweise vorübergehend nicht verfügbar. Dieses Szenario kann jedoch besser sein als die potenziell schwerwiegenden Geschäftlichen Auswirkungen, die sich aus einem verlorenen oder gestohlenen geheimen Clientschlüssel ergeben.

Generiere andere Client-Geheimnisse

  1. Melden Sie sich mit Ihrem Entwicklerkonto bei Partner Center an, und wechseln Sie zur Seite Produktübersicht für Ihr Add-In.

  2. Wählen Sie auf der Registerkarte Client-IDs die Client-ID aus, der Sie andere geheime Clientschlüssel zuordnen möchten.

  3. Wählen Sie auf der Detailseite der Client-ID Neuer geheimer Clientschlüssel aus.

  4. Wählen Sie aus, für wie lange der geheime Schlüssel gültig sein soll. Die Optionen sind ein, zwei oder drei Jahre.

  5. Klicken Sie auf Erstellen.

  6. Kopieren Sie im Dialogfeld Kundenschlüssel abrufen den geheimen Kundenschlüssel an einen sicheren Speicherort, damit Sie später darauf zurückgreifen können.

    Wichtig

    Der geheime Clientschlüssel ist Ihrer Client-ID zugeordnet, wird aber nicht erneut im Partner Center angezeigt, daher achten Sie darauf, ihn aufzuzeichnen. Notieren Sie außerdem die Anfangs- und Enddaten, damit Sie den Gültigkeitszeitraum des geheimen Clientschlüssels und das Ablaufdatum kennen.

  7. Wählen Sie Fertigaus.

    Hinweis

    Der neue geheime Clientschlüssel ist innerhalb von 15 Minuten aktiv.

Löschen eines geheimen Clientschlüssels

  1. Melden Sie sich mit Ihrem Entwicklerkonto bei Partner Center an, und wechseln Sie zur Seite Produktübersicht für Ihr Add-In.

  2. Wählen Sie auf der Registerkarte Client-IDs die Option Löschen neben der Client-ID aus, die den geheimen Clientschlüssel enthält, den Sie löschen möchten.

    Wichtig

    Das Löschen eines geheimen Clientschlüssels kann verhindern, dass Ihr Add-In auf die benötigten Daten zugreift, es sei denn, Sie haben zusätzliche geheime Schlüssel erstellt, die Sie überprüfen und ihrem Add-In zuordnen. Sie müssen Ihr Add-In auch so konfigurieren, dass die zusätzlichen geheimen Clientschlüssel verwendet werden. Wenn der Client-ID nur ein geheimer Clientschlüssel zugeordnet ist, wird empfohlen, einen anderen geheimen Clientschlüssel zu generieren, bevor Sie ihn löschen.

  3. Wählen Sie im Dialogfeld Bestätigung die Option Löschen aus.

Löschen einer Client-ID

Möglicherweise möchten Sie eine Client-ID in bestimmten Situationen löschen, z. B.:

  • Sie möchten Ihr Add-In nicht mehr anbieten.
  • Sie möchten eine neue Version Ihres Add-Ins anbieten und die vorherige Version nicht mehr anbieten. In dieser Situation möchten Sie möglicherweise die Client-ID löschen, die Sie mit der vorherigen Version Ihres Add-Ins verknüpft haben.

Warnung

Durch das Löschen einer Client-ID, die Ihrem Add-In zugeordnet ist, werden alle zugehörigen geheimen Clientschlüssel gelöscht und verhindert, dass sie auf die benötigten Daten zugreift. Jeder Kunde, der Ihr Add-In verwendet, erlebt dann Ausfallzeiten, nachdem Sie eine dem Add-In zugeordnete Client-ID gelöscht haben.

  1. Melden Sie sich mit Ihrem Entwicklerkonto bei Partner Center an, und wechseln Sie zur Seite Produktübersicht für Ihr Add-In.
  2. Wählen Sie auf der Registerkarte Client-IDs die Option Löschen neben der Client-ID aus, die den geheimen Clientschlüssel enthält, den Sie löschen möchten.
  3. Wählen Sie im Dialogfeld Bestätigung die Option Löschen aus.

Um eine Client-ID zu löschen, aber weiterhin Ihr Add-In anzubieten

  1. Fügen Sie eine andere Client-ID und mindestens einen gültigen geheimen Clientschlüssel hinzu. Ausführliche Informationen finden Sie unter Hinzufügen einer Client-ID und eines geheimen Clientschlüssels.

  2. Löschen Sie die Client-ID aus Ihrem Code.

  3. Löschen Sie die Client-ID aus Partner Center, wie im vorherigen Verfahren beschrieben.

  4. Fügen Sie dem Code die neue Client-ID und den geheimen Clientschlüssel hinzu.

  5. Wählen Sie auf der Seite Produktübersicht die Option Veröffentlichen aus.

    Hinweis

    Kunden erleben Ausfallzeiten, während Ihr Add-In auf Ihren Code aktualisiert wird und der Genehmigungsprozess im Partner Center läuft.

Verwandte Inhalte