API-configuratie: De XML API inschakelen en aangepaste velden configureren
Beheer
API-configuratie
API-configuratie
XML API activeren
U kunt ervoor kiezen de BeyondTrust XML API in te schakelen, waardoor u rapporten kunt maken en opdrachten kunt geven zoals het starten of verplaatsen van sessies vanuit externe toepassingen of om automatisch een back-up van uw softwareconfiguratie te maken.
CLI-client downloaden
Het hulpprogramma voor de opdrachtregelinterface (CLI) kan worden gedownload om API's en automatiseringsscripts gemakkelijker te gebruiken en te configureren, en om ze te integreren met uw BeyondTrust Privileged Remote Access-installatie. Het CLI-hulpprogramma is beschikbaar voor de volgende platformen: Windows (x64), macOS en Linux (x64). Selecteer het relevante platform en klik op BTAPI CLI-client downloaden.
De download bestaat uit een gecomprimeerd uitvoerbaar bestand. Pak het bestand uit en sla het op of verwijs ernaar vanuit een uitvoerbaar gedeelte (in uw PAD).
- Voor Windows-systemen: Open het bestand in een terminal, zoals Windows Opdrachtprompt of Windows PowerShell.
- Voor macOS-systemen: Voer het bestand uit in de terminal.
De help-informatie, met daarin opties, opdrachten en instructies voor variabelen, wordt weergegeven wanneer het programma wordt geopend.
Meer informatie over het maken van API's met behulp van CLI vindt u in de voorbeelden van gebruikersscenario's in de API-handleiding voor BeyondTrust Privileged Remote Access .
API-accounts
In een API-account worden alle instellingen voor verificatie en autorisatie voor de API-client opgeslagen. Om de API te gebruiken is ten minste één API-account vereist, ofwel in samenhang met de integratieclient, met een app van derden of met uw eigen intern ontwikkelde software.
API-account toevoegen, bewerken of verwijderen
Maak een nieuwe account aan, wijzig een bestaande account of verwijder een bestaande account.
API-account toevoegen of bewerken
Ingeschakeld
Als deze optie is ingeschakeld, mag dit account verifiëren met de API. Als een account is uitgeschakeld, worden alle OAuth-tokens die bij het account horen onmiddellijk uitgeschakeld.
Naam
Maak een unieke naam aan om dit account te identificeren.
Opmerkingen
Voeg commentaar toe om aan te geven wat het doel is van dit object.
OAuth-client-ID
De OAuth client-ID is een unieke ID dat door het B Series Appliance wordt gegenereerd. Hij kan niet worden aangepast. De client-ID beschouwen we als openbare informatie en kan daarom worden gedeeld zonder de beveiliging van de integratie te compromitteren.
OAuth-clientgeheim
Het OAuth-clientgeheim wordt gegenereerd door het B Series Appliance met behulp van een veilig versleutelde pseudo-willekeurige nummergenerator.
Het clientgeheim kan niet worden aangepast, maar het kan wel opnieuw worden gegenereerd op de pagina Bewerken. Als een clientgeheim opnieuw wordt genereerd en als vervolgens de account wordt opgeslagen, worden alle OAuth-tokens die bij de account horen direct ongeldig. Alle API-oproepen met die tokens kunnen geen toegang tot de API verkrijgen.
De client-ID voor OAuth en het clientgeheim worden gebruikt om OAuth-tokens te maken. Deze zijn nodig voor het verifiëren bij de API.
Raadpleeg de Handleiding voor API's voor meer informatie.
Machtigingen
Selecteer de gebieden van de API die deze account mag gebruiken. U kunt voor de Opdracht API toegang weigeren, alleen lezen toestaan of volledige toegang geven. Stel ook in of dit account de Rapportage-API, de Back-up-API, de Configuratie-API en/of de API voor Endpoint Credential Manager kan gebruiken.
Met de Configuratie-API kunt u veelvoorkomende taken voor het beheer en configuratie uitvoeren in /login, die geautomatiseerd kunnen worden en gekoppeld kunnen worden aan uw configuratieprocessen.
Met de SCIM-API is het mogelijk om gebruikers van een andere beveiligingsprovider te provisioneren. Als u toegang tot de SCIM-API toestaat, wordt de optie Dragertokens met lange levensduur toestaan beschikbaar. Het wordt niet aanbevolen om dragertokens met lange levensduur toe te staan tenzij dit vereist wordt door uw SCIM-cliënt, omdat deze dragertokens nooit verlopen. Omdat voor alle overige API-machtigingen tokens vereist zijn met een levensduur van één uur, worden door het toestaan van dragertokens met lange levensduur alle overige API-machtigingen uitgeschakeld.
Ga voor meer informatie naar Vault Account Configuratie-API's.
Netwerkbeperkingen
Lijst met voorvoegsels van netwerkadressen waarvandaan deze account kan worden geverifieerd.
API-accounts zijn niet beperkt door de netwerkadresvoorvoegsels op de pagina /login > Beheer > Beveiliging. Ze worden alleen beperkt door de netwerkadresvoorvoegsels die zijn geconfigureerd voor de API-account.
ECM-groepen
Deze functie is alleen beschikbaar als de functie is ingeschakeld toen uw site werd gebouwd. Neem contact op met uw sitebeheerder als de functie niet beschikbaar is.
De functie ECM-groepen biedt ondersteuning voor meerdere referentieproviders die niet verbonden zijn. Met deze functie kan één PRA worden gebruikt om meerdere externe referentieproviders zoals Password Safe of Privileged Identity te integreren. Deze kunnen op verschillende externe locaties gevonden worden via meerdere ECM-exemplaren.
Nieuwe ECM-groepsnaam
Maak een unieke naam aan om deze ECM-groep te identificeren. U kunt maximaal vijftig ECM-groepen configureren.
