Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beskrivning

Hämtar ut data från ActiveDirectory (AD) i olika domäner inkluderar personers PersonId från Metakatalogen om det finns.

Finns möjlighet att söka generellt i AD, få ut medlemmar i en grupp och få PersonId från AD Guid. Används domän="default" sätts domän till "Personal"

Livscykelstatus

Under utveckling

Lösningsbeskrivning

Gliffy
nameactiveDirectory-api
pagePin1

Hantering av personuppgifter

Uppgifter så som namn, adress, telefonnummer och e-post hanteras av API:et då det är nödvändigt för att arbetsgivaren ska kunna jobba med bland annat löneärenden, HR-ärenden eller andra ärenden mellan arbetsgivare och arbetstagare. Data används även för access till olika system som används inom organisationen.  

API specifikation

Sök i Active Directory

Exempelanrop:

GET

/api/1.0/activedirectory/search/{domain}

Anropet behöver ha "domän" och "objectName" för att ge resultat. objectClass är default "all"

/api/1.0/activedirectory/search/{domain}?objectName={objectName}&objectClass={objectClass}

Parametrar:

Parameter

Förklaring

Domain

Domän i AD som sökningen ska ske i

Används domän="default" sätts domän till "Personal"

objectName

Namn på sökobjektet

objectClass

Typ av objekt som ska sökas efter, Skickas inget in så är det default "All"
Tillgängliga värden är: organizationalUnit, container, group, user, computer, all


Exempel på parametrar:

Url

Resultat

/api/1.0/activedirectory/search/Personal?objectName=xlucrun&objectClass=user

Hämtar information om användaren xlucrun

Hämta användare i grupp

Exempelanrop:
GET

/api/1.0/activedirectory/groupmembers/{domain}/{group}

Hämtar användare i angiven domän och grupp. Går att söka med både Guid och namn

Parametrar:

Parameter

Förklaring

domain

AD Domän för gruppen

Används domän="default" sätts domän till "Personal"

group

Gruppens namn eller Guid 


Exempel på parametrar:

Filter (?filter=…)

Resultat

activedirectory/groupmembers/personal/SG_Appl_KID

Visare information om varje medlem i gruppen SG_Appl_KID


Open api
operationsSorteralpha
showCommonExtensionstrue
maxDisplayedTags100
deepLinkingtrue
supportedSubmitMethodsnone
locationurl
showExtensionstrue
urlhttps://api-test.sundsvall.se/activedirectory/1.0/api-docs



Säkerhetsklassning

Säkerhetsklass 2

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

https://confluence.sundsvall.se/display/META

För tekniska frågor:
teamevolution@sundsvall.se

Länkar

<Länkar till dev-portal;

  • Test

  • Produktion>

FAQ

<FAQ>