Dieser Artikel richtet sich an:
- Sicherheitsadministratoren der Organisation
Erstellen einer API-Berechtigung
Für den Zugriff auf die Workiva-APIs benötigen Benutzer*innen eine API-Berechtigung zur Autorisierung. Wenn Sie als Sicherheitsadministrator der Organisation eine API-Berechtigung für einen Benutzer erstellen, können Sie die Details der Berechtigung bearbeiten oder die Berechtigung löschen. Allerdings kann nur der/die Benutzer*in das Secret seiner Berechtigung einsehen, indem er die Berechtigung in seinem Profil neu generiert.
So beginnen Sie die Erstellung einer API-Berechtigung:
- Klicken Sie oben rechts auf das Benutzersymbol und wählen Sie im Dropdown-Menü Admin aus.
- Wählen Sie dann im Dropdown-Menü Organisationsadministrator aus.
- Wählen Sie auf der Seite Organisationsadministrator Identitäts- und Zugriffsverwaltung > Identitäten > Bereitstellung aus.
- Klicken Sie unter Identitätsanbieter oder API-Berechtigung erstellen auf Identität oder API hinzufügen.
-
Wählen Sie im Dropdown-Menü API-Berechtigung aus.
Die folgenden Anweisungen gelten für eine API-Berechtigung. Informationen zu einem Identitätsanbieter finden Sie unter Benutzer mit SCIM verwalten und bereitstellen.
- Geben Sie die folgenden Informationen für die API-Berechtigung ein:
- Geben Sie unter Client-Name einen Namen ein, der Ihnen hilft, diese Berechtigung zu identifizieren.
- Geben Sie unter Arbeitsbereich den Arbeitsbereich ein, dem diese Berechtigung zugewiesen wird.
-
Geben Sie unter Workiva-Benutzername den Benutzernamen des Benutzers ein, der die Berechtigung für die API benötigt.
Nur dieser Benutzer kann das Secret dieser API-Berechtigung unter Mein Profil > Sicherheit anzeigen.Hinweis: Aus Sicherheitsgründen macht eine Änderung des Workiva-Benutzernamens das aktuelle Secret ungültig, und nur der neue Benutzername hat Zugriff auf das neue Secret.
- Unter Scopes geben Sie die Aktion(en) an, die das System im Namen des Benutzers ausführen kann.
Fügen Sie beispielsweise für die Tabellenkalkulationen-API Tabellenkalkulationen (Lesen) und Tabellenkalkulationen (Schreiben) hinzu, damit der Benutzer auf Tabellenkalkulationen zugreifen und diese bearbeiten kann. - Legen Sie unter Expires fest, wann die Berechtigung ablaufen soll, basierend auf den Sicherheitsrichtlinien und -präferenzen Ihres Unternehmens.
- (Optional) Geben Sie eine durch Komma getrennte Liste von IP-Adressen in die IP-Zulassungsliste für die Berechtigung ein.
- Klicken Sie auf Berechtigung hinzufügen, um den Vorgang abzuschließen.
Verwalten von API-Berechtigungen
Sie können die Details einer bestimmten Berechtigung bearbeiten oder eine löschen, indem Sie auf die entsprechende Aktion in der Dropdown-Liste Aktionen für diese Berechtigung klicken.
Anzeigen der API-Berechtigung
So zeigen Sie das API-Secret an,
- Klicken Sie oben rechts auf das Benutzersymbol und wählen Sie Mein Profil aus der Auswahlliste.
- Klicken Sie auf die Registerkarte Sicherheit.
- Suchen Sie die API-Berechtigung, für die Sie das Secret benötigen.
- Klicken Sie auf Regenerieren in der Dropdown-Liste Aktionen neben der Berechtigung.
Wichtige Hinweise
- Nur der Benutzer, der in den Details der API-Berechtigung angegeben ist, kann das Secret seiner Berechtigung einsehen.
- Sie können das Secret nur einmal einsehen, daher müssen Sie es an einem sicheren Ort aufbewahren.
Wenn Sie das Secret verlieren, müssen Sie das Secret neu generieren und dann alle Stellen, die es benötigen, mit dem neuen Secret versehen. - Tipp: Das Secret beginnt mit "wk_secret:"