Pular para o conteúdo principal

Registrar Usuários em Lote

Este serviço permite a criação em lote de múltiplos usuários em uma única requisição, útil para administrar equipes e atribuir permissões de maneira eficiente.

Endpoint para Registrar Usuários em Lote​

  • Método: POST
  • URL: https://bff-dev.granatech.com.br/api/auth/register/batch

Autorização​

Para utilizar este serviço, o usuário autenticado deve possuir a seguinte permissão:

  • CREATE_USER

Caso o usuário autenticado não tenha as permissões necessárias, o serviço retornará um erro de autorização.

Estrutura de Dados para Registro de Usuários​

O corpo da requisição deve ser um objeto JSON contendo uma lista de usuários a serem criados. Cada objeto usuário deve conter os seguintes campos:

Campos do Objeto User​

  • name (string, obrigatório): Nome do usuário.
  • lastName (string, obrigatório): Sobrenome do usuário.
  • document (string, obrigatório): Documento do usuário.
  • email (string, opcional): E-mail do usuário.
  • cellphone (string, opcional): Número de celular do usuário.
  • password (string, obrigatório): Senha para o usuário.
  • corbanId (number, opcional): ID do Corban associado ao usuário, se aplicável.
  • creditPromoterId (number, opcional): ID do Promotor de Crédito associado ao usuário, se aplicável.

Exemplo de Dados para Registro em Lote​

{
  "users": [
    {
      "name": "João",
      "lastName": "Silva",
      "document": "12345678901",
      "email": "joao.silva@example.com",
      "cellphone": "11987654321",
      "password": "senhaSegura123",
      "corbanId": 1
    },
    {
      "name": "Maria",
      "lastName": "Oliveira",
      "document": "98765432100",
      "email": "maria.oliveira@example.com",
      "cellphone": "11976543210",
      "password": "outraSenhaSegura",
      "creditPromoterId": 2
    }
  ]
}

Exemplo de Requisição com curl para Registro em Lote​

curl -X POST https://bff-dev.granatech.com.br/api/auth/register/batch \
  -H "Content-Type: application/json" \
  -d '{
    "users": [
      {
        "name": "João",
        "lastName": "Silva",
        "document": "12345678901",
        "email": "joao.silva@example.com",
        "cellphone": "11987654321",
        "password": "senhaSegura123",
        "corbanId": 1
      },
      {
        "name": "Maria",
        "lastName": "Oliveira",
        "document": "98765432100",
        "email": "maria.oliveira@example.com",
        "cellphone": "11976543210",
        "password": "outraSenhaSegura",
        "creditPromoterId": 2
      }
    ]
  }'

Exemplo de Resposta​

[
  {
    "id": "user12345",
    "name": "João",
    "lastName": "Silva",
    "email": "joao.silva@example.com",
    "corbanId": 1,
    "createdAt": "2024-10-01T12:00:00Z"
  },
  {
    "id": "user67890",
    "name": "Maria",
    "lastName": "Oliveira",
    "email": "maria.oliveira@example.com",
    "creditPromoterId": 2,
    "createdAt": "2024-10-01T12:05:00Z"
  }
]

Observações​

  1. Estrutura Correta do Corpo: O corpo da requisição deve conter o campo users como uma lista de objetos User. Caso contrário, o serviço retornará um erro de requisição inválida.
  2. Permissões Necessárias: Somente usuários com permissão CREATE_USER ou GRANATECH podem registrar usuários em lote.
  3. Resposta da Requisição: A resposta incluirá detalhes dos usuários criados, com seus respectivos IDs e dados associados, indicando que a criação foi bem-sucedida.