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 (
Status3) até ela aceitar, pelo link do e-mail (POST /user/password-resetcomInvite=1) ou pelo aviso no app (campoInviteAnswerdoPUT /user/{iduser}). O convite vale por 7 dias. A resposta trazPending: truee 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
- 200
- 400
- 500
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 }].
Erros (prefixo [BadRequest]):
Usuário não tem privilégio para cadastrar usuárioNão foi possível validar o privilégio; nada foi salvo (<código>)CPF / CNPJ inválido, verificar os números digitadosEmail inválido, verificarApenas a equipe idworks pode cadastrar usuário com e-mail do domínio idworks.com.brTipo de MFA inválidoTipo de comissão não existeDocumento obrigatório quando não é informadoDocumento e/ou email obrigatório para cadastrar usuárioO e-mail e o documento informados pertencem a usuários diferentesEmail já está vinculado a outro usuárioDocumento já está vinculado a outro usuárioApenas a equipe idworks pode vincular usuário do domínio idworks.com.brNão foi possível conferir as outras contas do usuário; nada foi salvo (<código>)Não foi possível reativar o usuário (<código>)Não foi possível vincular o usuário à conta (<código>)Empresa não existeProblema ao criar usuário
Convite:
Este usuário está desativado e tem acesso a outra conta. Para reativá-lo, fale com o suporteEste usuário recusou um convite desta conta. Um novo convite só a partir de dd/mm/aaaaNão foi possível conferir convites anteriores; nada foi salvo (<código>)Não foi possível registrar o convite (<código>)Não foi possível gerar o convite (<código>)Este usuário não tem convite pendente nesta conta(ResendInvite)Não foi possível consultar o convite (<código>)(ResendInvite)
Validação dos dados profissionais:
Função não existente, preencha corretamenteFunção atual não atribuída ao colaboradorCargo não existe, preencha corretamenteFunção não permitida para o cargo selecionadoEscala não existe, preencha corretamenteColaborador superior não existe, preencha corretamenteCategoria de armazenamento não existeGrupo de armazenamento não existe
Erro interno (prefixo Error:).