Breve descripción general

El proveedor de servicios de SCIM de WalkMe te permite administrar de forma programada usuarios y grupos utilizando un punto final compatible con SCIM 2.0. WalkMe expone una API REST basada en la especificación del Sistema para la Gestión de Identidades entre dominios (SCIM 2.0).

Esta API te permite hacer lo siguiente:

• Crea, lee, actualiza, parchea y elimina usuarios y grupos.
• Busca usuarios y grupos con filtrado y paginación.
• Obtén información sobre el proveedor de servicios de WalkMe, los esquemas disponibles y los tipos de recursos

Requisitos previos

• Debes tener una cuenta de WalkMe
• Debes crear la integración de SCIM en el Centro de administración de WalkMe y generar credenciales

Configurar la integración de SCIM

Habilitar SCIM en WalkMe

Antes de activar SCIM, primero debes crear una integración de SCIM en el Centro de administración de WalkMe.

1. Inicia sesión en el Centro de administración de WalkMe

2. Ve a la página de integración de SCIM

3. Selecciona Integración de SCIM

4. Selecciona + Crear integración de SCIM

5. En el panel Crear integración de SCIM:

   1. Introduce el Nombre de la integración para identificar la integración (por ejemplo, "Producción" o "Staging")

   2. Selecciona el Tipo de autorización

      1. Autenticación básica: utiliza un nombre de usuario y una contraseña para la autenticación

      2. Token de portador: utiliza un token de portador para la autenticación

6. Selecciona Generar credenciales

1. Si seleccionas Autenticación básica, se abre una ventana emergente que muestra las credenciales de SCIM generadas para esta integración:

   1. URL base de SCIM: la URL de punto final para la configuración de SCIM de tu proveedor de identidad

   2. Nombre de usuario: el nombre de usuario generado automáticamente para la autenticación

   3. Contraseña: la contraseña generada automáticamente para la autenticación

2. Selecciona Listo para completar la configuración de la integración de SCIM en WalkMe

1. Si seleccionas Bearer Token, se abre una ventana emergente que muestra las credenciales de SCIM generadas para esta integración:

   1. URL base de SCIM: la URL de punto final para la configuración de SCIM de tu proveedor de identidad

   2. Bearer Token: el token seguro utilizado para la autenticación

2. Selecciona Listo para completar la configuración de la integración de SCIM en WalkMe

Puntos finales y parámetros de la API SCIM 2.0

Esta API utiliza SCIM 2.0. Para obtener más información, consulta Esquema básico de SCIM (RFC 7643)

URL base

• EE. UU.: https://papi.walkme.com/deepui/api/scim/v2

• UE: https://eu-papi.walkme.com/deepui/api/scim/v2

• Canadá: https://papi-ca1.walkmedap.com/deepui/api/scim/v2

• FedRAMP:https://papi.walkmegov.com/deepui/api/scim/v2

Autenticación

Todas las solicitudes requieren autenticación HTTP básica o autenticación Bearer Token:

• Autenticación básica:

  • Autorización: básica <base64 (nombre de usuario:contraseña)>

• Token de Bearer:

  • Autorización: Bearer token de portador <generado>

Gestión de usuarios

Puntos finales

• /Usuarios: crea un usuario (POST) u obtén una lista de usuarios (GET)

• /Usuarios/{id}: Obtener (GET), actualizar (PUT), parchear (PATCH) o eliminar (ELIMINAR) un usuario

GET /Usuarios

Obtiene una lista de usuarios con filtrado y paginación opcional

Parámetros de URL:

• startIndex: índice basado en 1 del primer usuario que devolverá El valor predeterminado es 1. (Opcional)

• recuento: (Opcional) Número de usuarios que se devolverán por página (máximo 1000). El valor predeterminado es 1000. (Opcional)

• filtro: expresión del filtro SCIM (Opcional)

  • Operadores compatibles: 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,
 "Recursos": [
 {
 "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",
 "tipo": "trabajo",
 "principal": verdadero
 }
 ],
 "grupos": [],
 "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",
 "versión": "1.0"
 }
 }
 ]
}

Códigos de respuesta:

• 200 OK: éxito

• 400 Solicitud incorrecta: solicitud o filtro inválido

• 401 No autorizado: credenciales no válidas

• 403 Prohibido: acceso denegado

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

POST /Users

Crea un nuevo usuario.

Atributos requeridos:

• Nombre de usuario: debe ser único (no sensible a mayúsculas)
• correos electrónicos: debe incluir al menos un correo electrónico con la opción principal: true

Atributos generados automáticamente:

• id: UUID generado por el sistema
• urn:ietf:params:scim:schemas:extension:sap:2.0:User.userUuid: se genera automáticamente si no se proporciona

{
 "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",
 "tipo": "trabajo",
 "principal": verdadero
 }
 ],
 "active": true
}

Códigos de respuesta:

• 201 Created: usuario creado con éxito

• 400 Solicitud incorrecta: faltan atributos requeridos o valores inválidos

• 401 No autorizado: credenciales no válidas

• 409 Conflict: el Nombre de usuario ya existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

GET /Users/{id}

Obtiene un usuario específico por su ID (UUID).

Parámetros de ruta:

• id: UUID de usuario (no Nombre de usuario)

Códigos de respuesta:

• 200 OK: éxito
• 401 No autorizado: credenciales no válidas
• 404 No se ha encontrado: el usuario no existe
• 429 Demasiadas solicitudes: se ha excedido el límite de tasa
• 500 Error interno del servidor

PUT /Users/{id}

Reemplaza todos los atributos de usuario. Los atributos de Solo lectura se conservan y no se pueden cambiar.

Parámetros de ruta:

id: UUID de usuario (no Nombre de usuario)

