Autenticar usuário

POST 
/autenticacao

Valida as credenciais e retorna um token. Se o usuário estiver associado a mais de um tenant, a resposta informa os tenants disponíveis e o cliente deve concluir a seleção em PUT /autenticacao/tenant.

Request

application/json

Body

Body

required

Responses

200

Autenticação concluída.

application/json

Schema

Schema

dataHoraExpira date-time

usuario

object

nome string

login string

email email

Example (from schema)

{
  "token": "string",
  "dataHoraExpira": "2024-07-29T15:51:28.071Z",
  "usuario": {
    "nome": "string",
    "login": "string",
    "email": "[email protected]"
  }
}

Example

{
  "token": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "dataHoraExpira": "2026-07-13T18:00:00",
  "usuario": {
    "nome": "Usuário Administrador",
    "login": "admin",
    "email": "[email protected]"
  }
}

300

Credenciais válidas, mas é necessário selecionar um tenant.

application/json

Schema

Schema

token stringrequired

tenants

object[]

required

Array [

razaoSocial stringrequired

]

Example (from schema)

{
  "token": "string",
  "tenants": [
    {
      "id": "021e9b1d0f",
      "razaoSocial": "Empresa Exemplo Ltda."
    }
  ]
}

400

Parâmetro ausente, inválido ou incompatível com a configuração do período.

application/json

Schema

Schema

errors

object[]

required

Array [

]

Example (from schema)

{
  "errors": [
    {
      "id": "string",
      "msg": "string"
    }
  ]
}

obrigatorio

{
  "errors": [
    {
      "id": "dataInicial",
      "msg": "O campo [dataInicial] não pode ser vazio"
    }
  ]
}

periodoNaoConfigurado

{
  "errors": [
    {
      "id": "parametroFolhaPonto",
      "msg": "Não foi encontrado período de folha para a competência informada"
    }
  ]
}

dataForaDoPeriodo

{
  "errors": [
    {
      "id": "dataInicial",
      "msg": "A data informada deve estar compreendida no período de ponto"
    }
  ]
}

403

Token ausente, inválido, expirado ou sem autorização para a operação.

application/json

Schema

Schema

Example (from schema)

{
  "message": "Operação Negada! Entre em contato com o administrador da API."
}

tokenAusente

{
  "message": "É necessário o envio de token para essa operação"
}

tokenExpirado

{
  "message": "Token expirou!"
}

Loading...