Dieser Artikel ist fürbestimmt:
- Org-Sicherheits-Admins
- Org-Arbeitsbereich-Admins
- Eigentümer des Arbeitsbereichs
Für den Zugriff auf die Workiva-APIs benötigen die Nutzer eine API-Autorisierung. Sobald Sie eine API-Zuteilung für einen Benutzer erstellt haben, können Sie die Details der Zuteilung bearbeiten oder die Zuteilung löschen. Allerdings kann nur der Nutzer das Geheimnis seines Grant einsehen, indem er das Grant in seinem Nutzerprofil neu generiert.
Erstellen einer API-Erlaubnis
So beginnen Sie mit der Erstellung eines API-Grants:
- Gehen Sie in den Arbeitsbereichseinstellungen auf die Registerkarte Sicherheit und wählen Sie API-Berechtigung erstellen.
- Geben Sie die folgenden Informationen für die API-Grant ein:
-
- Geben Sie unter Client Nameeinen Namen ein, mit dem Sie diese Förderung identifizieren können.
- Geben Sie unter Arbeitsbereichden Arbeitsbereich ein, dem diese Förderung zugeordnet werden soll.
- Geben Sie unter Workiva Usernameden Benutzernamen des Benutzers ein, der die Berechtigung für die API benötigt. Nur dieser Benutzer kann das Geheimnis dieses API-Grants unter Mein Profil > Sicherheiteinsehen.
Hinweis: Wenn du später den Workiva-Benutzernamenänderst, wird aus Sicherheitsgründen das aktuelle Geheimnis ungültig, und nur der neue Benutzer hat Zugriff auf das neue Geheimnis.
- Unter Scopesgeben Sie die Aktion(en) an, die das System im Namen des Benutzers durchführen kann.
Hinweis: Lesen Sie unsere Understanding API Grant Scopes Diskussion, um mehr über Scopes zu erfahren.
- Legen Sie unter Expiresfest, 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 Allowlist für die Berechtigung ein.
- Klicken Sie zum Abschluss auf Grant hinzufügen .
Verwalten von API-Zuwendungen
Sie können die Details einer bestimmten Förderung bearbeiten oder die Förderung löschen, indem Sie auf die entsprechende Aktion im Dropdown-Menü Aktionen klicken.
API-Gewährungsgeheimnis anzeigen
Nur der Benutzer, der in den Details der API-Zuteilung angegeben ist, kann das Geheimnis seiner Zuteilung einsehen, indem er Mein Profilaufruft, die Registerkarte Sicherheit auswählt und dann im Dropdown-Menü Aktionen neben der Zuteilung auf Neu generieren klickt. Der Benutzer kann das Geheimnis nur einmal einsehen, also muss er es an einem sicheren Ort aufschreiben. Wenn sie das Geheimnis verlieren, müssen sie das Geheimnis erneut generieren.
Hinweis: Das Geheimnis beginnt mit "wk_secret:".