> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Provisionamento SCIM

> Automatize o gerenciamento do ciclo de vida de usuários e grupos com SCIM 2.0.

Truthlocks suporta SCIM 2.0 para provisionamento automatizado de usuários e gerenciamento de grupos. Conecte seu provedor de identidade (Okta, Azure AD, OneLogin, etc.) para criar, atualizar e desativar usuários automaticamente em seu inquilino Truthlocks.

> [!NOTE]
>
> O provisionamento SCIM está disponível no plano **Business** e superiores.

## Como funciona

**1. Gerar um token SCIM**

Na Console, vá para **Configurações > SCIM** e gere um token de portador.
Este token autentica as solicitações SCIM do seu IdP.

**2. Configure seu IdP**

No seu provedor de identidade, defina a URL base do SCIM para
`https://api.truthlocks.com/scim/v2` e cole o token de portador.

**3. Sincronizar usuários e grupos**

Seu IdP envia criações, atualizações e desativações de usuários para Truthlocks
automaticamente. As alterações na associação de grupo atualizam as atribuições de função.

## URL base do SCIM

```text theme={null}
https://api.truthlocks.com/scim/v2
```

Todas as solicitações SCIM devem incluir o token bearer no cabeçalho `Authorization`:

```bash theme={null}
curl -X GET https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here"
```

## Operações suportadas

### Usuários

| Operação | Método | Caminho | Descrição |
| - | - | - | - |
| Listar | GET | `/scim/v2/Users` | Listar usuários com filtro opcional |
| Criar | POST | `/scim/v2/Users` | Provisionar um novo usuário |
| Obter | GET | `/scim/v2/Users/{id}` | Recuperar um usuário por ID SCIM |
| Substituir | PUT | `/scim/v2/Users/{id}` | Substituição completa do usuário |
| Patch | PATCH | `/scim/v2/Users/{id}` | Atualização parcial (por exemplo, desativar) |
| Excluir | DELETE | `/scim/v2/Users/{id}` | Suspender o usuário |

### Grupos

| Operação | Método | Caminho | Descrição |
| - | - | - | - |
| Listar | GET | `/scim/v2/Groups` | Listar grupos |
| Criar | POST | `/scim/v2/Groups` | Criar um mapeamento de grupo |
| Obter | GET | `/scim/v2/Groups/{id}` | Recuperar um grupo por ID SCIM |
| Substituir | PUT | `/scim/v2/Groups/{id}` | Substituir grupo (remapeia vinculações de função) |
| Patch | PATCH | `/scim/v2/Groups/{id}` | Adicionar ou remover membros |
| Excluir | DELETE | `/scim/v2/Groups/{id}` | Excluir mapeamento de grupo |

### Descoberta

| Método | Caminho | Descrição |
| - | - | - |
| GET | `/scim/v2/ServiceProviderConfig` | Capacidades suportadas |
| GET | `/scim/v2/Schemas` | Esquemas de recursos |
| GET | `/scim/v2/ResourceTypes` | Tipos de recursos disponíveis |

## Criar um usuário

```bash theme={null}
curl -X POST https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "userName": "jane@example.com",
    "name": { "givenName": "Jane", "familyName": "Smith" },
    "emails": [{ "value": "jane@example.com", "primary": true }],
    "active": true
  }'
```

## Desativar um usuário

IdPs como Okta e Azure AD enviam uma solicitação PATCH para desativar usuários:

```bash theme={null}
curl -X PATCH https://api.truthlocks.com/scim/v2/Users/{id} \
  -H "Authorization: Bearer scim_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{ "op": "replace", "path": "active", "value": false }]
  }'
```

Usuários desativados perdem o acesso imediatamente, mas seus dados são retidos.

## Gerenciando tokens SCIM

Gerar e gerenciar tokens através da API de gerenciamento:

```bash theme={null}
# Generate a new token
curl -X POST https://api.truthlocks.com/v1/scim/tokens \
  -H "Authorization: Bearer <admin_token>" \
  -H "Content-Type: application/json" \
  -d '{ "label": "Okta SCIM" }'

# List tokens
curl -X GET https://api.truthlocks.com/v1/scim/tokens \
  -H "Authorization: Bearer <admin_token>"

# Revoke a token
curl -X DELETE https://api.truthlocks.com/v1/scim/tokens/<token_id> \
  -H "Authorization: Bearer <admin_token>"
```

