Breve Visão Geral

O Provedor de Serviços WalkMe SCIM permite gerenciar usuários e grupos de forma programática usando um endpoint compatível com SCIM 2.0. O WalkMe expõe uma API REST baseada na especificação do Sistema para Gerenciamento de Identidades entre domínios (SCIM 2.0).

Essa API permite que você faça o seguinte:

• Crie, leia, atualize, corrija e exclua Usuários e grupos.
• Pesquise usuários e grupos com filtragem e paginação.
• Obtenha informações sobre o provedor de serviços WalkMe, esquemas disponíveis e tipos de recursos

Pré-requisitos

• Você deve ter uma conta do WalkMe.
• Você deve criar a integração do SCIM no Centro de Administração do WalkMe e gerar credenciais

Configurar a Integração SCIM

Ativar SCIM no WalkMe

Antes de ativar o SCIM, você primeiro precisa criar uma integração SCIM no Centro de Administração do WalkMe.

1. Faça login no Centro de Administração do WalkMe

2. Vá para a página de integração SCIM

3. Selecione Integração SCIM

4. Selecionar + Criar Integração SCIM

5. No painel de integração Criar SCIM:

   1. Insira o Nome da Integração para identificar sua integração (por exemplo, "Produção" ou "Encenação")

   2. Selecione o Tipo de Autorização

      1. Autenticação básica: usa um nome de usuário e senha para autenticação

      2. Token de portador: usa um token de portador para autenticação

6. Selecione Gerar Credenciais

1. Se você selecionou Autenticação Básica, uma janela popup será aberta exibindo as credenciais do SCIM geradas para essa integração:

   1. URL base do SCIM: o URL de ponto final para a configuração SCIM do seu Provedor de Identidade

   2. Nome de usuário: o nome de usuário gerado automaticamente para autenticação

   3. Senha: a senha gerada automaticamente para autenticação

2. Selecione Concluído para concluir a configuração da integração SCIM no WalkMe

1. Se você selecionou Token de Portador, uma janela popup será aberta exibindo as credenciais do SCIM geradas para essa integração:

   1. URL base do SCIM: o URL de ponto final para a configuração SCIM do seu Provedor de Identidade

   2. Token do portador: o token seguro usado para autenticação

2. Selecione Concluído para concluir a configuração da integração SCIM no WalkMe

Pontos finais e parâmetros da API SCIM 2.0

Esta API usa o SCIM 2.0. Para obter mais informações, consulte Esquema Principal SCIM (RFC 7643)

URLs de base

• EUA: 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

Autenticação

Todas as solicitações exigem Autenticação Básica HTTP ou autenticação de Token do Portador:

• Autenticação básica:

  • Autorização: Basic <base64 (nome de usuário:senha)>

• Token do portador:

  • Autorização: token de portador <gerado pelo portador>

Gerenciamento de usuários

EndPoints

• /Usuários: crie um usuário (POST) ou obtenha uma lista de usuários (GET)

• /Users/{id}: Obter (GET), atualizar (PUT), aplicar um patch (PATCH) ou excluir (DELETE) um usuário

GET /Usuários

Obtém uma lista de usuários com filtragem e paginação opcionais

Parâmetros de URL:

• startIndex: índice baseado em 1 do primeiro usuário a retornar. O padrão é 1. (Opcional)

• contagem: (Opcional) Número de Usuários a retornar por página (máximo de 1000). O padrão é 1000. (Opcional)

• filtro: expressão do filtro SCIM (Opcional)

  • Operadores suportados: 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": {
 "formatado": "John Doe",
 "familyName": "Doe",
 "givenName": "John"
 },
 "displayName": "John Doe",
 "ativo": true,
 "e-mails": [
 {
 "value": "john.doe@example.com",
 "type": "work",
 "primário": true
 }
 ],
 "grupos": [],
 "esquemas": [
 "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",
 "criado": "2025-12-02T11:30:23Z",
 "lastModified": "2025-12-02T11:30:23Z",
 "versão": "1.0"
 }
 }
 ]
}

Códigos de resposta:

• 200 OK: Sucesso

• 400 Solicitação Ruim: solicitação ou filtro inválido

• 401 Não autorizado: credenciais inválidas

• 403 Proibido: acesso negado

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

POST /Usuários

Cria um novo usuário.

Atributos necessários:

• userName: deve ser exclusivo (sem maiúsculas)
• e-mails: deve incluir pelo menos um e-mail com principal: true

Atributos gerados automaticamente:

• id: UUID gerado pelo sistema
• urn:ietf:params:scim:schemas:extension:sap:2.0:User.userUuid: gerado automaticamente, se não for fornecido

