Detalhes de um usuário

Request

Retorna um usuário específico.

Security

BasicAuth

Path

idstringrequired

ID do usuário.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/users/{id}'

Responses

Usuário encontrado.

Bodyapplication/json

_idstring

Identificador único do recurso, gerado internamente.

_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...

Example:"2024-09-29T08:00-03:00"

_updatedstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...

Example:"2024-09-29T08:00-03:00"

_etagstring(EtagModel)

Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

full_namestring

Nome completo.

Example:"Exemplo da Silva"

emailstring

Endereço de e-mail.

Example:"exemplo@tiquetaque.com"

mobile_phonestring

Número de telefone celular com código de área, somente números.

Example:"11991234567"

external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

intercom_chatboolean

Indica se o chat do intercom no TiqueAdmin está habilitado para este usuário.

verified_userboolean

Indica se a conta do usuário já foi verificada através do email de ativação.

Example:true

rolestring(RoleModel)

Papel do usuário. Os valores possíveis são: ['admin', 'admin-supervisor', 'supervisor', read-only]
- admin: Administrador de todas as unidades, pode fazer todas as configurações e gestão do sistema, como adicionar novos usuários, empregadores, unidades, funcionários e escalas; adicionar lançamentos de Banco de Horas; visualizar os demais usuários e mudar suas permissões; lançar, aprovar e reprovar afastamentos; reabrir folhas e adicionar, remover e reprovar registros.
- admin-supervisor: Não pode: adicionar e visualizar usuários, visualizar funcionários que não estejam na sua unidade, editar configurações e adicionar empregadores. A não ser por isto, possui a mesma permissão do administrador, porém apenas para as unidades selecionadas.
- supervisor: Pode apenas adicionar unidade, funcionários e escalas, das unidades selecionadas.
- read-only: Pode apenas: visualizar os dados das unidades selecionadas.

Example:"admin-supervisor"

allowed_sitesArray of strings(AllowedSitesModel)

Lista de unidades as quais o usuário tem acesso. Obrigatório e aplicável apenas quando o usuário não é admin. Restringe a visualização de funcionários apenas aos funcionários vinculados à estas unidades. O formato dos dados é uma lista de IDs de unidades cadastradas na conta. NOTA: Não existe ainda na API pública o recurso de unidades, isto será adicionado futuramente.

Example:

[
  "id_1",
  "id_2"
]

permissionsobject(UserPermissionsModel)

Configurações de permissões de usuário.

Response

{
  "_id": "string",
  "_created": "2024-09-29T08:00-03:00",
  "_updated": "2024-09-29T08:00-03:00",
  "_etag": "string",
  "full_name": "Exemplo da Silva",
  "email": "exemplo@tiquetaque.com",
  "mobile_phone": "11991234567",
  "external_id": "string",
  "intercom_chat": true,
  "verified_user": true,
  "role": "admin-supervisor",
  "allowed_sites": [
    "id_1",
    "id_2"
  ],
  "permissions": {
    "allow_ws_edition": true
  }
}