Plantonizei

Painel da empresa › Usuários

Criar usuário

POST/api/v1/usersPede sessão

Como funciona

Cria uma pessoa no painel da empresa e manda o convite por e-mail para ela criar a senha. O link do convite vale 1 hora; depois disso, reenvie com POST /users/{id}/password-link.

  • name e email são obrigatórios.
  • role é o papel: admin, coordenador, escalista ou hospital. O papel define o que a pessoa pode fazer, junto com o perfil de permissão.
  • jobTitle é o cargo, só para exibição. status começa como active ou inactive.
  • O e-mail não pode ter conta no Plantonizei, nem nesta empresa, nem em outra, nem de médico (409).

Parâmetros

  • emailCorpo · stringE-mail.
  • jobTitleCorpo · stringCargo, só para exibição.
  • nameCorpo · stringNome.
  • roleCorpo · stringPapel na empresa: `admin`, `coordenador`, `escalista` ou `hospital`.
  • statusCorpo · stringSituação.
  • profileIdCorpo · stringPerfil de Permissões escolhido no campo Permissão (id de `GET /permissions`). Ausente: não mexe; vazio: volta ao perfil nativo do papel. Perfil sem papel (Suporte, Operacional) precisa vir aqui.
  • companyIdsCorpo · string[]Acesso por empresa: as empresas cadastradas (de `GET /me/registered-companies`) que o usuário pode ver, cada uma com todas as escalas dela. Ausente: não mexe; vazia: todas. Empresa de outro cliente dá 400. O filtro é do servidor: médicos, escalas, calendário, vagas, check-in, trocas, antecipações, folha, contratos, contas, mensagens dos médicos e as contagens do menu só trazem o que é das escalas dessas empresas; registro de fora, pedido pelo id, responde como não encontrado. Pagar a folha de médico com plantão fora do acesso dá 403, e o mesmo vale para mexer pelo id em ponto, plantão, jornada, troca, candidatura ou faturamento de escala fora do acesso, ou mandar no corpo escala, jornada ou plantão de fora (criar plantão, jornada ou troca, valores e faturamento do contrato, médico na escala).

Respostas

201 · user: a pessoa criada.

  • userobject · A pessoa criada.
  • user.createdAtstring · Quando foi criado.
  • user.emailstring · E-mail.
  • user.idstring · Identificador do registro.
  • user.jobTitlestring · Cargo, só para exibição.
  • user.lastAccessstring · Último acesso.
  • user.namestring · Nome.
  • user.rolestring · Papel na empresa: admin, coordenador, escalista ou hospital.
  • user.statusstring · Situação.

Corpo de exemplo

{
  "user": {
    "createdAt": "texto",
    "email": "medico@exemplo.com.br",
    "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
    "jobTitle": "texto",
    "lastAccess": "texto",
    "name": "texto",
    "role": "texto",
    "status": "texto"
  }
}