SCIM significa System for Cross-domain Identity Management. É um padrão usado por provedores como Microsoft Entra ID e Okta para criar, atualizar e desativar usuários em aplicativos externos.
Com SCIM, o administrador da empresa pode controlar o ciclo de vida do usuário no diretório corporativo. Quando o usuário entra na empresa, o provedor cria o acesso na Nvoip. Quando muda dados ou é desativado, o provedor envia essa alteração para a Nvoip.
| Item | Valor |
|---|---|
| Base URL | https://painel.nvoip.com.br/api/scim/v2 |
| ServiceProviderConfig | https://painel.nvoip.com.br/api/scim/v2/ServiceProviderConfig |
| Usuários | https://painel.nvoip.com.br/api/scim/v2/Users |
Use Bearer Token no header Authorization:
Authorization: Bearer TOKEN_SCIM_GERADO_NA_NVOIP
O token é exibido somente no momento da criação. Se perder o token, revogue o token antigo e gere outro.
| Operação | Endpoint | Efeito na Nvoip |
|---|---|---|
| Listar usuários | GET /Users |
Retorna usuários da conta para o provedor. |
| Buscar usuário | GET /Users/{id} |
Retorna um usuário específico. |
| Criar usuário | POST /Users |
Cria usuário secundário se o e-mail ainda não existir. |
| Atualizar usuário | PUT /Users/{id} |
Atualiza dados básicos do usuário. |
| Atualização parcial | PATCH /Users/{id} |
Usado principalmente para alterar active. |
| Remover usuário | DELETE /Users/{id} |
Desativa o usuário na Nvoip. Não apaga permanentemente. |
| Atributo SCIM | Uso |
|---|---|
userName |
E-mail principal do usuário. É o principal identificador usado para localizar ou criar o usuário. |
emails[0].value |
E-mail do usuário, usado como fallback se necessário. |
name.givenName e name.familyName |
Nome e sobrenome. |
displayName |
Nome completo exibido. |
active |
Quando false, o usuário é bloqueado/desativado na Nvoip. |
Na implementação atual, usuários criados pelo SCIM entram como usuário secundário. O SCIM não aplica permissões detalhadas do painel nem mapeia grupos para permissões internas.
Para controlar quem pode entrar, use as regras do SSO:
Para controlar o que o usuário pode acessar dentro do painel, ajuste as permissões do usuário na Nvoip depois que ele for criado.
| Erro | Causa provável |
|---|---|
| 401 ou não autorizado | Token ausente, token revogado ou token copiado incorretamente. |
| Usuário duplicado no provedor | O provedor pode estar enviando outro identificador. Use e-mail corporativo em userName. |
| Usuário criado, mas sem permissões esperadas | SCIM cria usuário secundário; permissões detalhadas precisam ser configuradas na Nvoip. |
| Usuário não consegue logar após SCIM | SCIM não autentica. Confirme se OIDC ou SAML está ativo e se o usuário passa nas regras de domínio/grupo. |