HighBond-Zugriffstoken erstellen und verwalten

Erstellen oder verwalten Sie Ihre persönlichen HighBond-Zugriffstoken auf der Seite API-Token verwalten, die Sie über Ihre Launchpad-Profilseite erreichen.

Was ist ein Zugriffstoken?

Ein Zugriffstoken ist eine Zeichenfolge, die einen Benutzer identifiziert und den Zugriff auf andere Anwendungen authentifiziert.

Welchen Zugriffstoken Sie benötigen, hängt davon ab, was Sie tun müssen:

• Diligent One-Daten aus der Projekte-App in Analytics importieren – Analytics- oder HighBond-API-Token
• Diligent One-Daten aus der Ergebnisse-App in Analytics importieren – Analytics- oder HighBond-API-Token
• Daten aus der Diligent One-Ergebnisse-App aus Analytics exportieren – Analytics- oder HighBond-API-Token
• Programmatischen Zugriff auf die Diligent One-Plattform erhalten – HighBond-API-Token
• Programmatischen Zugriff auf die Launchpad-Aktivitätsprotokolle erhalten – Aktivitätsprotokolle-API-Token

  Hinweis

  Der Zugriff auf Launchpad-Aktivitätsprotokolle ist nur für Systemadministratoren verfügbar.

Analytics-Token

Der Analytics-Token wird bei jeder Aktivierung von Analytics automatisch generiert und in Ihrer Registrierung gespeichert.

• Wenn Sie Analytics 14 oder niedriger verwenden und manuell einen ACLGRC-Zugriffstoken erstellen, wird der Token in Launchpad als ein Analytics-Tokentyp kategorisiert.
• Wenn Sie Analytics 14.1 verwenden und einen HighBond-Zugriffstoken manuell erstellen, wird das Token in Launchpad als Analytics-Tokentyp kategorisiert.

Funktionsweise

Im Launchpad werden auf der Seite API-Token verwalten alle Zugriffstoken angezeigt, die Sie generiert haben.

Sie können die Seite API-Token verwalten nutzen, um:

• Ihre Token zu kopieren
• eine Bezeichnung zu vergeben, die den Zugriffstoken beschreibt oder identifiziert
• Zugriffstoken zu sperren, um zu verhindern, dass diese geändert oder gelöscht werden
• Zugriffstoken zu löschen

Berechtigungen

Jeder Benutzer kann einen Analytics-Token erstellen. Sie müssen Systemadministrator in mindestens einer Diligent One-Instanz sein, um einen HighBond-API-Token oder einen Aktivitätsprotokolle-API-Token zu erstellen.

Alle Benutzer können ihre eigenen Zugriffstoken verwalten.

Zugriffstoken erstellen

1. Öffnen Sie Launchpad.

Hinweis

Wenn Ihr Unternehmen mehr als eine Instanz in Diligent One verwendet, stellen Sie sicher, dass die entsprechende Instanz aktiv ist.

2. Wählen Sie  > Profil aus.
3. Klicken Sie unter Anwendungstoken auf Verwalten. Die Seite API-Token verwalten wird geöffnet.
4. Klicken Sie auf +Token hinzufügen und wählen Sie die geeignete Option im Dropdown-Menü aus (z. B. HighBond-API, Analytics oder Aktivitätsprotokolle-API). Der Seitenbereich Neuer Token wird angezeigt.
5. Füllen Sie alle Felder in dem Seitenbereich aus, um ein Token zu erstellen.

   Hinweis

   Alle Felder sind erforderlich, um einen Token zu erstellen, einschließlich des Feldes Beschreibung. Die einzige Ausnahme ist, wenn Sie sich dafür entscheiden, kein Ablaufdatum für den Token anzugeben. In diesem Fall müssten Sie die Anzahl der Tage, nach denen ein Token ablaufen soll, nicht angeben, da die Anzahl der Tage standardmäßig auf Nie festgelegt wird.

   1. Geben Sie eine Beschreibung ein.

      Tipp

      Geben Sie in der Beschreibung alle Orte an, an denen das Token verwendet wird, sowie seinen Zweck. Der Grund dafür ist, dass Token ersetzt werden müssen, wenn sie ablaufen, und das Hinzufügen einer detaillierten Beschreibung spart Zeit und Aufwand, wenn ein Token ersetzt werden muss.

   2. Optional. Aktivieren oder deaktivieren Sie den Ablauf des Tokens.

      Hinweis

      Die Möglichkeit, den Ablauf eines Tokens festzulegen, sollte standardmäßig aktiviert (eingeschaltet) sein. Wenn diese Option deaktiviert ist, läuft der Token nicht ab.

   3. Geben Sie die Anzahl der Tage an, nach denen der Token ab dem Erstellungsdatum des Tokens ablaufen soll, höchstens jedoch ein Jahr (365 Tage).
   4. Geben Sie Ihr Diligent One-Kontokennwort ein, um Ihre Identität zu bestätigen.
