Dieser Artikel richtet sich an:
- Sicherheitsadministratoren der Organisation
- Arbeitsbereichadministratoren der Organisation
- Arbeitsbereichsbesitzer
Für den Zugriff auf die Workiva-APIs benötigen Benutzer*innen eine API-Berechtigung zur Autorisierung. Nachdem Sie eine API-Berechtigung für einen Benutzer erstellt haben, 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:
- Gehen Sie in den Arbeitsbereich-Einstellungen auf die Registerkarte Sicherheit und wählen Sie API-Gewährung erstellen.
- 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 Geheimnis ungültig und nur noch der neue Benutzer hat Zugriff auf das neue Geheimnis.
-
Unter Geltungsbereiche geben Sie die Aktion(en) an, die das System im Namen des Benutzers durchführen kann.
Hinweis: Um mehr über Bereiche zu erfahren, lesen Sie bitte unsere Diskussion API-Berechtigungsbereiche verstehen.
Informationen zur Zuweisung von Organisationsbereichen (organization:read oder organization:write) finden Sie unter Erstellen und Verwalten von API-Zuweisungen in der Organisationsverwaltung. - 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:"