Dieser Artikel richtet sich an:
- Sicherheitsadministratoren der Organisation
Erstellen einer API-Gewährung
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.
So beginnen Sie die Erstellung einer API-Gewährung:
- Klicken Sie oben rechts auf das Benutzersymbol und wählen Sie Admin aus der Dropdown-Liste.
- Wählen Sie dann Organization admin aus dem Dropdown-Menü.
- Wählen Sie auf der Seite Organization Admin im linken Menübereich Security und dann die Registerkarte Provisioning.
- Unter Identitätsanbieter oder API-Berechtigung erstellen, klicken Sie auf Identität oder API hinzufügen.
-
Wählen Sie API Grant in der Dropdown-Liste.
Die folgenden Anweisungen beziehen sich auf eine API-Erteilung. Informationen zu einem Identity Provider finden Sie unter Verwalten und Bereitstellen von Benutzern mit SCIM.
- Geben Sie die folgenden Informationen für die API-Gewährung ein:
- Geben Sie unter Client Name einen Namen ein, mit dem Sie diese Förderung identifizieren können.
- Geben Sie unter Arbeitsbereich den Arbeitsbereich ein, dem dieser Grant zugewiesen wird.
-
Geben Sie unter Workiva Username den 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 > Sicherheit einsehen.Hinweis: Aus Sicherheitsgründen wird durch die Änderung des Workiva-Benutzernamens das aktuelle Geheimnis ungültig, und nur der neue Benutzername hat Zugang zum neuen Geheimnis.
- Unter Scopes geben Sie die Aktion(en) an, die das System im Namen des Benutzers ausführen kann.
Fügen Sie z. B. für die Tabellenkalkulations-API Spreadsheets (Read) und Spreadsheets (Write) hinzu, damit der Benutzer auf Tabellenkalkulationen zugreifen und diese bearbeiten kann. - Legen Sie unter Expires fest, wann der Grant 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 den Grant ein.
- Klicken Sie zum Abschluss auf Grant hinzufügen.
Verwalten von API-Gewährungen
Sie können die Details eines bestimmten Grant bearbeiten oder einen Grant löschen, indem Sie auf die entsprechende Aktion in der Dropdown-Liste Aktionen für diesen Grant klicken.
Anzeigen der API-Gewährung
So zeigen Sie das API-Geheimnis 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 den API Grant, für den Sie das Geheimnis benötigen.
- Klicken Sie auf Regenerieren in der Dropdown-Liste Aktionen neben dem Grant.
Wichtige Hinweise
- Nur der Benutzer, der in den Details der API-Grant angegeben ist, kann das Geheimnis seiner Grant einsehen.
- Sie können das Geheimnis nur einmal einsehen, daher müssen Sie es an einem sicheren Ort aufbewahren.
Wenn Sie das Geheimnis verlieren, müssen Sie das Geheimnis neu generieren und dann alle Stellen, die es benötigen, mit dem neuen Geheimnis versehen. - Tipp: Das Geheimnis beginnt mit "wk_secret:"