6. Klicken Sie auf Token generieren. Der Seitenbereich wird mit einer Meldung aktualisiert, die bestätigt, dass Ihr Token erfolgreich erstellt wurde. Die Meldung enthält die Token-ID, das Ablaufdatum (das Datum und die Uhrzeit, zu der das Token abläuft) und die Beschreibung.
7. Klicken Sie auf Kopieren. Die Meldung In die Zwischenablage kopiert bestätigt, dass der Token erfolgreich kopiert wurde.

   Achtung

   Speichern Sie Ihr Token, bevor Sie den Seitenbereich schließen. Aus Sicherheitsgründen ist dies Ihre einzige Gelegenheit für den Zugriff. Wenn Sie Ihr Token nicht speichern und dieses vergessen, müssen Sie ein neues erstellen.
8. Klicken Sie auf Schließen. Der Seitenbereich Neuer Token wird geschlossen.
9. Fügen Sie den Token in eine Anwendung oder ein Skript ein.

   Hinweis

   Behandeln Sie den Token wie ein Kennwort und geben Sie ihn nicht an andere weiter.

API-Token verwalten

Auf der Seite API-Token verwalten können Sie eine Liste mit vorhandenen Token anzeigen, Tokenbeschreibungen bearbeiten, Token sperren, damit sie nicht bearbeitet oder gelöscht werden können, und Token löschen.

1. Öffnen Sie Launchpad.

Hinweis

Wenn Ihr Unternehmen mehr als eine Instanz in Diligent One verwendet, stellen Sie sicher, dass die entsprechende Instanz aktiv ist.

2. Wählen Sie  > Profil aus.
3. Klicken Sie unter Anwendungstoken auf Verwalten. Die Seite API-Token verwalten wird geöffnet.
4. Führen Sie eine der folgenden Aktionen aus.

Zugriffstoken überprüfen

Um bestimmte Token zu finden, können Sie suchen, sortieren und filtern. Führen Sie einen der folgenden Schritte aus:

• Token suchen: Geben Sie die ersten Zeichen des Zugriffstokens (bis zu sieben Zeichen) in die Suchleiste ein. Dadurch wird eine eingeschränkte Liste mit Ergebnissen zurückgegeben.
• Token sortieren: Klicken Sie auf eine beliebige Spaltenüberschrift, um Token nach der ausgewählten Spalte in aufsteigender oder absteigender Reihenfolge zu sortieren.
• Token filtern: Standardmäßig werden alle generierten Token angezeigt. Sie können jedoch die Liste der Token auf eine Teilmenge filtern, z. B. ob ein Token gesperrt ist oder nach dem Token-Typ: Analytics, Aktivitätsprotokolle oder HighBond-API. Wählen Sie die gewünschten Filter in den verfügbaren Dropdown-Menüs aus, um die Liste der Token zu filtern. Klicken Sie auf Löschen, um alle Filter zu entfernen.

Beschreibungen von Zugriffstoken bearbeiten

1. Klicken Sie auf das Bleistiftsymbol . Das Feld Beschreibung kann nun bearbeitet werden.
2. Aktualisieren Sie die Beschreibung und klicken Sie auf das Häkchen , um Ihre Änderungen zu speichern. Die aktualisierte Beschreibung wird in der Tabelle angezeigt.

Zugriffstoken sperren und entsperren

Wenn Sie verhindern möchten, dass Token gelöscht und Tokenbeschreibungen bearbeitet werden, können Sie sie sperren. Alternativ können Sie Token entsperren, um Beschreibungen zu ändern und das Löschen zu ermöglichen.

• Klicken Sie auf das geöffnete Schloss neben Ihrem Token, um das Löschen von Token und die Bearbeitung von Beschreibungen zu deaktivieren. Das Schloss wird geschlossen angezeigt, um anzugeben, dass der Token nicht bearbeitet oder gelöscht werden kann. Zudem werden der Bleistift und der Papierkorb ausgeblendet.
• Klicken Sie auf das geschlossene Schloss , um den Token zu entsperren und das Löschen von Token und die Bearbeitung von Beschreibungen zu ermöglichen. Das Schloss wird geöffnet angezeigt, um anzugeben, dass Bearbeiten und Löschen möglich sind. Zudem werden der Bleistift und der Papierkorb wieder eingeblendet.

