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

Zugriff

Zugriff in der Konsole:

1. Öffnen Sie die WalkMe-Konsole
   
   • US-Rechenzentrum
   • EU-Datenzentrum
   • SAP US Data Center
   • SAP EU Data Center
   • FedRAMP-Rechenzentrum
   • Kanada-Rechenzentrum
2. Gehen Sie zur Kategorie Admin
3. Integration Center auswählen
4. SCIM-Integration auswählen

SCIM-Integration einrichten

SCIM in WalkMe aktivieren

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

1. Wählen Sie auf der Seite SCIM-Integration die Option + SCIM-Integration erstellen

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

3. Wählen Sie den Autorisierungstyp aus

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

   2. Träger-Token: Verwendet ein Träger-Token für die Authentifizierung

4. 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:

  • Autorisierung: 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)

• Anzahl: (Optional) Anzahl der Benutzer, die pro Seite zurückgegeben werden sollen (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,
    "Resources": [
        {
            "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",
                    "primary": 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": "<BASE_URL>/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "created": "2025-12-02T11:30:23Z",
                "lastModified": "2025-12-02T11:30:23Z",
                "version": "1.0"
            }
        }
    ]
}

Response codes:

• 200 OK: Success

• 400 Bad Request: Invalid request or filter

• 401 Unauthorized: Invalid credentials

• 403 Forbidden: Access denied

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

POST /Users

Creates a new user.

Required attributes:

• userName: Must be unique (case-insensitive)
• emails: Must include at least one email with primary: true

Auto-generated attributes:

• id: System-generated UUID
• urn:ietf:params:scim:schemas:extension:sap:2.0:User.userUuid: Auto-generated if not provided

{
    "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",
            "primary": true
        }
    ],
    "active": true
}

Response codes:

• 201 Created: User created successfully

• 400 Bad Request: Missing required attributes or invalid values

• 401 Unauthorized: Invalid credentials

• 409 Conflict: userName already exists

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

GET /Users/{id}

Gets a specific user by their id (UUID).

Path parameters:

• id: User UUID (not userName)

Response codes:

• 200 OK: Success
• 401 Unauthorized: Invalid credentials
• 404 Not Found: User does not exist
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error

PUT /Users/{id}

Replaces all user attributes. ReadOnly attributes are preserved and cannot be changed.

Path parameters:

id: User UUID (not userName)

Response codes:

• 200 OK: User updated successfully

• 400 Bad Request: Invalid request

• 401 Unauthorized: Invalid credentials

• 404 Not Found: User does not exist

• 409 Conflict: userName conflict

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

PATCH /Users/{id}

Path parameters:

• id: User UUID (not userName)

Supported operations:

• add, replace, remove

{
    "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"
                }
            ]
        }
    ]
}

Response codes:

• 200 OK: User updated successfully

• 400 Bad Request: Invalid operation or path

• 401 Unauthorized: Invalid credentials

• 404 Not Found: User does not exist

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

DELETE /Users{id}

Deletes a user.

Path parameters:

• id: User UUID (not userName)

Response codes:

• 204 No Content: User deleted successfully

• 401 Unauthorized: Invalid credentials

• 404 Not Found: User does not exist

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

Group management

EndPoints

• /Groups: Create a group (POST) or get a list of groups (GET)

• /Groups/{id}: Get (GET), update (PUT), patch (PATCH), or delete (DELETE) a group

GET /Groups

Gets a list of groups with optional filtering and pagination.

URL parameters:

• startIndex:1-based index of the first group to return. Default is 1. (Optional)

• count: Number of groups to return per page (maximum 1000). Default is 1000. (Optional)

• filter: SCIM filter expression used to search for specific groups. Default is none. (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,
    "Resources": [
        {
            "id": "d737377c-f8ba-4df7-b290-78b9a2bff8e9",
            "displayName": "Sales Team",
            "members": [
                {
                    "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                    "$ref": "<BASE_URL>/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                    "type": "User"
                }
            ],
            "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
            "meta": {
                "resourceType": "Group",
                "location": "<BASE_URL>/Groups/d737377c-f8ba-4df7-b290-78b9a2bff8e9", 

Response codes:

• 200 OK: Success
• 400 Bad Request: Invalid filter
• 401 Unauthorized: Invalid credentials
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error

POST /Groups

Creates a new group.

URL parameters:

• displayName: Human-readable name (not required, not unique - multiple groups can have the same name) (Required)

• members: Array of member objects (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": "<BASE_URL>/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "type": "User"
        }
    ],
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "meta": {
        "resourceType": "Group",
        "location": "<BASE_URL>/Groups/e8f9a0b1-c2d3-4567-89ab-cdef01234567",
        "created": "2025-12-02T11:30:23Z",
        "lastModified": "2025-12-02T11:30:23Z",
        "version": "1.0"
    }
}

Response codes:

• 201 Created: Group created successfully

• 400 Bad Request: Invalid request

• 401 Unauthorized: Invalid credentials

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

GET /Groups/{id}

Gets a specific group by UUID.

Path parameters:

• id: Group UUID

Response codes:

• 200 OK: Success

• 401 Unauthorized: Invalid credentials

• 404 Not Found: Group does not exist

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

PUT /Groups/{id}

Replaces all group attributes including members.

Path parameters:

• id: Group UUID

Response codes:

• 200 OK: Group updated successfully

• 400 Bad Request: Invalid operation

• 401 Unauthorized: Invalid credentials

• 404 Not Found: Group does not exist

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

PATCH /Groups/{id}

Partially updates a group. Commonly used to add/remove members.

Path parameters:

id - Group 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\"]"
        }
    ]
}

Response codes:

• 200 OK: Group updated successfully

• 400 Bad Request: Invalid operation

• 401 Unauthorized: Invalid credentials

• 404 Not Found: Group does not exist

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

DELETE /Groups/{id}

Deletes a group.

Path Parameters:

• id: Group UUID

Response codes:

• 204 No Content: Group deleted successfully

• 401 Unauthorized: Invalid credentials

• 404 Not Found: Group does not exist

• 429 Too Many Requests: Rate limit exceeded

• 500 Internal Server Error

Service provider information

EndPoints

• /ServiceProviderConfig: Get information about the Service Provider

• /Schemas: Get information on the schemas used for user and group management

GET /ServiceProviderConfig

Gets information about the SCIM service provider capabilities.

{
    "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": "Basic authentication scheme",
            "specUri": "https://www.ietf.org/rfc/rfc2617",
            "primary": true,
            "type": "Basic authentication"
        }
    ],
    "meta": {
        "location": "<BASE_URL>/ServiceProviderConfig",
        "resourceType": "ServiceProviderConfig"
    }
}

GET /Schemas

Gets information on all supported SCIM schemas.

Supported schemas:

• 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