Logo SOAR

Registro de Usuário

Descrição

Cadastra um novo usuário com e-mail e senha, associando automaticamente à role padrão "Individual". Caso o usuário venha através do convite por email (endpoint: Invite User), o mesmo será associado à role "Master Practitioner" ou "Practitioner", dependendo do ID do usuário que fez o convite.

Verbo

POST

Endpoint

/auth/register

Cabeçalhos

Parâmetro Valor
Content-Type application/json

Campos Esperados

Campo Tipo Obrigatório Descrição
email string Sim E-mail do usuário. Deve ser válido.
password string Sim Senha do usuário. Mínimo 8 caracteres.
confirm_password string Sim Confirmação da senha. Deve ser idêntica à senha.
parent_id int Não ID do usuário que está fazendo o convite no caso um Master Practitioner ou Practitioner. Uso apenas quando o registro do usuário será feito pelo convite via email

Corpo da Requisição

{
  "email": "user@email.com",
  "password": "senha1234",
  "confirm_password": "senha1234",
  "parent_id": 8
}

Observação: O corpo da requisição deve ser enviado como JSON no formato raw.

Respostas

Sucesso - 201

{
  "success": true,
  "code": 201,
  "message": "User successfully registered with default role."
}

Erro - 400 (Senhas não coincidem)

{
    "status": 400,
    "error": 400,
    "messages": {
        "error": "Password and confirmation do not match."
    }
}

Erro - 400 (Campos Ausentes)

{
    "status": 400,
    "error": 400,
    "messages": {
        "error": "Email, password, and password confirmation are required."
    }
}

Erro - 409 (E-mail já cadastrado)

{
  "status": 409,
  "error": 409,
  "messages": {
    "error": "This email is already registered."
  }
}

Erro - 500 (Falha no cadastro)

{
  "status": 500,
  "error": "Failed to register user."
}

Códigos de Resposta

  • 201 - Cadastro realizado com sucesso
  • 400 - Senhas inválidas ou campos ausentes
  • 409 - E-mail já cadastrado
  • 500 - Erro ao salvar usuário no banco