Atualizar Usuário

Este serviço permite atualizar as informações de um usuário específico com base nos dados fornecidos.

Endpoint para Atualizar Usuário

• Método: PUT
• URL: https://bff-dev.granatech.com.br/api/user/{userId}

Parâmetros de Caminho

• userId (string, obrigatório): ID do usuário a ser atualizado. Este parâmetro deve ser incluído na URL para especificar qual usuário será alterado.

Estrutura de Dados para Atualização do Usuário

O objeto User contém os campos que podem ser atualizados para o perfil de um usuário. Preencha apenas os campos que deseja atualizar; os campos omitidos permanecerão inalterados.

Campos do Objeto User

• id (string, obrigatório): ID do usuário a ser atualizado. Deve ser incluído no corpo da requisição para validar a atualização.
• name (string, opcional): Nome do usuário.
• lastName (string, opcional): Sobrenome do usuário.
• document (string, opcional): Documento do usuário.
• email (string, opcional): E-mail do usuário.
• cellphone (string, opcional): Número de celular do usuário.
• password (string, opcional): Senha do usuário.
• corbanId (number, opcional): ID do Corban associado, se aplicável.
• creditPromoterId (number, opcional): ID do Promotor de Crédito associado, se aplicável.

Exemplo de Dados para Atualizar Usuário

{
  "id": "12345",
  "name": "João",
  "lastName": "Silva",
  "email": "novo.email@example.com",
  "cellphone": "11987654321"
}

Exemplo de Requisição com curl para Atualizar Usuário

curl -X PUT https://bff-dev.granatech.com.br/api/user/12345 \
  -H "Content-Type: application/json" \
  -d '{
    "id": "12345",
    "name": "João",
    "lastName": "Silva",
    "email": "novo.email@example.com",
    "cellphone": "11987654321"
  }'

Exemplo de Resposta

{
  "id": "12345",
  "name": "João",
  "lastName": "Silva",
  "email": "novo.email@example.com",
  "cellphone": "11987654321",
  "corbanId": 1,
  "creditPromoterId": null,
  "roles": [
    {
      "id": "role1",
      "name": "Admin",
      "permissions": ["CREATE", "READ", "DELETE"]
    }
  ],
  "createdAt": "2024-10-01T12:00:00Z"
}

Observações

1. Autenticação: Este endpoint requer autenticação para acesso.
2. Campos Opcionais: Somente os campos fornecidos serão atualizados. Os demais campos permanecem inalterados.
3. ID Obrigatório: O campo id do usuário deve ser fornecido tanto na URL quanto no corpo da requisição para garantir a especificidade da atualização.
4. Associações: corbanId e creditPromoterId são opcionais e podem ser utilizados conforme a necessidade de associação do usuário.

Utilize este endpoint para realizar alterações no perfil do usuário de maneira específica e flexível.