Kurzübersicht

WalkMe SCIM Service Provider ermöglicht es Ihnen, Benutzer und Gruppen programmatisch mit einem SCIM 2.0-kompatiblen Endpunkt zu verwalten. WalkMe stellt eine REST-API bereit, die auf der Spezifikation des Systems für das domänenübergreifende Identitätsmanagement (SCIM 2.0) basiert.

Diese API ermöglicht es Ihnen, die folgenden Dinge zu tun:

• Benutzer und Gruppen erstellen, lesen, aktualisieren, patchen und löschen.
• Suche nach Benutzern und Gruppen mit Filterung und Paginierung.
• Informationen über den WalkMe-Dienstanbieter, die verfügbaren Schemata und die Ressourcentypen

Voraussetzungen

• Sie müssen ein WalkMe-Konto haben
• Sie müssen die SCIM-Integration im WalkMe Admin Center erstellen und Anmeldeinformationen generieren.

SCIM-Integration einrichten

SCIM in WalkMe aktivieren

Bevor Sie SCIM aktivieren, müssen Sie zuerst eine SCIM-Integration im WalkMe Admin Center erstellen.

1. Melden Sie sich im WalkMe Admin Center an.

2. Gehen Sie zur SCIM-Integrationsseite

3. SCIM-Integration auswählen

   1. Sie können auch direkt navigieren über:

      1. USA: https://admin-us01.walkme.cloud.sap/scim

      2. EU: https://admin-eu01.walkme.cloud.sap/scim

4. Wählen Sie + SCIM-Integration erstellen aus.

5. Im Bereich SCIM-Integration erstellen:

   1. Geben Sie den Integrationsnamen ein, um Ihre Integration zu identifizieren (z. B. „Produktion“ oder „Staging“)

   2. Wählen Sie den Autorisierungstyp aus

      1. Grundlegende Authentifizierung: Verwendet einen Benutzernamen und ein Passwort für die Authentifizierung

      2. Bearer Token: Verwendet ein Bearer Token für die Authentifizierung

6. Wählen Sie Anmeldeinformationen generieren aus

1. Wenn Sie Grundlegende Authentifizierung ausgewählt haben, wird ein Popup-Fenster geöffnet, das die für diese Integration generierten SCIM-Anmeldeinformationen anzeigt:

   1. SCIM-Basis-URL: Die Endpunkt-URL für die SCIM-Konfiguration Ihres Identitätsanbieters

   2. Benutzername: Der automatisch generierte Benutzername für die Authentifizierung

   3. Passwort: Das automatisch generierte Passwort für die Authentifizierung

2. Wählen Sie Fertig aus, um die Einrichtung der SCIM-Integration in WalkMe abzuschließen

1. Wenn Sie Bearer-Token ausgewählt haben, wird ein Popup-Fenster geöffnet, das die für diese Integration generierten SCIM-Anmeldeinformationen anzeigt:

   1. SCIM-Basis-URL: Die Endpunkt-URL für die SCIM-Konfiguration Ihres Identitätsanbieters

   2. Bearer-Token: Das sichere Token, das für die Authentifizierung verwendet wird

2. Wählen Sie Fertig aus, um die Einrichtung der SCIM-Integration in WalkMe abzuschließen

SCIM 2.0 API-Endpunkte und Parameter

Diese API verwendet SCIM 2.0. Weitere Informationen finden Sie unter SCIM-Kernschema (RFC 7643)

Basis-URLs

• USA: https://papi-us01.walkme.cloud.sap/deepui/api/scim/v2

• EU: https://papi-eu01.walkme.cloud.sap/deepui/api/scim/v2

Authentifizierung

Alle Anfragen erfordern entweder die HTTP-Basisauthentifizierung oder die Authentifizierung mit einem Träger-Token:

• Grundlegende Authentifizierung:

  • Autorisierung: Basic <base64 (Benutzername:Passwort)>

• Träger-Token:

  • Authorization: Bearer <generiertes Bearer Token>

Benutzerverwaltung

Endpunkte

• /Benutzer: Einen Benutzer erstellen (POST) oder eine Liste der Benutzer abrufen (GET)

• /Benutzer/{id}: Einen Benutzer abrufen (GET), aktualisieren (PUT), patchen (PATCH) oder löschen (DELETE)

GET /Benutzer

Ruft eine Liste der Benutzer mit optionaler Filterung und Paginierung ab

URL-Parameter:

• startIndex: 1-basierter Index des ersten zurückkehrenden Benutzers. Der Standardwert ist 1. (Optional)

• count: (Optional) Anzahl der Benutzer, die pro Seite zurückgegeben werden (maximal 1000). Der Standardwert ist 1000. (Optional)

