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

Erstellen oder löschen Sie Client-IDs und geheime Schlüssel, aktualisieren oder ersetzen Sie ablaufende geheime Clientschlüssel, und verknüpfen Sie die Schlüssel mit Ihren Apps im Partner-Center, um OAuth in Ihren SharePoint-Add-Ins zu aktivieren.

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

  1. Generien Sie einen neuen geheimen Clientschlüssel und fügen Sie ihn über das Partner Center hinzu, um den neuen geheimen Clientschlüssel dieser bestimmten Add-In-Client-ID zuzuordnen. Die einzelnen Schritte zur Vorgehensweise finden Sie im Abschnitt So generieren Sie zusätzliche geheime Clientschlüssel unter Aktualisieren des geheimen Clientschlüssels, der Ihrer Client-ID zugeordnet ist in diesem Artikel.

  2. Aktualisieren Sie Ihre Remote-Webanwendung, damit Sie den neuen geheimen Clientschlüssel verwendet. Weitere Informationen dazu, wie Sie dies mit Microsoft Office Developer Tools für Visual Studio durchführen, finden Sie unter Aktualisieren der Remote-Webanwendung in Visual Studio zum Verwenden des neuen Geheimnisses in Ersetzen eines ablaufenden geheimen Clientschlüssels in einem SharePoint-Add-In.

  3. Veröffentlichen Sie Ihre Remote-Webanwendung erneut.

Wichtig

Microsoft Office-Entwicklertools für Visual Studio unterstützt das Festlegen eines sekundären geheimen Clientschlüssels, den Sie verwenden können, um Ihren ablaufenden geheimen Clientschlüssel zu aktualisieren.

Verwenden von OAuth zur Authentifizierung und Autorisierung von Add-Ins

Open Authorization (OAuth) ist ein offenes Autorisierungsprotokoll. OAuth ermöglicht die sichere Autorisierung von Desktop- und Webanwendungen auf einfache und standardmäßige Weise. Das Protokoll ermöglicht es Benutzern, eine Anwendung in ihrem Auftrag Aufgaben durchführen zu lassen, ohne dass sie ihren Benutzernamen und ihr Kennwort angeben müssen. Beispielsweise ermöglicht OAuth Benutzern, ihre auf einer Website gespeicherten privaten Ressourcen oder Daten (Kontaktlisten, Dokumente, Fotos, Videos usw.) auf einer anderen Website freizugeben, ohne dass Anmeldeinformationen (in der Regel Benutzername und Kennwort) angegeben werden müssen.

Mit OAuth können Benutzer einen Dienstanbieter (z. B. SharePoint) für das Bereitstellen von Token anstelle von Anmeldeinformationen (z. B. Benutzername und Kennwort) für ihre Daten autorisieren, die von einem bestimmten Dienstanbieter (z. B. SharePoint) gehostet werden. Jedes Token gewährt Zugriff auf eine bestimmte Website (z. B. ein SharePoint-Dokumentrepository) für bestimmte Ressourcen (z. B. Dokumente aus einem Ordner) und über einen festgelegten Zeitraum. Benutzer können dann einen Drittanbieter-Websitezugriff auf Informationen gewähren, die bei einem anderen Dienstanbieter (z. B. SharePoint) gespeichert werden, ohne Benutzernamen und Kennwort und in SharePoint verfügbare Daten freizugeben.

Wenn Ihr Add-In diese Art der Authentifizierung benötigt, müssen Sie die OAuth-Client-ID und geheimen Clientschlüssel Ihrem Add-In zuordnen. Sie können eine OAuth-Client-ID und geheime Clientschlüssel im Partner Center generieren und anschließend dem Code Ihres Add-Ins hinzufügen.

Wenn Benutzer ein Add-In installieren, dem eine Client-ID und ein geheimer Clientschlüssel zugeordnet sind, wird ihnen ein Dialogfeld angezeigt, in dem sie ihre Einwilligung geben müssen. Wenn der Benutzer seine Einwilligung gibt, kann das Add-In im Auftrag des Benutzers auf die Daten zugreifen, die vom Add-In benötigt werden. Benutzer können nur die Berechtigungen erteilen, über die sie verfügen. Die erteilten Berechtigungen stellen die Berechtigungen dar, die ein Benutzer an ein Add-In delegiert hat.

Angenommen, bei Ihrem Add-In handelt es sich um ein Reisekalender-Add-In, das als IFRAME auf einer Microsoft 365 SharePoint-Website geöffnet wird. OAuth würde es dem Add-In gestatten, den Benutzer zu identifizieren, dem der Reisekalender gehört. Und wenn das Reisekalender-Add-In auf andere Informationen in Microsoft 365 zugreifen müsste, wie Ressourcen oder Kalenderdaten, könnte sie dies im Namen des angemeldeten Benutzers tun.

Hinweis

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

Hinzufügen einer Client-ID und eines geheimen Clientschlüssels

