Formål
API AD-brugerimport agenten gør det muligt at importere brugere fra et AD på kundens interne netværk til en SaaS-installation af XFlow.
Arkitektur
Agenten installeres på en server hos kunden, der har adgang til AD’et. Installationen sørger for at sætte agenten op som en Windows Service, så den bliver konfigureret korrekt. Agenten fungerer ved at kalde AD'et og hente brugere ud herfra, og derefter aflevere brugerne til XFlow API'et.
Serveren, agenten kører på, skal således have adgang til AD'et via LDAP på port 389 samt mulighed for at lave udgående kald til internettet via HTTPS port 443:
Adgang til AD'et kan gives via brugernavn/password (se afsnittet om konfiguration nedenfor). Hvis man vælger det, så behøver brugeren, der kører agenten, ikke særlige rettigheder til AD'et.
Alternativt kan man sætte brugeren, der afvikler Windows-servicen (agenten), op til at have adgang til AD'et. Så kan man udelade at angive brugernavn/password i nedenstående konfiguration.
Udover ovenstående har brugeren, der afvikler Windows-servicen (agenten), ikke brug for yderligere rettigheder eller adgange.
Konfiguration
Konfigurationerne til agenten kommer fra samme sted i XFlow, som den integrerede brugerimport henter konfigurationer fra:
Via LDAP kan man således sætte op, hvor i AD'et brugere skal hentes fra. Se Opsætning af brugerimport fra Active Directory for detaljer. Agenten trækker på disse felter i AD'et.
Obligatoriske felter: En bruger skal have data i disse felter i AD'et for at importen fungerer:
Email
GivenName
SurName
SamAccountName
MemberOf
ObjectSid
Valgfri felter: Der hentes kun data fra disse felter, hvis der er angivet værdier for de tilsvarende feltnavne i konfigurationen vist ovenfor:
CustomCprField
CustomDataProperty1
CustomDataProperty2
CustomDataProperty3
Agenten kører automatisk en brugerimport hver nat.
Import
Når agenten kører en import, læser agenten data fra AD'et og sender det over til XFlows' Public API. Her tjekkes brugerdata for, om de er valide. Brugere oprettes, opdateres eller inaktiveres alt efter om de findes i forvejen eller ej. Dette foregår på samme måde, som når der køres en integreret brugerimport.
Inde i XFlow er det muligt at overvåge forbindelsen til brugerimport-agenten og finde rapporter fra tidligere imports. Det er desuden muligt at foretage en testimport, som ikke ændrer noget data i XFlow. Her dannes der en rapport, så man kan se hvilke ændringer, der vil ske, næste gang en import kører.
Agenten kører automatisk en import hver nat. Desuden kan man bestille en import efter behov inde fra XFlow.
Siden findes i administrationsdelen under punktet "Organisation > Import > API Brugerimport":
Download af agent
Agenten kan hentes ved at tilgå en bestemt URL-adresse. Før URL-adressen er komplet, mangler der dog nogle få trin, før AD-agenten kan downloades.
https://[installations navn]/AdminApi/BrugerImport/DownloadAgent?brugerImportKonfigurationId=[indsæt id]
URL'en ovenfor mangler XFlow installations- samt ID for brugerimportkonfiguration.
[installations navn]: Er navnet på XFlow-installationen. Som eksempel kan denne hedde "demo.xflow.dk"
[API ID]: ID'et her kan du finde ved at oprette en ny API brugerimport.
Når API-importen er blevet oprettet, kan du åbne debug-konsollen, deaktivere importen og se hvilket ID, der er koblet op mod importen.
Som eksempel kommer URL-adressen til at se således ud:
"https://demo.xflow.dk/AdminApi/BrugerImport/DownloadAgent?brugerImportKo...
Når du tilgår URL-adressen i en browser, vil der blive hentet en .zip-fil ned på din maskine. I mappen kan du se "install.bat" og "setting.json".
JSON-filen henter nogle af de oplysninger, der skal bruges fra konfigurationen af XFlow.
Anbefalinger til overvågning
For at sikre, at integrationen er kørende, er det anbefalet at sætte overvågning op på Windows-servicen. Der skal overvåges, at servicen kører, og at den ikke giver en fejlkode ved kørsel. Dette gøres ved brug af et overvågningsværktøj, som holder øje med den specifikke service, der kører agenten.