• Filter: SCIM-Filterausdruck (Optional)

  • Unterstützte Operatoren: eq, ne, co, sw, ew, gt, ge, lt, le, pr

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
 "totalResults": 1,
 "itemsPerPage": 1000,
 "startIndex": 1,
 "Ressourcen": [
 {
 "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "userName": "john.doe@example.com",
 "name": {
 "formatted": "John Doe",
 "familyName": "Doe",
 "givenName": "John"
 },
 "displayName": "John Doe",
 "active": true,
 "emails": [
 {
 "value": "john.doe@example.com",
 "type": "work",
 "primär": true
 }
 ],
 "groups": [],
 "schemas": [
 "urn:ietf:params:scim:schemas:core:2.0:User",
 "urn:ietf:params:scim:schemas:extension:sap:2.0:User"
 ],
 "urn:ietf:params:scim:schemas:extension:sap:2.0:User": {
 "userUuid": "b2c3d4e5-f6a7-8901-bcde-f23456789012"
 },
 "meta": {
 "resourceType": "User",
 "location": "/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "created": "2025-12-02T11:30:23Z",
 "lastModified": "2025-12-02T11:30:23Z",
 "version": "1.0"
 }
 }
 ]
}

Antwortcodes:

• 200 OK: Erfolg

• 400 Bad Request: Ungültige Anfrage oder Filter

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 403 Verboten: Zugriff verweigert

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

POST /Benutzer

Erstellt einen neuen Benutzer.

Erforderliche Attribute:

• userName: Muss eindeutig sein (Groß- und Kleinschreibung ignorieren)
• E-Mails: Muss mindestens eine E-Mail mit Primär: true enthalten.

Automatisch generierte Attribute:

• id: Systemgenerierte UUID
• urn:ietf:params:scim:schemas:extension:sap:2.0:User.userUuid: Automatisch generiert, wenn nicht angegeben

{
 "schemas": [
 "urn:ietf:params:scim:schemas:core:2.0:User",
 "urn:ietf:params:scim:schemas:extension:sap:2.0:User"
 ],
 "userName": "john.doe@example.com",
 "name": {
 "formatted": "John Doe",
 "familyName": "Doe",
 "givenName": "John"
 },
 "displayName": "John Doe",
 "emails": [
 {
 "value": "john.doe@example.com",
 "type": "work",
 "primär": true
 }
 ],
 "active": true
}

Antwortcodes:

• 201 Erstellt: Benutzer erfolgreich erstellt

• 400 Fehlerhafte Anfrage: Fehlende erforderliche Attribute oder ungültige Werte

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 409 Konflikt: userName existiert bereits

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

GET /Benutzer/{id}

Ruft einen bestimmten Benutzer anhand seiner ID (UUID) ab.

Pfadparameter:

• id: Benutzer-UUID (nicht userName)

Antwortcodes:

• 200 OK: Erfolg
• 401 Nicht autorisiert: Ungültige Anmeldeinformationen
• 404 Nicht gefunden: Der Benutzer existiert nicht
• 429 Zu viele Anfragen: Ratengrenze überschritten
• 500 Interner Serverfehler

PUT /Benutzer/{id}

Ersetzt alle Benutzerattribute. ReadOnly-Attribute bleiben erhalten und können nicht geändert werden.

Pfadparameter:

id: Benutzer-UUID (nicht userName)

Antwortcodes:

• 200 OK: Benutzer erfolgreich aktualisiert

• 400 Bad Request: Ungültige Anfrage

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Der Benutzer existiert nicht

• 409 Konflikt: userName-Konflikt

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

PATCH /Benutzer/{id}

Pfadparameter:

• id: Benutzer-UUID (nicht userName)

Unterstützte Vorgänge:

• Hinzufügen, ersetzen, entfernen

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
 "Operations": [
 {
 "op": "replace",
 "path": "active",
 "value": false
 },
 {
 "op": "add",
 "path": "emails",
 "value": [
 {
 "value": "secondary@example.com",
 "type": "home"
 }
 ]
 }
 ]
}

Antwortcodes:

• 200 OK: Benutzer erfolgreich aktualisiert

• 400 Fehlerhafte Anfrage: Ungültiger Vorgang oder Pfad

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Der Benutzer existiert nicht

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

DELETE /Benutzer{id}

Löscht einen Benutzer.

Pfadparameter:

• id: Benutzer-UUID (nicht userName)

Antwortcodes:

• 204 Kein Inhalt: Benutzer erfolgreich gelöscht

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Der Benutzer existiert nicht

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

Gruppenverwaltung

Endpunkte

• /Gruppen: Eine Gruppe erstellen (POST) oder eine Liste der Gruppen abrufen (GET)

• /Groups/{id}: Eine Gruppe abrufen (GET), aktualisieren (PUT), patchen (PATCH) oder löschen (DELETE)

GET /Gruppen

Ruft eine Liste der Gruppen mit optionaler Filterung und Paginierung ab.

URL-Parameter:

• startIndex:1-basierter Index der ersten zurückzugebenden Gruppe. Der Standardwert ist 1. (Optional)

• Anzahl: Anzahl der Gruppen, die pro Seite zurückgegeben werden sollen (maximal 1000). Der Standardwert ist 1000. (Optional)

• Filter: SCIM-Filterausdruck, der zur Suche nach bestimmten Gruppen verwendet wird. Standardwert ist keine. (Optional)