Sie können Ihrem Add-In nur eine Client-ID zuordnen, Sie können Ihrer Client-ID jedoch mehrere geheime Clientschlüssel zuordnen. Aus Sicherheits- und administrativen Gründen empfehlen wir, die Anzahl der Clientschlüssel, die einer Client-ID zugeordnet sind, möglichst gering zu halten.

Wichtig

Gehen Sie wie folgt vor, um ein SharePoint-Add-In zu übermitteln, das OAuth verwendet und das Sie in China vertreiben möchten:

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

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

Eingehende Add-In-Daten werden nur mit einem geheimen Clientschlüssel signiert. Im Partner Center handelt es sich hierbei um den geheimen Clientschlüssel mit einem grünen Häkchen neben Aktiv in der Spalte Status auf der Seite Client-IDs. Wenn Sie den von dem Add-In zum Signieren verwendeten geheimen Clientschlüssel löschen, wird stattdessen der nächste gültige geheime Clientschlüssel verwendet.

Ihr Add-In kann jeden beliebigen gültigen Clientschlüssel zur Kommunikation mit Microsoft verwenden. Wenn ein geheimer Clientschlüssel abläuft, kann er nicht länger als Kennwort verwendet werden. Wenn Ihrer Client-ID nur ein geheimer Clientschlüssel zugeordnet ist, kann ein Löschen dieses Schlüssels dazu führen, dass Ihr Add-In nicht auf benötigte Daten zugreifen kann.

Wenn es sich bei Ihrem Add-In um einen Dienst handelt und es OAuth-Client-IDs und geheime Clientschlüssel benötigt, führen Sie die nachfolgenden Schritte aus.

So fügen Sie eine Client-ID hinzu

  1. Melden Sie sich bei Partner Center mit Ihrem Entwicklerkonto 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 OAuth-Client-ID hinzufügen aus.

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

    Element Benötigte Information
    Anzeigename Wählen Sie einen Namen, an dem Sie gleich erkennen, welches Add-In die betreffende Client-ID verwendet. Beispiel: „Kalender-App“.
    App-Domäne Geben Sie die Domäne an, in der Ihr Add-In ausgeführt werden wird. Zum Beispiel: app.contoso.com.
    Dies muss ein gültiger Domänenname sein, den Sie besitzen. Er darf weder http:// noch https:// enthalten
    und darf kein internationaler Domänenname (IDN) sein.
    App-Umleitungs-URL Geben Sie die Umleitungs-URL ein, an die Benutzer umgeleitet werden, nachdem sie den Zugangsanforderungen für Ihr Add-In im entsprechenden Dialogfeld zugestimmt haben.
    Diese URL muss mit https://, http:// oder ms-app:// beginnen.
  4. Wählen Sie Geheimen Schlüssel jetzt erstellen aus.

  5. Wählen Sie aus, für wie lange Ihr geheimer Clientschlüssel gültig sein soll. Die Optionen sind ein, zwei oder drei Jahre. Es wird empfohlen, ein Jahr zu wählen, da dies in Ihren Geschäftsprozessen möglicherweise einfacher nachverfolgt werden kann als ein längerer Zeitraum. Die Auswahl von zwei oder drei Jahren hat jedoch keine Auswirkungen auf die Sicherheit. Wenn der geheime Clientschlüssel abläuft, müssen Sie Ihr Add-In aktualisieren.

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

    • Diese Client-ID wird für eine App verwendet, das weltweit verfügbar ist.
    • Diese Client-ID wird für eine App verwendet, das nur in China verfügbar ist.
  7. Wählen Sie Geheimen Schlüssel jetzt erstellen aus.

  8. Kopieren Sie Ihre Client-ID und den geheimen Clientschlüssel von der Seite Geheimen Clientschlüssel abrufen aus an einen sicheren Speicherort, um später darauf zugreifen zu können.

    Wichtig

    Der geheime Clientschlüssel ist Ihrer Client-ID zugeordnet, wird jedoch nicht wieder im Partner Center angezeigt. Sie sollten auch das Anfangs- und Enddatum notieren, damit Sie den Gültigkeitszeitraum und das Ablaufdatum des geheimen Clientschlüssels jederzeit nachsehen können. 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 Fertig aus.

Aktualisieren des geheimen Clientschlüssels, der Ihrer Client-ID zugeordnet ist

