API de Gestão de Usuários

• Data de publicação: 23 de Janeiro de 2026
• Versão necessária: Disponibilizado na versão GA (RUB 26 - General Availability)

Objetivo

Disponibilizar no RUB a API de Gestão de Usuários, permitindo realizar operações de consulta, criação, atualização, exclusão, gestão de grupos e troca de senha por meio de API REST com payload JSON, respeitando as regras de segurança, permissões e configurações dinâmicas do sistema.

Essa funcionalidade possibilita a integração do RUB com sistemas externos de forma padronizada e controlada.

Contexto do Problema / Demanda

Anteriormente, a gestão de usuários no RUB era realizada majoritariamente por meio da interface web, o que limitava a automação e a integração com sistemas externos responsáveis pelo provisionamento e sincronização de usuários.

Havia a necessidade de disponibilizar uma API segura e completa que permitisse:

• Automatizar o ciclo de vida de usuários;
• Padronizar as regras de criação e atualização;
• Aplicar as mesmas validações existentes na interface web;
• Controlar o acesso por permissões específicas.

Solução Implementada

Foi implementada a API de Gestão de Usuários, baseada em REST / JSON, com autenticação por token, permitindo o gerenciamento completo de usuários no RUB.

A API contempla os seguintes recursos:

• Consulta de usuário;
• Criação ou atualização de usuário;
• Exclusão de usuário;
• Troca de senha;
• Vinculação e desvinculação de grupos;
• Sincronização completa de grupos do usuário.

Todas as operações respeitam:

• As permissões atribuídas ao aplicativo;
• As configurações dinâmicas de usuário e senha;
• As validações de negócio e de formato.

Autenticação e Permissões

Autenticação

• A API utiliza token de autenticação vinculado a um aplicativo configurado no RUB;
• Cada requisição valida a existência, validade e escopo do token.

Permissões

• É obrigatória a atribuição da permissão Usuário ao aplicativo;
• Caso o token não possua a permissão adequada, a API retorna HTTP 403 – Forbidden.

Endpoints Disponíveis

Os endpoints disponíveis, bem como sua documentação, estão disponiveis em Documentação API na seção Access Control

Validações de Configuração

Antes da execução das operações, a API valida automaticamente as configurações dinâmicas do sistema, incluindo:

Configurações de Senha

• Quantidade mínima de caracteres;
• Uso de letras maiúsculas e minúsculas;
• Uso de números;
• Uso de caracteres especiais;
• Expiração de senha;
• Regras específicas para usuários administradores.

Configurações de Usuário

• Limite máximo de grupos por usuário;
• Regras de bloqueio e inativação;
• Comportamento ao remover grupos;
• Marcação automática de senha expirada.

Essas validações garantem que a API siga exatamente as mesmas regras aplicadas na interface web do RUB.

Códigos de Retorno HTTP

• 200 – Requisição válida (sucesso ou erro de negócio descrito na mensagem);
• 400 – Erro de formato, validação ou configuração;
• 401 – Token ausente, inválido ou expirado;
• 403 – Token válido, porém sem permissão;
• 404 – Recurso não encontrado;
• 429 – Limite de requisições excedido;
• 500 – Erro interno inesperado.

Formato de Resposta

As respostas da API seguem um padrão JSON contendo:

• status: código HTTP;
• message: descrição do resultado da operação.

As mensagens retornadas são consistentes com as exibidas na interface web do sistema.

Benefícios

• Automação da gestão de usuários;
• Integração segura com sistemas externos;
• Padronização das regras de acesso e validação;
• Redução de operações manuais;
• Consistência funcional entre API e interface web.