Pular para o conteúdo principal

Cria um usuário

POST 

/user

Cadastra um usuário na empresa autenticada. É obrigatório informar UserName e pelo menos um identificador de login: Login (e-mail) ou UserCpfCnpj. Quando só o documento é enviado, o sistema gera um login interno no formato <documento>@email.com.br. Quando um e-mail real é informado, um e-mail de boas-vindas é enviado.

Exige o privilégio de cadastrar usuário (PrivilegeUserCreate).

Se já existir uma pessoa com o mesmo Login/UserCpfCnpj, o cadastro reaproveita esse registro em vez de duplicar, e só os dados do vínculo com a empresa são aplicados — os dados pessoais (UserName, UserTelephone, UserExtenalId, MFAEnabled, MFAType) e RestrictAccessSalesman ficam como estavam. A resposta não traz o cadastro da pessoa: só IDUser e AccountName (mais Pending e InviteSentTo no convite). O caminho depende das outras contas dela:

  • Sem vínculo em outra conta (fora desta e das filiais dela — conta qualquer vínculo que não seja convite: ativo, inativo ou bloqueado, em empresa ativa ou suspensa): o vínculo é criado ou reativado na hora, e a pessoa recebe um aviso por e-mail.
  • Com vínculo em outra conta: a pessoa recebe um convite e o vínculo fica pendente (Status 3) até ela aceitar, pelo link do e-mail (POST /user/password-reset com Invite=1) ou pelo aviso no app (campo InviteAnswer do PUT /user/{iduser}). O convite vale por 7 dias. A resposta traz Pending: true e o e-mail mascarado para onde o convite foi (InviteSentTo); com login interno (<documento>@email.com.br) não há e-mail, e o convite só aparece no app. O mesmo vale para quem tem vínculo inativo ou bloqueado nesta conta e acesso a outra. Enquanto o convite está pendente, o cadastro não pode ser editado (PUT /user/{iduser}) e os perfis atribuídos ficam guardados no convite até o aceite.
  • Convite pendente nesta conta: cadastrar de novo reenvia o convite (link novo; os anteriores deixam de valer). Para reenviar sem recadastrar, envie { "ResendInvite": true, "IDUser": <id> }.
  • Recusa recente: depois que a pessoa recusa, a conta só pode convidá-la de novo após 30 dias.

Login e UserCpfCnpj precisam ser únicos dentro da empresa.

O cadastro também aceita os dados profissionais do colaborador — funções, função atual, cargo, escala, supervisor e categorias/grupos de endereço de armazenagem —, validados contra os cadastros da empresa.

Request​

Responses​

Conforme o caso:

  • Pessoa nova com login gerado a partir do documento: a string "sucesso".
  • Pessoa nova com e-mail real: o detalhe completo do usuário (mesmo formato de GET /user/{iduser}); se a releitura falhar, [{ IDUser, AccountName }].
  • Pessoa que já existia, vinculada na hora: [{ IDUser, AccountName }].
  • Convite (inclusive reenvio): [{ IDUser, AccountName, Pending: true, InviteSentTo }].