Sie sollten den geheimen Clientschlüssel in den folgenden Situationen aktualisieren:

  • Ihr geheimer Clientschlüssel läuft ab

    Sie sollten einen neuen geheimen Clientschlüssel im Partner Center hinzufügen, solange der aktuelle Clientschlüssel noch gültig ist. Aktualisieren Sie das Add-In mit dem neuen geheimen Clientschlüssel, und löschen Sie dann den geheimen Clientschlüssel, der demnächst abläuft, indem Sie Löschen neben diesem Eintrag auf der Seite Client-IDs im Partner Center auswählen.

    Hinweis

    Microsoft Office-Entwicklertools für Visual Studio unterstützt das Festlegen eines sekundären geheimen Clientschlüssels, den Sie verwenden können, um Ihren ablaufenden geheimen Clientschlüssel zu aktualisieren.

  • Die Sicherheit Ihres geheimen Clientschlüssels ist gefährdet

    Wenn die Sicherheit Ihres geheimen Clientschlüssels gefährdet ist, können Sie rasch Abhilfe schaffen, indem Sie zuerst den gefährdeten geheimen Clientschlüssel aus dem Partner Center löschen, dann einen neuen geheimen Clientschlüssel hinzufügen und schließlich Ihr Add-In mit dem neuen geheimen Clientschlüssel aktualisieren.

    Wichtig

    Nachdem der gefährdete geheime Clientschlüssel gelöscht wurde und bevor der neue Clientschlüssel hinzugefügt wird, kkann Ihr Add-In möglicherweise zeitweise unerreichbar sein. Dies ist je nach der Schwere der Auswirkungen auf das Unternehmen durch einen verloren gegangenen oder gestohlenen geheimen Clientschlüssel vertretbar.

So generieren Sie weitere geheime Clientschlüssel

  1. Melden Sie sich bei Partner Center mit Ihrem Entwicklerkonto 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 weitere geheime Clientschlüssel zuordnen möchten.

  3. Wählen Sie auf der Seite „Client-ID-Details“ die Option Neuer geheimer Clientschlüssel aus.

  4. Wählen Sie aus, wie lange der geheime Clientschlüssel gültig sein soll. Die Optionen sind 1, 2 oder 3 Jahre.

  5. Wählen Sie Erstellen aus.

  6. Kopieren Sie den geheimen Clientschlüssel, der im Dialogfeld Geheimen Clientschlüssel abrufen angezeigt wird, an einen sicheren Speicherort, um später darauf zugreifen zu können.

    Wichtig

    Der geheime Clientschlüssel ist Ihrer Client-ID zugeordnet, wird jedoch nicht wieder im Partner Center angezeigt. Notieren Sie sich das Anfangs- und Enddatum, damit Sie die Gültigkeitsperiode und das Ablaufdatum des geheimen Clientschlüssels jederzeit nachsehen können.

  7. Wählen Sie Fertig aus.

    Hinweis

    Der neue geheime Clientschlüssel wird binnen 15 Minuten aktiviert.

So löschen Sie einen geheimen Clientschlüssel

  1. Melden Sie sich bei Partner Center mit Ihrem Entwicklerkonto 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, deren geheimen Clientschlüssel Sie löschen möchten.

    Wichtig

    Wenn der geheime Clientschlüssel gelöscht wird, kann Ihr Add-In möglicherweise nicht mehr auf benötigte Daten zugreifen, es sei denn, Sie haben weitere geheime Clientschlüssel erstellt, die gültig und Ihrem Add-In zugeordnet sind. Zudem muss Ihr Add-In für die Verwendung dieser zusätzlichen geheimen Clientschlüssel konfiguriert sein. Wenn der Client-ID nur ein geheimer Clientschlüssel zugeordnet ist, wird empfohlen, dass Sie vor dem Löschen des Clientschlüssels einen weiteren geheimen Clientschlüssel generieren.

  3. Wählen Sie im Bestätigungsdialogfeld Löschen aus.

Löschen einer Client-ID

In bestimmten Fällen kann es wünschenswert sein, eine Client-ID zu löschen. Beispiele:

  • Sie möchten Ihr Add-In nicht länger anbieten.

  • Sie möchten eine neue Version Ihres Add-Ins anbieten und die Vorgängerversion aus dem Angebot nehmen. Daher möchten Sie möglicherweise die Client-ID löschen, die Sie der vorherigen Version Ihres Add-Ins zugeordnet haben.

Warnung

Durch das Löschen einer Client-ID, die Ihrem Add-In zugeordnet ist, löschen Sie alle zugehörigen geheimen Clientschlüssel und verhindern den Zugriff des Add-Ins auf benötigte Daten. Nachdem Sie eine Client-ID gelöscht haben, die Ihrem Add-In zugeordnet ist, kommt es bei den Benutzern Ihres Add-Ins zu Ausfallzeiten.

So löschen Sie eine Client-ID

  1. Melden Sie sich bei Partner Center mit Ihrem Entwicklerkonto 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, deren geheimen Clientschlüssel Sie löschen möchten.

  3. Wählen Sie im Bestätigungsdialogfeld Löschen aus.

So löschen Sie eine Client-ID, bieten das Add-In aber weiter an

  1. Fügen Sie eine weitere Client-ID und mindestens einen gültigen geheimen Clientschlüssel hinzu. Weitere 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 dem Partner Center, wie zuvor beschrieben.

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

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

    Hinweis

    Während der Aktualisierung Ihres Codes und des Genehmigungsprozesses im Partner Center kommt es bei Kunden, die Ihr Add-In verwenden, zu Ausfallzeiten.

Weitere Artikel