Códigos de respuesta:

• 200 OK: usuario actualizado con éxito

• 400 Bad Request: Solicitud inválida

• 401 No autorizado: credenciales no válidas

• 404 No se ha encontrado: el usuario no existe

• 409 Conflict: conflicto de userName

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

PATCH /Users/{id}

Parámetros de ruta:

• id: UUID de usuario (no Nombre de usuario)

Operaciones compatibles:

• añadir, reemplazar, eliminar

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

Códigos de respuesta:

• 200 OK: usuario actualizado con éxito

• 400 Solicitud incorrecta: operación o ruta no válida

• 401 No autorizado: credenciales no válidas

• 404 No se ha encontrado: el usuario no existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

ELIMINAR /Usuarios{id}

Elimina un usuario.

Parámetros de ruta:

• id: UUID de usuario (no Nombre de usuario)

Códigos de respuesta:

• 204 Sin contenido: usuario eliminado con éxito

• 401 No autorizado: credenciales no válidas

• 404 No se ha encontrado: el usuario no existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

Gestión de grupos

Puntos finales

• /Grupos: crea un grupo (POST) u obtén una lista de grupos (GET)

• /Grupos/{id}: obtener (GET), actualizar (PUT), parchear (PATCH) o eliminar (ELIMINAR) un grupo

GET /Groups

Obtiene una lista de grupos con filtrado y paginación opcionales.

Parámetros de URL:

• startIndex:índice basado en 1 del primer grupo que se devuelve. El valor predeterminado es 1. (Opcional)

• count: el número de grupos que se devolverán por página (máximo 1000). El valor predeterminado es 1000. (Opcional)

• filtro: expresión de filtro SCIM utilizada para buscar grupos específicos. El valor predeterminado es ninguno. (Opcional)

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

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
 "totalResults": 1,
 "itemsPerPage": 1000,
 "startIndex": 1,
 "Recursos": [
 {
 "id": "d737377c-f8ba-4df7-b290-78b9a2bff8e9",
 "displayName": "Equipo de ventas",
 "miembros": [
 {
 "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", 

Códigos de respuesta:

• 200 OK: éxito
• 400 Solicitud incorrecta: filtro inválido
• 401 No autorizado: credenciales no válidas
• 429 Demasiadas solicitudes: se ha excedido el límite de tasa
• 500 Error interno del servidor

POST /Grupos

Crea un nuevo grupo.

Parámetros de URL:

• displayName: nombre legible para humanos (no requerido, no único; varios grupos pueden tener el mismo nombre) (requerido)

• miembros: matriz de objetos miembro (Opcional)

{
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "displayName": "Equipo de ingeniería",
 "miembros": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "User"
 }
 ]
}

{
 "id": "e8f9a0b1-c2d3-4567-89ab-cdef01234567",
 "displayName": "Equipo de ingeniería",
 "miembros": [
 {
 "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",
 "versión": "1.0"
 }
}

Códigos de respuesta:

• 201 Creado: grupo creado con éxito

• 400 Bad Request: Solicitud inválida

• 401 No autorizado: credenciales no válidas

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

GET /Groups/{id}

Obtiene un grupo específico por UUID.

Parámetros de ruta:

• id: UUID de grupo

Códigos de respuesta:

• 200 OK: éxito

• 401 No autorizado: credenciales no válidas

• 404 No se encuentra: el grupo no existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

PUT /Groups/{id}

Reemplaza todos los atributos de grupo, incluidos los miembros.

Parámetros de ruta:

• id: UUID de grupo

Códigos de respuesta:

• 200 OK: grupo actualizado con éxito

• 400 Solicitud incorrecta: operación inválida

• 401 No autorizado: credenciales no válidas

• 404 No se encuentra: el grupo no existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

PATCH /Groups/{id}

Actualiza parcialmente un grupo. Se utiliza comúnmente para añadir/eliminar miembros.

Parámetros de ruta:

• id - UUID de grupo

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

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

Códigos de respuesta:

• 200 OK: grupo actualizado con éxito

• 400 Solicitud incorrecta: operación inválida

• 401 No autorizado: credenciales no válidas

• 404 No se encuentra: el grupo no existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

DELETE /Groups/{id}

Elimina un grupo.

Parámetros de ruta:

• id: UUID de grupo

Códigos de respuesta:

• 204 Sin contenido: grupo eliminado con éxito

• 401 No autorizado: credenciales no válidas

• 404 No se encuentra: el grupo no existe

• 429 Demasiadas solicitudes: se ha excedido el límite de tasa

• 500 Error interno del servidor

Información del proveedor de servicios

Puntos finales

• /ServiceProviderConfig: obtiene información sobre el proveedor de servicios para

• /Esquemas: obtén información sobre los esquemas utilizados para la gestión de usuarios y grupos

GET /ServiceProviderConfig

Obtiene información sobre las capacidades del proveedor de servicios de SCIM.

{
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
 "parche": {
 "supported": true
 },
 "en masa": {
 "supported": false
 },
 "filter": {
 "supported": true,
 "maxResults": 1000
 },
 "changePassword": {
 "supported": false
 },
 "sort": {
 "supported": false
 },
 "etag": {
 "supported": false
 },
 "authenticationSchemes": [
 {
 "name": "HTTP Basic",
 "description": "Esquema de autenticación básica",
 "specUri": "https://www.ietf.org/rfc/rfc2617",
 "primary": true,
 "type": "Autenticación básica"
 }
 ],
 "meta": {
 "location": "/ServiceProviderConfig",
 "resourceType": "ServiceProviderConfig"
 }
}

GET /Schemas

Obtiene información sobre todos los esquemas de SCIM compatibles.

Esquemas compatibles:

• 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