Simployer MIM-AD API

Endret Tue, 11 Mar ved 9:38 AM

Overordnet beskrivelse

Dokumentet beskriver API for bruk inn mot MIM eller On Prem AD for de av våre kunder som ønsker å hente ut ansattdata og skrive tilbake UPN og epost

MIM Integrasjon

MIM er en løsning som kun tilbyr tidsstyrte jobber og vil aksessere et API-endepunkt til faste tider. API-ene er ellers alltid tilgjengelig for spørringer eller oppdateringer.

Forslaget til løsning er at vi setter opp et API, hvor MIM eller andre integrasjonsjobber, kan lese persondata og oppdatere epost. API vil bestå av 2 metoder ExportMIMData og ImportMIMData. En driftsleverandør vil ofte foretrekke å hente ut alle ansatte ved hvert kall. Det er ikke behov eller funksjonalitet for å overføre hele organisasjonsstrukturen.

Mapping MIM – AD - Simployer

AD Name	Simployer Felt
company	Ansatt i
department	Tilhørighet på person
employeeID	Ansattnummer
employeeType	Personalkategori
givenName	Fornavn
l	Postnummer på avdeling
manager	Nærmeste leder
mobile	Mobil
physicalDeliveryOfficeName	Navn på avdeling
postOfficeBox	Adr.linje 2 på avdeling
postalCode	Postnummer på avdeling
roomNumber	Felt eksisterer ikke i størrelse og verdi, men det kan opprettes en “Størrelse og verdi” i Simployer.
streetAddress	Adr.linje 1 på avdeling
sn	Etternavn
telephoneNumber	Mobil
title	Stillingsbenevnelse
preferredLanguage	Språk
	Startdato
Expire date	Sluttdato
	Template, malbruker definert som gruppe
email	Epost
UPN	Eksternid
	CustomField1
	CustomField2
	CustomField3

API

ExportMIMData

URL: https://simployermim.azure-api.net/MIMFunctions/ExportMIMData

Method: GET

Authentication

«Basic auth»-authentication with username and password.

Headers

Nøkkel	Eksempel verdi	Beskrivelse
X-ITAS-FromUnitId	3	Unit
X-ITAS-UnitIdType	InternalId	Type identifikator: DepartmentCode or InternalId
X-ITAS-IncludeSV	Kategori:customAttribute1\|SalaryType:customAttribute2	S&V:customAttributeX\| S&V:customAttributeY
x-ITAS-PublicCustomerId		Public customer id
x-ITAS-ApiKey		API key
Ocp-Apim-Subscription-Key		Abonnementsnøkkel
Content-Type	application/json

Example response body

JSon-array with person data:

[

    {

        "company": "Selskap AS",

        "department": "100",

        "employeeID": "55555555-5555-5555-5555-555555555555",

        "employeeNumber": "25",

        "employeetype": "Fast ansatt",

        "givenName": "Kari",

        "location": "1635",

        "manager": "Ola Hansen",

        "mobile": "98989898",

        "office": "Sarpsborg",

        "postOfficeBox": "PB 243",

        "postalCode": "1635",

        "roomNumber": "Etg. 2",

        "state": null,

        "streetAddress": "Kongens gate 2",

        "surname": "Hansen",

        "telephone": "98989898",

        "title": "Lærling",

        "countryCode": "NO",

        "preferredLanuage": null,

        "hireDate": "23.01.2018",

        "expireDate": "",

        "template": "Standard"

        "email": "kari@simployer.com",

        "adName": "kari@simployer.com",

        "customAttribute1": null,

        "customAttribute2": null,

        "customAttribute3": null

    }

]

ImportMIMData

URL: https://simployermim.azure-api.net/MIMFunctions/ImportMIMData

Method: POST

Autentifisering

«Basic auth»-authentification with user name and password.

Headers

Nøkkel	Eksempel vedi	Beskrivelse
Ocp-Apim-Subscription-Key		Subscription key
Content-Type	application/json
X-ITAS-UpdateUserName	False	Set to true the user name will be updated with adName

Body

JSon-array med MIM import data.

[

    {

        "employeeID": "55555555-5555-5555-5555-555555555555",

        "adName": "kari@simployer.com",

        "mail": "kari@simployer.com"

    }

]

Field description

Felt	Rammer	Påkrevd (Ja/Nei)	Kommentar
employeeID		Ja	GUID
adName	Maks 100 tegn	Ja
mail	Maks 50 tegn	Ja

Tilpasninger Simployer

ExportMIMData-metoden vil gi et uttrekk fra Simployer av personer med stillingsinformasjon. Det mest naturlige i Simployer er å benytte adresse på enhetsnivå som lokasjon i overføring til driftsleverandør eller AD. Det vil si at organisasjonsstrukturen i Simployer må oppdateres med adresseinformasjon. Det vil da være poststed som representerer lokasjonen. Lokasjon er informasjon som kan være benyttet til å styre oppsett mot lokale printere etc.

For å predefinere et sett med tilganger benytter noen driftsleverandører malbrukere. Forslag til løsning i Simployer er å opprette grupper som hver representerer en malbruker. Disse kan igjen knyttes direkte til person og / eller til stilling. Det vil være brukere som trenger crossfunksjonalitet, for dette må det opprettes egne maler.

Preferred language benyttes for å sette default språk på bruker. I Simployer vil dette være feltet språk under kontoinformasjon.

Funksjonalitet for å aktivere / deaktivere personer kan styres ved å bruke feltene for Start og sluttdato. I AD finnes en expire date som kan mappes til sluttdato i Simployer.

Forutsetninger

Eksport trekker ut personer basert på ansattnummer

Adresse må være lagt inn i organisasjon på enhetsnivå