API Usuários

Chamadas de API para operação dos objetos Usuários (Usuários de Acesso ao Sistema).

Base path: /users/

---

Listar Usuários

Realiza a consulta dos usuários cadastrados na plataforma Autosky e vinculados aos clientes.

GET /users/

Parâmetros de Query (opcionais)

Parâmetro	Tipo	Descrição
cli_uuid	string	UUID do cliente para filtrar usuários específicos

Resposta

Status: 200 OK

[
    {
        "nome": "João",
        "sobrenome": "Souza",
        "email": "[e-mail]",
        "ativo": true,
        "username": "joao.souza",
        "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
        "external_ad": false
    }
]

---

Obter dados de um usuário

Obtém dados de um usuário especificado por seu UUID. Além dos campos da listagem, também inclui o campo clients.

GET /users/{usr_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
usr_uuid	Sim	UUID do usuário

Resposta

Status: 200 OK

{
    "nome": "João",
    "sobrenome": "Souza",
    "email": "[e-mail]",
    "ativo": true,
    "username": "joao.souza",
    "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
    "clients": [
        {
            "cli_uuid": "79ea8324-4889-4729-8bf0-bc1c40b38273",
            "nome": "MeuCliente001",
            "grupo_seguranca": "Cliente001",
            "email_admin": "[e-mail]",
            "has_license_limit": false,
            "license_limit": 0,
            "amb_uuid": "715088c9-9f21-424e-bcd5-5eacc0ce165b"
        }
    ],
    "external_ad": false
}

---

Cadastrar Usuário

Realiza o cadastramento de um novo usuário na plataforma.

• Caso o usuário já exista, este procedimento irá apenas vinculá-lo ao cliente enviado como parâmetro.

• Armazene o UUID de retorno para modificações futuras.

• Caso possua um Active Directory específico para o ambiente, utilize external_ad: true para configurar a senha no cadastro.

POST /users/

Body da Requisição

Campo	Tipo	Obrigatório	Descrição
nome	string	Sim	Nome do usuário
sobrenome	string	Não	Sobrenome do usuário
email	string	Sim	Email de logon do usuário
ativo	boolean	Não	Se o usuário está ativo
username	string	Não	Nome do usuário no AD
password	string	Não	Senha do usuário
cli_uuid	string	Sim	UUID do cliente em que o usuário será cadastrado
description	string	Não	Informações complementares do usuário
fullname	string	Não	Nome completo (deve conter ao menos duas palavras separadas)
external_ad	boolean	Não	true caso possua Active Directory próprio
send_activation_email	boolean	Não	Se deve enviar email de ativação ao usuário

Exemplo de Requisição

{
    "nome": "Joao",
    "sobrenome": "Souza",
    "email": "[e-mail]",
    "ativo": true,
    "username": "joao.souza",
    "password": "senha123",
    "cli_uuid": "769a0f4e-16a8-422a-99ab-d8c416137d4c",
    "description": "Informações do Usuário XXXX",
    "fullname": "Joao Souza Martins",
    "external_ad": false,
    "send_activation_email": false
}

Resposta

Status: 200 OK

{
    "nome": "Joao",
    "sobrenome": "Souza",
    "email": "[e-mail]",
    "ativo": true,
    "username": "joao.souza",
    "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
    "clients": [],
    "external_ad": true
}

---

Editar Usuário

Realiza a edição das informações do usuário. Apenas algumas informações poderão ser modificadas.

PUT /users/{usr_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
usr_uuid	Sim	UUID do usuário

Body da Requisição

Campo	Tipo	Descrição
nome	string	Nome do usuário
sobrenome	string	Sobrenome do usuário
ativo	boolean	Se o usuário está ativo
password	string	Senha do usuário
description	string	Informações complementares

Exemplo de Requisição

{
    "nome": "Joao",
    "sobrenome": "Souza",
    "ativo": true,
    "password": "senha123"
}

Resposta

Status: 200 OK

Retorna o objeto completo do usuário atualizado, incluindo o array clients.

---

Ativar / Desativar Usuário

Ativa ou desativa um usuário.

PATCH /users/{usr_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
usr_uuid	Sim	UUID do usuário

Body da Requisição

Campo	Tipo	Obrigatório	Descrição
ativo	boolean	Sim	true para ativar, false para desativar
send_activation_email	boolean	Não	Se deve enviar email de ativação
cli_uuid	string	Não	UUID do cliente associado ao envio do email

Exemplo de Requisição

{
    "ativo": true,
    "send_activation_email": false,
    "cli_uuid": "769a0f4e-16a8-422a-99ab-d8c416137d4c"
}

Resposta

Status: 200 OK

{
    "nome": "João",
    "sobrenome": "Souza",
    "email": "[e-mail]",
    "ativo": true,
    "username": "joao.souza",
    "cli_uuid": "769a0f4e-16a8-422a-99ab-d8c416137d4c"
}

---

Alterar Senha do Usuário

Modifica a senha de acesso de um usuário.

Nota: As informações de senha não são armazenadas no banco de dados da plataforma Autosky. São armazenadas diretamente no AD de autenticação definido na plataforma.

PATCH /users/{usr_uuid}

Parâmetros de Path

Parâmetro	Obrigatório	Descrição
usr_uuid	Sim	UUID do usuário

Body da Requisição

Campo	Tipo	Obrigatório	Descrição
password	string	Sim	Nova senha do usuário

Exemplo de Requisição

{
    "password": "NovaSenhaSegura@2024!"
}

Resposta

Status: 200 OK

{
    "status": "success"
}

---

Remover Usuário

Este endpoint remove um usuário ou o desvincula de um cliente específico.

O endpoint nem sempre exclui o usuário do sistema. Se o usuário estiver vinculado a mais de um cliente, ele será apenas desvinculado do cliente informado (permanecendo ativo e com acesso aos demais clientes). Caso seja o último ou o único cliente do usuário, ele será integralmente removido e perderá o acesso ao sistema.

Parâmetros de Requisição (Body)

Ao contrário de requisições de exclusão tradicionais, este endpoint aceita e pode exigir um corpo (body) em formato application/json.

• cli_uuid (string): Identificador do cliente do qual deseja desvincular o usuário.

  • Obrigatório se o usuário possuir vínculo com mais de um cliente.

  • Opcional se o usuário estiver vinculado a apenas um cliente.

Exemplo de Request Body:

{
  "cli_uuid": "0e92037b-ed77-4a38-ab35-909637bea146"
}

Respostas

• 200 OK - Sucesso

O usuário foi removido do sistema ou desvinculado do cliente com sucesso.

• 200 OK - Cliente não informado (Múltiplos Vínculos)

Retornado quando o usuário possui vínculos com mais de um cliente, mas o cli_uuid não foi enviado no corpo da requisição. (Nota: O status HTTP retornado é 200, e não um erro 4xx). A resposta trará a lista de clientes aos quais o usuário pertence para que um seja escolhido.

Exemplo:

{
  "status": "error",
  "status_code": "USR006",
  "message": "Por favor informe um cliente (cli_uuid)",
  "clientes": [
    // Lista de clientes vinculados a este usuário
  ]
}

• 404 Not Found - Não Encontrado

O usuário informado não existe ou não foi encontrado.