Usuário

Permite a criação de um novo usuário na plataforma, vinculando-o a uma empresa e definindo suas permissões de acesso.

📌 Endpoint

• Método: POST
• Endpoint: /users

Após a criação, o usuário receberá um ID único, que poderá ser utilizado para consultas e atualizações futuras.

Realiza a busca de usuários cadastrados na plataforma com base em critérios de pesquisa, possibilitando a listagem segmentada conforme as necessidades do cliente.

📌 Endpoint

• Método: GET
• Endpoint: /users

Os filtros disponíveis permitem a localização de usuários por diferentes parâmetros, garantindo maior precisão na consulta.

Retorna os detalhes completos de um usuário específico, incluindo suas informações gerais e permissões configuradas.

📌 Endpoint

• Método: GET
• Endpoint: /users/{id}

Para recuperar os dados, é necessário informar o ID do usuário, que pode ser obtido no momento da criação ou por meio da busca de usuários.

Permite a atualização dos dados de um usuário previamente cadastrado, garantindo flexibilidade na gestão de acessos e permissões.

📌 Endpoint

• Método: PUT
• Endpoint: /users/{id}

O ID do usuário deve ser informado para que as alterações sejam aplicadas corretamente. Apenas os campos permitidos poderão ser modificados.

Permite a consulta do local associado ao usuário, fornecendo informações sobre sua última atividade e acessos na plataforma.

📌 Endpoint

• Método: PUT
• Endpoint: /users/{id}/locale

O ID do usuário é obrigatório para realizar a consulta. Esse método pode ser útil para auditoria e controle de acessos.

Permite o bloqueio de um usuário previamente cadastrado.

📌 Endpoint

• Método: PUT
• Endpoint: /users/block/{id}

Para realizar a operação, é necessário informar o ID do usuário na URL e definir o parâmetro block como true ou false por meio de Query Params.

Exemplo de Requisição:

/users/block/{id}?block=true

O ID do usuário deve ser informado para que o bloqueio seja efetuado.