Zugriffstoken löschen

Sie können einzelne Token, mehrere Token gleichzeitig oder alle Token in der Liste löschen. Wenn Sie frühere Token nicht als Referenz beibehalten müssen, können Sie sie löschen, um die Liste der Token übersichtlich zu halten. Die Entscheidung, Token zu löschen, sollte jedoch mit Vorsicht angegangen werden und nur dann erfolgen, wenn bestätigt wurde, dass der Token nirgendwo mehr verwendet wird, da eine Löschung dauerhaft ist und nicht rückgängig gemacht werden kann.

Einzelne Token löschen

1. Klicken Sie auf den Papierkorb neben dem Token. Das Dialogfeld # Token löschen? wird angezeigt, in dem Sie das Löschen bestätigen.
2. Klicken Sie auf Token löschen. Der Token wird dauerhaft gelöscht und aus der Liste entfernt.

Achtung

Das Löschen eines Tokens ist dauerhaft und kann nicht rückgängig gemacht werden. Wird ein Token gelöscht, der gerade verwendet wird, schlagen alle damit verbundenen Prozesse fehl. Wenn ein Token irrtümlich gelöscht wird, müsste er neu erstellt und in die betroffene Anwendung oder das Skript erneut eingefügt werden.

Mehrere Token löschen

1. Klicken Sie auf die Kontrollkästchen neben den Token, die Sie löschen möchten. Oberhalb der Liste mit den Token wird eine rote Schaltfläche angezeigt, die die Anzahl der zu löschenden Token angibt.
2. Klicken Sie auf # Token löschen. Das Dialogfeld # Token löschen? wird angezeigt, in dem Sie das Löschen bestätigen.
3. Klicken Sie auf Token löschen. Die Token werden dauerhaft gelöscht und aus der Liste entfernt.

Achtung

Das Löschen eines Tokens ist dauerhaft und kann nicht rückgängig gemacht werden. Wird ein Token gelöscht, der gerade verwendet wird, schlagen alle damit verbundenen Prozesse fehl. Wenn ein Token irrtümlich gelöscht wird, müsste er neu erstellt und in die betroffene Anwendung oder das Skript erneut eingefügt werden.

Alle Token löschen

1. Aktivieren Sie das Kontrollkästchen neben dem Informationssymbol . Dadurch werden alle Token in der Liste automatisch ausgewählt und oberhalb der Liste mit den Token wird eine rote Schaltfläche angezeigt, die die Anzahl der zu löschenden Token angibt.
2. Klicken Sie auf # Token löschen. Das Dialogfeld # Token löschen? wird angezeigt, in dem Sie das Löschen bestätigen.
3. Klicken Sie auf # Token löschen. Die Token werden dauerhaft gelöscht und aus der Liste entfernt.

Achtung

Das Löschen eines Tokens ist dauerhaft und kann nicht rückgängig gemacht werden. Wird ein Token gelöscht, der gerade verwendet wird, schlagen alle damit verbundenen Prozesse fehl. Wenn ein Token irrtümlich gelöscht wird, müsste er neu erstellt und in die betroffene Anwendung oder das Skript erneut eingefügt werden.

Informationen zu ablaufenden Token

Es werden mehrere Erinnerungen gesendet, bis der Token gelöscht wird oder abläuft. Token-Ersteller erhalten 30 Tage, 5 Tage und 1 Tag vor dem Ablaufdatum eines Tokens Benachrichtigungs-E-Mails. Eine E-Mail-Benachrichtigung wird auch gesendet, wenn der Token abläuft. Wenn ein Token abgelaufen ist, schlagen alle Prozesse fehl, die von dem Token abhängen, bis er durch einen neuen Token ersetzt wird.

Ablaufende Token durch neue Token ersetzen

Um zu vermeiden, dass Prozesse fehlschlagen, müssen ablaufende und abgelaufene Token durch neue ersetzt werden. Um einen Token zu aktualisieren, müssen Sie einen neuen Token erstellen. Siehe Zugriffstoken erstellen. Nachdem Sie einen neuen Token erstellt haben, suchen Sie alle Instanzen, die den ablaufenden Token verwenden und ersetzen Sie den ablaufenden Token durch den neu erstellten Token.

Ablaufende Token löschen

Löschen Sie einen ablaufenden Token, um keine Benachrichtigungen mehr über einen bevorstehenden Ablauf zu erhalten und um alle Token zu entfernen, die Sie nicht mehr benötigen. Siehe Zugriffstoken löschen.