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 Geheimnis ihrer Gewährung einsehen, indem sie die Gewährung in ihrem Benutzerprofil neu generiert.
Erstellen einer API-Gewährung
So beginnen Sie die Erstellung einer API-Gewährung:
- Klicken Sie oben rechts auf das Benutzersymbol und wählen Sie Organisationsadministrator aus der Dropdown-Liste Administrator.
- Wählen Sie Sicherheit und klicken Sie auf die Registerkarte Bereitstellung.
- Klicken Sie auf Identität hinzufügen oder API.
- Wählen Sie API-Gewährung in der Dropdown-Liste.
- Geben Sie die folgenden Informationen für die API-Gewährung ein:
- Geben Sie unter Client-Name einen Namen ein, anhand dessen Sie diese Gewährung identifizieren können.
- Geben Sie unter Arbeitsbereich den Arbeitsbereich ein, dem diese Gewährung zugeordnet werden soll.
- Geben Sie unter Workiva-Benutzername den Benutzernamen des Benutzers ein, der die Gewährung für die API benötigt. Nur diese Benutzer können das Secret dieser API-Zuweisung unter Mein Profil > Sicherheit einsehen.
Hinweis:: Wenn Sie zu einem späteren Zeitpunkt den Workiva-Benutzernamen ändern, wird das aktuelle Secret aus Sicherheitsgründen ungültig, und nur der neue Benutzer hat Zugriff auf das neue Secret.
- Unter Geltungsbereiche geben Sie die Aktion(en) an, die das System im Namen des Benutzers durchführen kann. Fügen Sie z. B. mit der Arbeitsblatt-API Arbeitsblätter (schreibgeschützt) und Arbeitsblätter (Schreibzugriff) hinzu, damit der Benutzer auf Arbeitsblätter zugreifen und diese bearbeiten kann.
- Legen Sie unter Ablauf fest, wann die Berechtigung ablaufen soll, basierend auf den Sicherheitsrichtlinien und Präferenzen Ihrer Organisation.
- Geben Sie bei Bedarf eine durch Kommata getrennte Liste von IP-Adressen in die IP-Zulassungsliste für die Berechtigung ein.
- Klicken Sie zum Abschluss auf Gewährung hinzufügen .
Verwalten von API-Gewährungen
Sie können die Details einer bestimmten Gewährung bearbeiten oder die Gewährung löschen, indem Sie auf die entsprechende Aktion im Dropdown-Menü Aktionen klicken.
Anzeigen der API-Gewährung
Nur der Benutzer, der in den Details der API-Zuweisung angegeben ist, kann das Secret seiner Gewährung einsehen, indem er Mein Profil aufruft, die Registerkarte Sicherheit auswählt und dann auf Regenerieren im Dropdown-Menü Aktionen neben der Gewährung klickt. Die Benutzer*innen können das Secret nur einmal einsehen, also müssen sie es an einen sicheren Ort kopieren. Wenn sie das Secret verlieren, müssen sie es erneut generieren.
Hinweis: Das Secret beginnt mit "wk_secret:"