Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Peakon
Zuletzt aktualisiert: 2025-01-24
Konzept: Peakon SCIM 2.0 API

Konzept: Peakon SCIM 2.0 API

Die API von Peakon automatisiert die Bereitstellung und Aufhebung der Bereitstellung von Mitarbeitern und stellt sicher, dass die Teilnahme an Peakon-Umfragen mit Systemen übereinstimmt, die das SCIM 2.0-Protokoll unterstützen, wie etwa Microsoft Azure Active Directory, Okta und OneLogin. Mit dieser Methode können mehrere Systeme Mitarbeiterdaten aktualisieren und synchronisieren.

Über SCIM 2.0

System for Cross-domain Identity Management (SCIM) 2.0 spezifiziert ein standardisiertes REST-Protokoll für die unidirektionale Bereitstellung von Benutzern über HTTP. Ihr vorhandenes Identitätsmanagementsystem kann so konfiguriert werden, dass Änderungen an seiner Datenbank automatisch mit einer Drittanbieteranwendung wie Peakon synchronisiert werden. Im SCIM-Protokoll wird das zentrale Identitätsverwaltungssystem als „Identitätsanbieter“ und die Drittanbieteranwendung als „Dienstanbieter“ bezeichnet. Durch die Konfiguration von Peakon als Dienstanbieter mit Ihrem vorhandenen Identitätsmanagementsystem kann Ihr Unternehmen alle Vorteile der automatischen Kontobereitstellung nutzen.
Anweisungen zur Einrichtung finden Sie unter Einrichten der Mitarbeiterbereitstellung mit SCIM 2.0.

Unterstützte Vorgänge

Die Peakon SCIM 2.0 API unterstützt diese Vorgänge:
  • Benutzer erstellen
  • Benutzer aktualisieren
  • Benutzer löschen
  • Benutzer aktivieren/deaktivieren
  • Massenvorgänge für Benutzer

Enterprise Schema Extension

Peakon unterstützt die folgenden grundlegenden Attribute in der Enterprise-Benutzerschemaerweiterung, wie in der SCIM 2.0-Spezifikation definiert:
  • employeeNumber
  • Abteilung
  • Manager
Das Schema für Ihr Unternehmen enthält das Enterprise-Benutzerschema Ihres Unternehmens und die Peakon-Schemaerweiterungen. Um die für Ihr Unternehmen unterstützten Schemas einschließlich der verfügbaren Felder abzurufen, rufen Sie den Endpunkt
„Schemas abrufen“
 auf.

Peakon-Schemaerweiterung

Zusätzlich zu den Basisfeldern bietet Peakon eine benutzerdefinierte Schemaerweiterung, um Felddaten für benutzerdefinierte Attribute (z. B.
Manager
,
Geburtsdatum
,
Abteilung
usw.) zu ermöglichen. Das Format dieser Erweiterung folgt dem in der SCIM 2.0-Spezifikation angegebenen Format.
Der Wertetyp der benutzerdefinierten Attribute hängt vom Attributtyp ab:
Attributtyp
Werttyp
Optionstypattribute.
Beispiel:
Abteilung
.
Ein Zeichenfolgenwert (max. 256 Zeichen).
Attribute vom Typ „Datum“.
Beispiel:
Geburtsdatum
.
Eine
DateTime-
 Zeichenfolge (ISO 8601-Format).
Attribute vom Typ „Zahl“.
Beispiel:
Gehalt
.
Ein Integer-Wert.
Attribut „Mitarbeitertyp“.
Beispiel:
Manager
.
Ein Zeichenfolgenwert, der die E-Mail-Adresse des referenzierten Mitarbeiters enthält. Da Mitarbeitertypattribute auf andere Mitarbeiter im System verweisen, muss der referenzierte Mitarbeiter bereits im System vorhanden sein. Dies erreichen Sie durch eine Bereitstellung in zwei Schritten, bei der im ersten Schritt nur die Basisfelder und im zweiten Schritt erweiterte Felder einbezogen werden.
Benutzerdefinierte Attribute werden als Unterobjekt der Hauptressourcenfelder bereitgestellt. Beispiel: 
{
“name” : {
“firstName”: “Jane”,
“lastName”: “Smith”
},
“urn:ietf:params:scim:schemas:extension:peakon:2.0:User”: {
“Business Unit”: “Engineering”,
“Department”: “IT”
}
}
Um die für Ihr Unternehmen unterstützten Schemas einschließlich der verfügbaren Felder abzurufen, rufen Sie den Endpunkt
„Schemas abrufen“
 auf.

Nutzlast

Besuchen Referenz: Peakon SCIM 2.0 API Payload für weitere Informationen.

Ratenbegrenzung

Die Geschwindigkeit der Peakon SCIM-API ist auf 25.000 Vorgänge/Stunde begrenzt. Eine SCIM-API-Massenanforderung verbraucht 1 Vorgang pro Vorgang in der Anforderungsnutzlast. Andere SCIM-API-Anfragen verbrauchen 1 Vorgang. Jede Integration sollte ihre API-Aufrufe drosseln, um sicherzustellen, dass dieses Limit nicht überschritten wird.