GET /Groups?filter=displayName sw "Sales"&count=50

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
 "totalResults": 1,
 "itemsPerPage": 1000,
 "startIndex": 1,
 "Ressourcen": [
 {
 "id": "d737377c-f8ba-4df7-b290-78b9a2bff8e9",
 "displayName": "Vertriebsteam",
 "members": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "$ref": "/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "User"
 }
 ],
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "meta": {
 "resourceType": "Group",
 "location": "/Groups/d737377c-f8ba-4df7-b290-78b9a2bff8e9", 

Antwortcodes:

• 200 OK: Erfolg
• 400 Fehlerhafte Anfrage: Ungültiger Filter
• 401 Nicht autorisiert: Ungültige Anmeldeinformationen
• 429 Zu viele Anfragen: Ratengrenze überschritten
• 500 Interner Serverfehler

POST /Gruppen

Erstellt eine neue Gruppe.

URL-Parameter:

• displayName: Menschlich lesbarer Name (nicht erforderlich, nicht eindeutig – mehrere Gruppen können denselben Namen haben) (Erforderlich)

• members: Array von Mitgliederobjekten (Optional)

{
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "displayName": "Engineering-Team",
 "members": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "User"
 }
 ]
}

{
 "id": "e8f9a0b1-c2d3-4567-89ab-cdef01234567",
 "displayName": "Engineering-Team",
 "members": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "$ref": "/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "User"
 }
 ],
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "meta": {
 "resourceType": "Group",
 "location": "/Groups/e8f9a0b1-c2d3-4567-89ab-cdef01234567",
 "created": "2025-12-02T11:30:23Z",
 "lastModified": "2025-12-02T11:30:23Z",
 "version": "1.0"
 }
}

Antwortcodes:

• 201 Erstellt: Gruppe erfolgreich erstellt

• 400 Bad Request: Ungültige Anfrage

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

GET /Groups/{id}

Ruft eine bestimmte Gruppe nach UUID ab.

Pfadparameter:

• id: Gruppen-UUID

Antwortcodes:

• 200 OK: Erfolg

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Die Gruppe existiert nicht

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

PUT /Gruppen/{id}

Ersetzt alle Gruppenattribute einschließlich der Mitglieder.

Pfadparameter:

• id: Gruppen-UUID

Antwortcodes:

• 200 OK: Gruppe erfolgreich aktualisiert

• 400 Fehlerhafte Anfrage: Ungültiger Vorgang

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Die Gruppe existiert nicht

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

PATCH /Gruppen/{id}

Aktualisiert eine Gruppe teilweise. Wird häufig verwendet, um Mitglieder hinzuzufügen oder zu entfernen.

Pfadparameter:

id – Gruppen-UUID

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
 "Operations": [
 {
 "op": "add",
 "path": "members",
 "value": [
 {
 "value": "user-uuid-here",
 "type": "User"
 }
 ]
 }
 ]
}

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
 "Operations": [
 {
 "op": "remove",
 "path": "members[value eq \"user-uuid-here\"]"
 }
 ]
}

Antwortcodes:

• 200 OK: Gruppe erfolgreich aktualisiert

• 400 Fehlerhafte Anfrage: Ungültiger Vorgang

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Die Gruppe existiert nicht

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

DELETE /Groups/{id}

Löscht eine Gruppe.

Pfadparameter:

• id: Gruppen-UUID

Antwortcodes:

• 204 Kein Inhalt: Gruppe erfolgreich gelöscht

• 401 Nicht autorisiert: Ungültige Anmeldeinformationen

• 404 Nicht gefunden: Die Gruppe existiert nicht

• 429 Zu viele Anfragen: Ratengrenze überschritten

• 500 Interner Serverfehler

Informationen zum Dienstanbieter

Endpunkte

• /ServiceProviderConfig: Informationen über den Dienstanbieter abrufen

• /Schemas: Erhalten Sie Informationen zu den Schemata, die für die Benutzer- und Gruppenverwaltung verwendet werden

GET /ServiceProviderConfig

Erhalten Sie Informationen über die Fähigkeiten der SCIM-Dienstleister.

{
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
 "patch": {
 "supported": true
 },
 "bulk": {
 "supported": false
 },
 "filter": {
 "supported": true,
 "maxResults": 1000
 },
 "changePassword": {
 "supported": false
 },
 "sort": {
 "supported": false
 },
 "etag": {
 "supported": false
 },
 "authenticationSchemes": [
 {
 "name": "HTTP Basic",
 "description": "Grundlegendes Authentifizierungsschema",
 "specUri": "https://www.ietf.org/rfc/rfc2617",
 "primary": true,
 "type": "Grundlegende Authentifizierung"
 }
 ],
 "meta": {
 "location": "/ServiceProviderConfig",
 "resourceType": "ServiceProviderConfig"
 }
}

GET /Schemas

Ruft Informationen zu allen unterstützten SCIM-Schemata ab.

Unterstützte Schemata:

• urn:ietf:params:scim:schemas:core:2.0:User

• urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

• urn:ietf:params:scim:schemas:extension:sap:2.0:User

• urn:ietf:params:scim:schemas:core:2.0:Group