{
 "esquemas": [
 "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": {
 "formatado": "John Doe",
 "familyName": "Doe",
 "givenName": "John"
 },
 "displayName": "John Doe",
 "e-mails": [
 {
 "value": "john.doe@example.com",
 "type": "work",
 "primário": true
 }
 ],
 "ativo": verdadeiro
}

Códigos de resposta:

• 201 Criado: usuário criado com sucesso

• 400 Solicitação Ruim: atributos necessários ausentes ou valores inválidos

• 401 Não autorizado: credenciais inválidas

• 409 Conflito: userName já existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

GET /Usuários/{id}

Obtém um usuário específico por ID (UUID).

Parâmetros de caminho:

• id: UUID do usuário (não userName)

Códigos de resposta:

• 200 OK: Sucesso
• 401 Não autorizado: credenciais inválidas
• 404 Não encontrado: o usuário não existe
• 429 Demasiados Requisitos: limite de taxa excedido
• 500 Erro Interno do Servidor

PUT /Usuários/{id}

Substitui todos os atributos de usuário. Os atributos ReadOnly são preservados e não podem ser alterados.

Parâmetros de caminho:

id: UUID do usuário (não userName)

Códigos de resposta:

• 200 OK: usuário atualizado com sucesso

• 400 Solicitação Ruim: solicitação inválida

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o usuário não existe

• 409 Conflito: conflito userName

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

PATCH /Usuários/{id}

Parâmetros de caminho:

• id: UUID do usuário (não userName)

Operações suportadas:

• adicionar, substituir, remover

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

Códigos de resposta:

• 200 OK: usuário atualizado com sucesso

• 400 Solicitação Ruim: operação ou caminho inválido

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o usuário não existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

DELETE /Usuários{id}

Exclui um usuário.

Parâmetros de caminho:

• id: UUID do usuário (não userName)

Códigos de resposta:

• 204 Sem Conteúdo: usuário excluído com sucesso

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o usuário não existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

Gerenciamento de grupo

EndPoints

• /Grupos: criar um grupo (POST) ou obter uma lista de grupos (GET)

• /Grupos/{id}: Obter (GET), atualizar (PUT), corrigir (PATCH) ou excluir (DELETE) um grupo

GET /Grupos

Obtém uma lista de grupos com filtragem e paginação opcionais.

Parâmetros de URL:

• startIndex:índice baseado em 1 do primeiro grupo a retornar. O padrão é 1. (Opcional)

• contagem: número de grupos a retornar por página (máximo de 1000). O padrão é 1000. (Opcional)

• filtro: expressão de filtro SCIM usada para pesquisar grupos específicos. O padrão é nenhum. (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": "Equipe de Vendas",
 "membros": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "$ref": "/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "Usuário"
 }
 ],
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "meta": {
 "resourceType": "Grupo",
 "location": "/Groups/d737377c-f8ba-4df7-b290-78b9a2bff8e9", 

Códigos de resposta:

• 200 OK: Sucesso
• 400 Solicitação Ruim: filtro inválido
• 401 Não autorizado: credenciais inválidas
• 429 Demasiados Requisitos: limite de taxa excedido
• 500 Erro Interno do Servidor

POST /Grupos

Cria um novo grupo.

Parâmetros de URL:

• displayName: nome legível por humanos (não obrigatório, não exclusivo - vários grupos podem ter o mesmo nome) (Obrigatório)

• Membros: Matriz de objetos membros (Opcional)

{
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "displayName": "Equipe de Engenharia",
 "membros": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "Usuário"
 }
 ]
}

{
 "id": "e8f9a0b1-c2d3-4567-89ab-cdef01234567",
 "displayName": "Equipe de Engenharia",
 "membros": [
 {
 "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "$ref": "/Users/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
 "type": "Usuário"
 }
 ],
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
 "meta": {
 "resourceType": "Grupo",
 "location": "/Groups/e8f9a0b1-c2d3-4567-89ab-cdef01234567",
 "criado": "2025-12-02T11:30:23Z",
 "lastModified": "2025-12-02T11:30:23Z",
 "versão": "1.0"
 }
}

Códigos de resposta:

• 201 Criado: Grupo criado com sucesso

• 400 Solicitação Ruim: solicitação inválida

• 401 Não autorizado: credenciais inválidas

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

GET /Grupos/{id}

Obtém um grupo específico por UUID.

Parâmetros de caminho:

• id: UUID do grupo

Códigos de resposta:

• 200 OK: Sucesso

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o grupo não existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

PUT /Grupos/{id}

Substitui todos os atributos do grupo, incluindo membros.

Parâmetros de caminho:

• id: UUID do grupo

Códigos de resposta:

• 200 OK: Grupo atualizado com sucesso

• 400 Solicitação Ruim: Operação inválida

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o grupo não existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

PATCH /Grupos/{id}

Atualiza parcialmente um grupo. Comumente usado para adicionar/remover membros.

Parâmetros de caminho:

• id - UUID do grupo

{
 "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
 "Operações": [
 {
 "op": "add",
 "path": "membros",
 "value": [ ]
 {
 "value": "user-uuid-here",
 "type": "Usuário"
 }
 ]
 }
 ]
}

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

Códigos de resposta:

• 200 OK: Grupo atualizado com sucesso

• 400 Solicitação Ruim: Operação inválida

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o grupo não existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

EXCLUIR /Grupos/{id}

Exclui um grupo.

Parâmetros de caminho:

• id: UUID do grupo

Códigos de resposta:

• 204 Sem Conteúdo: Grupo excluído com sucesso

• 401 Não autorizado: credenciais inválidas

• 404 Não encontrado: o grupo não existe

• 429 Demasiados Requisitos: limite de taxa excedido

• 500 Erro Interno do Servidor

Informações do provedor de serviços

EndPoints

• /ServiceProviderConfig: obter informações sobre o provedor de serviços

• /Esquemas: obter informações sobre os esquemas usados para gerenciamento de usuários e grupos

GET /ServiceProviderConfig

Obtém informações sobre os recursos do provedor de serviços SCIM.

{
 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],
 "patch": {
 "suportado": true
 },
 "bulk": {
 "suportado": falso
 },
 "filter": {
 "suportado": true,
 "maxResults": 1000
 },
 "changePassword": {
 "suportado": falso
 },
 "sort": {
 "suportado": falso
 },
 "etag": {
 "suportado": falso
 },
 "authenticationSchemes": [ ]
 {
 "name": "HTTP Basic",
 "description": "Esquema de autenticação básica",
 "specUri": "https://www.ietf.org/rfc/rfc2617",
 "primário": true,
 "type": "Autenticação básica"
 }
 ],
 "meta": {
 "location": "/ServiceProviderConfig",
 "resourceType": "ServiceProviderConfig"
 }
}

GET /Schemas

Obtém informações sobre todos os esquemas SCIM suportados.

Esquemas suportados:

• 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