## Registro de atividades

Todas as operações SCIM são registradas em um log de atividades. Visualize eventos de provisionamento recentes:

```bash theme={null}
curl -X GET https://api.truthlocks.com/v1/scim/activity \
  -H "Authorization: Bearer <admin_token>"
```

Os tipos de atividade incluem `USER_CREATED`, `USER_DEACTIVATED`, `USER_PATCHED`, `GROUP_CREATED`, `GROUP_UPDATED` e `GROUP_DELETED`.

## Aplicação de assentos

A criação de usuários respeita o limite de assentos do seu plano. Se o limite for excedido, o endpoint SCIM retorna HTTP `402` e o usuário não é criado. Atualize seu plano ou remova usuários inativos para liberar assentos.

## Filtragem

O parâmetro de consulta SCIM `filter` permite que seu provedor de identidade restrinja as respostas da lista a usuários ou grupos específicos. Truthlocks oferece suporte à filtragem em atributos SCIM específicos usando os operadores abaixo.

### Atributos de filtro suportados

| Atributo | Recurso | Descrição |
| - | - | - |
| `userName` | Usuários | O identificador de login do usuário (geralmente um endereço de e-mail) |
| `displayName` | Usuários, Grupos | O nome de exibição do usuário ou grupo |
| `externalId` | Usuários, Grupos | O identificador exclusivo atribuído pelo seu provedor de identidade |
| `active` | Usuários | Se a conta do usuário está ativa (`true` / `false`) |

### Operadores suportados

| Operador | Significado | Exemplo |
| - | - | - |
| `eq` | Igual a | `userName eq "jane@example.com"` |
| `ne` | Diferente de | `active ne false` |
| `co` | Contém | `userName co "example.com"` |
| `sw` | Começa com | `userName sw "jane"` |
| `ew` | Termina com | `userName ew "@example.com"` |

Combine operadores usando `and` / `or` para consultas complexas:

```bash theme={null}
# Find active users whose username contains "example.com"
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=active eq true and userName co "example.com"'

# Find users starting with "jane" or "john"
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=userName sw "jane" or userName sw "john"'

# Look up a user by their IdP-assigned external ID
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=externalId eq "00u1a2b3c4d5e6f7g8h9"'

# Find a user by display name
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=displayName eq "Jane Smith"'
```

> [!NOTE]
>
> Os resultados filtrados são limitados a 200 itens por resposta. Se o seu IdP sincronizar mais de 200 usuários ou grupos, ele deverá paginar usando os parâmetros `startIndex` e `count` junto com o filtro.

### Padrões comuns de filtro IdP

A maioria dos provedores de identidade envia filtros automaticamente durante a sincronização. Aqui estão os padrões que o Truthlocks lida:

| IdP | Filtro típico enviado |
| - | - |
| Okta | `userName eq "user@example.com"` |
| Azure AD | `userName eq "user@example.com"`, `displayName co "Smith"`, ou `externalId eq "id"` |
| OneLogin | `userName sw "user"` ou `externalId eq "id"` |

Se o seu IdP enviar um filtro usando qualquer um dos atributos e operadores suportados listados acima, o Truthlocks o processará corretamente. Você não precisa configurar nada no lado do Truthlocks.

## Capacidades suportadas

| Capacidade | Suportado |
| - | - |
| Patch | Sim |
| Em massa | Não |
| Filtro | Sim — `eq`, `ne`, `co`, `sw`, `ew` em `userName`, `displayName`, `externalId`, `active` com `and` / `or` (máx. 200 resultados) |
| Classificar | Não |
| Alterar senha | Não |
| ETag | Não |

## Relacionado

* [SAML SSO](https://docs.truthlocks.com/pt/security/saml-sso.md) — Autenticar usuários através do seu IdP.
* [RBAC e permissões](https://docs.truthlocks.com/pt/security/rbac.md) — Funções atribuídas aos usuários provisionados.
* [Logs de auditoria](https://docs.truthlocks.com/pt/security/audit.md) — Rastreie todos os eventos de acesso e provisionamento.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.