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

Warnung

Der SharePoint-Client-ID-Verwaltungsdienst durchläuft eine wichtige Änderung. Sie benötigen einen Microsoft Azure AD/Entra-Mandanten, um den Dienst nach dem 1. März 2023 weiterhin ohne Unterbrechung zu verwenden. Wechseln Sie zu den Mandanteneinstellungen in Ihrem Partner Center-Konto, und erstellen Sie eine neue Entra-ID, oder ordnen Sie Ihre aktuelle ID zu, um den Dienst weiterhin zu verwenden.

So aktualisieren Sie ablaufende geheime Clientschlüssel in SharePoint-Add-Ins

  1. Generieren Sie einen neuen geheimen Clientschlüssels und fügen Sie ihn im Partner Center hinzu, um diese bestimmte Add-In-Client-ID zuzuordnen. Spezifische Schritte finden Sie unter So generieren Sie zusätzliche geheime Clientschlüssel in Clientschlüssel aktualisieren, der Ihrer Client-ID zugeordnet ist weiter unten in diesem Artikel.
  2. Aktualisieren Sie Ihre Remotewebanwendung so, dass der neue geheime Clientschlüssel verwendet wird. Informationen dazu, wie dies mit den Microsoft Office Developer Tools für Visual Studio getan werden kann, finden Sie in Aktualisieren der Remotewebanwendung in Visual Studio, um den neuen geheimen Schlüssel 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 Drittanbieterwebsite Zugriff auf Informationen gewähren, die mit einem anderen Dienstanbieter gespeichert sind (z. B. SharePoint), 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. Zuweisungen stellen die Berechtigungen dar, die ein Benutzer an ein Add-In delegiert hat.

Ihr Add-In könnte beispielsweise ein Reisekalender-Add-In sein, das als IFRAME auf einer Microsoft 365 SharePoint-Website geöffnet wird. OAuth ermöglicht es dem Add-In, den Benutzer zu identifizieren, zu dem der Reisekalender gehört, oder wenn das Reisekalender-Add-In benötigt wird, um auf andere Aspekte von Microsoft 365 zuzugreifen, z. B. Ressourcen oder Kalenderinformationen, kann er 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, Kontexttoken-OAuth-Fluss für SharePoint-Add-Ins und 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. In Partner Center ist dies der geheime Clientschlüssel mit einem grünen Häkchen neben Aktiv 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 nur ein geheimer Clientschlüssel ihrer Client-ID zugeordnet ist, kann das Löschen dieses geheimen Schlü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.

So fügen Sie eine Client-ID hinzu

  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 diese 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.
    Dies muss ein gültiger Domänenname sein, den Sie besitzen; sie darf nicht http:// oder https:// enthalten
    und darf kein internationaler Name sein Standard
    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 dies innerhalb Ihrer Geschäftsprozesse möglicherweise einfacher nachzuverfolgen ist als längere Zeiträume. Es bestehen jedoch keine Sicherheitsauswirkungen, wenn Sie zwei oder drei Jahre auswählen. Wenn der geheime Clientschlüssel abgelaufen ist, müssen Sie Ihr Add-In aktualisieren.

  6. Wählen Sie die Verfügbarkeit des geheimen Clientschlüssels aus. Wählen Sie eines der folgenden Szenarien aus:

    • 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. Sie sollten auch die Anfangs- und Endtermine aufzeichnen, sodass Sie den Gültigkeitszeitraum des geheimen Clientschlüssels und dessen 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 der kompromittierte geheime Clientschlüssel gelöscht wurde und bevor der neue geheime Clientschlüssel hinzugefügt wird, ist Ihr Add-In möglicherweise vorübergehend nicht verfügbar. Dies kann je nach Schweregrad der geschäftlichen Auswirkungen eines verloren gegangenen oder gestohlenen geheimen Clientschlüssels akzeptabel sein.

So generieren Sie zusätzliche geheime Clientschlüssel

  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, mit der Sie zusätzliche 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 den geheimen Clientschlüssel im Dialogfeld Geheimen Clientschlüssel abrufen 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. Sie sollten auch die Anfangs- und Endtermine aufzeichnen, sodass Sie den Gültigkeitszeitraum des geheimen Clientschlüssels und dessen Ablaufdatum kennen.

  7. Wählen Sie Fertigaus.

    Hinweis

    Der neue geheime Clientschlüssel wird 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 zugreifen kann, es sei denn, Sie haben zusätzliche Geheimnisse erstellt, die gültig sind und dem Add-In zugeordnet sind, und Sie haben es so konfiguriert, dass es die zusätzlichen Clientschlüssel verwenden. Wenn nur ein Clientschlüssel mit der Client-ID verknüpft ist, wird empfohlen, vor dem Löschen einen zusätzlichen geheimen Clientschlüssel zu generieren.

  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 zugeordneten Clientschlüssel gelöscht und verhindert, dass sie auf die benötigten Daten zugreifen. Jeder Kunde, der Ihr Add-In verwendet, wird Ausfallzeiten erleben, nachdem Sie eine Client-ID gelöscht haben, die dem Add-In zugeordnet ist.

So löschen Sie eine Client-ID

  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, die Ihr Add-In verwenden, erleben während des Updates für Ihren Code und den Genehmigungsprozess von Partner Center Ausfallzeiten.

Siehe auch