Concept: Peakon SCIM 2.0 API
De API van Peakon automatiseert het in- en uitschrijven van medewerkers, zodat deelname aan Peakon-enquêtes wordt afgestemd op systemen die het SCIM 2.0-protocol ondersteunen, zoals Microsoft Azure Active Directory, Okta en OneLogin. Met deze methode kunnen meerdere systemen werknemersgegevens bijwerken en synchroniseren.
Over SCIM 2.0
System for Cross-domain Identity Management (SCIM) 2.0 specificeert een gestandaardiseerd REST-protocol voor unidirectionele provisioning van gebruikers via HTTP. U kunt uw bestaande identiteitsbeheersysteem zo configureren dat wijzigingen in de database automatisch worden gesynchroniseerd met een externe applicatie zoals Peakon. In het SCIM-protocol wordt het centrale identiteitsbeheersysteem de "identiteitsprovider" genoemd en de externe applicatie een "serviceprovider". Door Peakon te configureren als een serviceprovider met uw bestaande identiteitsbeheersysteem, kan uw organisatie optimaal profiteren van automatische accountinrichting.
Voor instructies over hoe u dit instelt, bezoek Werknemersvoorzieningen instellen met SCIM 2.0.
Ondersteunde operaties
Peakon SCIM 2.0 API ondersteunt de volgende bewerkingen:
- Gebruikers aanmaken
- Gebruikers bijwerken
- Gebruikers verwijderen
- Gebruikers activeren/deactiveren
- Bulkbewerkingen voor gebruikers
Enterprise Schema-extensie
Peakon ondersteunt de volgende basiskenmerken in de Enterprise-gebruikersschema-uitbreiding, zoals gedefinieerd in de SCIM 2.0-specificatie:
- werknemernummer
- Afdeling
- Manager
Het schema voor uw bedrijf bevat het Enterprise-gebruikersschema van uw bedrijf en Peakon-schema-uitbreidingen. Als u de schema's wilt ophalen die voor uw bedrijf worden ondersteund, inclusief beschikbare velden, roept u het eindpunt
Schema's ophalen
aan.Peakon Schema Extension
Naast de basisvelden biedt Peakon een aangepaste schema-uitbreiding waarmee veldgegevens voor aangepaste kenmerken (bijv.
Manager
, Geboortedatum
, Afdeling
, enz.) kunnen worden toegevoegd. De opmaak van deze extensie volgt de opmaak die is gespecificeerd in de SCIM 2.0-specificatie. Het waardetype van de aangepaste kenmerken is afhankelijk van het type kenmerk:
Attribuuttype | Waardetype |
|---|---|
Attributen van het optie type. Voorbeeld: Afdeling . | Een tekenreekswaarde (maximaal 256 tekens). |
Kenmerken van het datumtype. Voorbeeld: Geboortedatum . | Een DateTime- reeks (ISO 8601-indeling). |
Attributen van het type nummer. Voorbeeld: Salaris . | Een geheel getal. |
Attribuut type werknemer. Voorbeeld: Manager . | Een tekenreekswaarde die het e-mailadres van de gerefereerde werknemer bevat. Omdat werknemerstypekenmerken naar andere werknemers in het systeem verwijzen, moet de betreffende werknemer vooraf in het systeem bestaan. U kunt dit doen met een tweestapsinrichting, waarbij u in de eerste stap alleen basisvelden opneemt en in de tweede stap uitgebreide velden. Aangepaste kenmerken worden geleverd als een subobject van de belangrijkste resourcevelden. Voorbeeld:
Als u de schema's wilt ophalen die voor uw bedrijf worden ondersteund, inclusief beschikbare velden, roept u het eindpunt Schema's ophalen aan. |
Payload
Bezoek Referentie: Peakon SCIM 2.0 API Payload voor meer informatie.
Snelheidsbeperking
De Peakon SCIM API heeft een capaciteitslimiet van 25.000 bewerkingen/uur. Een bulk SCIM API-aanvraag verbruikt 1 bewerking per bewerking in de aanvraagpayload. Andere SCIM API-aanvragen verbruiken 1 bewerking. Elke integratie moet de API-aanroepen beperken om ervoor te zorgen dat deze limiet niet wordt overschreden.