Workiva-ondersteuningscentrum

Dit artikel is voor:

• Organisatiebeveiligingsbeheerders

Maak een API-toestemming aan

Om toegang te krijgen tot de API's van Workiva, hebben gebruikers een API-toestemming nodig. Als Organisatiebeveiligingsbeheerderkunt u een API-toekenning voor een gebruiker aanmaken, de details van de toekenning bewerken of de toekenning verwijderen. De gebruiker zelf kan echter alleen het geheim van zijn of haar machtiging bekijken door de machtiging opnieuw aan te maken in het gebruikersprofiel.

Om een ​​API-toekenning aan te maken:

1. Klik rechtsboven op het gebruikerspictogram en selecteer Admin in het dropdownmenu.
2. Selecteer vervolgensOrganisatiebeheerderuit het keuzemenu.
   
3. Selecteer op de pagina Organisatiebeheer de optie Beveiligingin het linkermenu en selecteer vervolgens het tabblad Inrichting.
   
4. Onder Een identiteitsprovider maken of API-toekenning, klikt u op Identiteit of API toevoegen.
   

5. Selecteer API Grant in het dropdownmenu.
   

   De volgende instructies hebben betrekking op een API-toekenning. Voor een identiteitsprovider raadpleegt u Gebruikers beheren en provisioneren met SCIM.

6. Voer de volgende gegevens in voor de API-toekenning:
   • Voer in Client Nameeen naam in waarmee u deze subsidie ​​kunt identificeren.
   • Voer in Werkruimtede werkruimte in waaraan deze subsidie ​​zal worden toegewezen.

   • Voer in Workiva Gebruikersnaamde gebruikersnaam in van de gebruiker die de autorisatie voor de API nodig heeft.
     Alleen deze gebruiker kan het geheim van deze API-toekenning bekijken in Mijn profiel > Beveiliging.

     Opmerking: Om veiligheidsredenen maakt het wijzigen van de Workiva-gebruikersnaam het huidige geheim ongeldig, en alleen de nieuwe gebruikersnaam heeft toegang tot het nieuwe geheim.

   • In Scopeskunt u de actie(s) specificeren die het systeem namens de gebruiker kan uitvoeren.
     Voeg bijvoorbeeld voor de Spreadsheets API Spreadsheets (Lezen) en Spreadsheets (Schrijven) toe, zodat de gebruiker spreadsheets kan openen en bewerken.
   • In Expireskunt u instellen wanneer de machtiging moet verlopen, op basis van het beveiligingsbeleid en de voorkeuren van uw organisatie.
   • (Optioneel) Voer een door komma's gescheiden lijst met IP-adressen in voor de IP Allowlist voor de toekenning.
     
7. Klik op Subsidie ​​toevoegen om te voltooien.

API-toekenningen beheren

Je kunt de details van een specifieke subsidie ​​bewerken of een subsidie ​​verwijderen door op de betreffende actie in het dropdownmenu Acties voor die subsidie ​​te klikken.

Bekijk het API-toekenningsgeheim

Om het API-geheim te bekijken,

1. Klik rechtsboven op het gebruikerspictogram en selecteer Mijn profielin het dropdownmenu.
   
2. Klik op het tabblad Beveiliging.
3. Zoek de API-toekenning op waarvoor je het geheim nodig hebt.
4. Klik op Regenerate in het Actions dropdownmenu naast de toekenning.

Belangrijke opmerkingen

• Alleen de gebruiker die in de API-toekenningsdetails is gespecificeerd, kan het geheim van die toekenning bekijken.  
• Je kunt het geheim slechts één keer bekijken, dus je moet het op een veilige plek opschrijven.
  Als je het geheim kwijtraakt, moet je het opnieuw genereren en vervolgens alle plekken waar het nodig is, vullen met het nieuwe geheim.
• Tip: Het geheim begint met "wk_secret:"

Wat volgt? 

• Beheer en configureer gebruikers met SCIM.
• Instellingen voor het bewaren van activiteiten beheren
• API-toegangsrechten aanmaken en beheren in de werkruimte-instellingen.