Overview
This document describes the API for use with MIM or On-Premises Active Directory for customers who want to extract employee data and write back UPN and email.
MIM Integration
MIM is a solution that only offers scheduled jobs and will access an API endpoint at fixed times. The APIs are otherwise always available for queries or updates.
The proposed solution is to set up an API where MIM or other integration jobs can read personal data and update email addresses. The API will consist of two methods: ExportMIMData and ImportMIMData. A service provider will often prefer to extract all employees on each call. There is no need or functionality to transfer the entire organizational structure.
Mapping MIM – AD – Simployer
AD Name | Simployer Field |
company | Employee in (Ansatt i) |
department | Affiliation (Tilhørighet) |
employeeID | Employee number (Ansattnummer) |
employeeType | Personnel category |
givenName | First name (Fornavn) |
l | Postal code on department |
manager | Immediate manager (Nærmeste leder) |
mobile | Mobile |
physicalDeliveryOfficeName | Department name (Navn på avdeling) |
postOfficeBox | Address line 2 (Adr.linje 2) on department |
postalCode | Postal code on department |
roomNumber | Field does not exist in size and value, but a “Size and Value” can be created in Simployer |
streetAddress | Address line 1 (Adr.linje 1) on department |
sn | Last name (Etternavn) |
telephoneNumber | Mobile |
title | Job title (Stillingsbenevnelse) |
preferredLanguage | Language (Språk) |
Start date |
|
Expire date | End date (Sluttdato) |
Template | Template, template user defined as group |
UPN | External ID |
CustomField1 |
|
CustomField2 |
|
CustomField3 |
|
API
ExportMIMData
URL: https://simployermim.azure-api.net/MIMFunctions/ExportMIMData
Method: GET
Authentication
Basic auth with username and password.
Headers
Key | Example value | Description |
X-ITAS-FromUnitId | 3 | Unit |
X-ITAS-UnitIdType | InternalId | Identifier type: DepartmentCode or InternalId |
X-ITAS-IncludeSV | Category:customAttribute1 | SalaryType:customAttribute2 |
x-ITAS-PublicCustomerId |
| Public customer id |
x-ITAS-ApiKey |
| API key |
Ocp-Apim-Subscription-Key |
| Subscription key |
Content-Type | application/json |
|
Example response body
JSON array with person data:
json
CopyEdit
[ { "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", "preferredLanguage": null, "hireDate": "23.01.2018", "expireDate": "", "template": "Standard", "email": "[email protected]", "adName": "[email protected]", "customAttribute1": null, "customAttribute2": null, "customAttribute3": null } ]
ImportMIMData
URL: https://simployermim.azure-api.net/MIMFunctions/ImportMIMData
Method: POST
Authentication
Basic auth with username and password.
Headers
Key | Example value | Description |
Ocp-Apim-Subscription-Key |
| Subscription key |
Content-Type | application/json |
|
X-ITAS-UpdateUserName | False | Set to true to update user name with adName |
Body
JSON array with MIM import data:
json
CopyEdit
[ { "employeeID": "55555555-5555-5555-5555-555555555555", "adName": "[email protected]", "mail": "[email protected]" } ]
Field description
Field | Max Length / Format | Required | Comment |
employeeID | GUID | Yes |
|
adName | Max 100 characters | Yes |
|
Max 50 characters | Yes |
|
Simployer Customizations
The ExportMIMData method provides an export from Simployer of persons with job information. The most natural location in Simployer is to use the address at the unit level as the location when transferring to the service provider or AD. This means the organizational structure in Simployer must be updated with address information. The postal place represents the location. Location information can be used to control setups such as local printers.
Some service providers use template users to predefine a set of accesses. The suggested solution in Simployer is to create groups representing these template users. These groups can be linked directly to a person and/or to a job position. Some users will require cross-functional access, which will require separate templates.
Preferred language is used to set the default language for the user. In Simployer, this is the language field under account information.
Functionality to activate/deactivate persons can be controlled using the start and end date fields. In AD, there is an expire date which can be mapped to the end date in Simployer.
Prerequisites
Export extracts persons based on employee number
Address must be entered in the organization at the unit level
To read more about Simployer API klick here