Nunciatura Provista

API Documentation V1

Perfil do Usuário Autenticado

Retorna os dados do usuário autenticado

Este endpoint é do tipo: Protected

Descrição

Retorna os dados completos do usuário autenticado com as seguintes funcionalidades:

  • Valida o token JWT no header Authorization
  • Carrega dados do usuário com todos os relacionamentos (informer, treatmentPronoun, diocese, group, role)
  • Retorna informações completas do perfil
  • Inclui dados específicos de informador (se aplicável)
  • Retorna lista de permissões do usuário

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

ENDPOINT

/auth/me

Cabeçalhos

ParâmetroValor
AuthorizationBearer <token>

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "user": {
      "id": "9fd6b694-602a-461f-a052-c473f59bbcc6",
      "first_name": "Sergio",
      "last_name": "Borges",
      "email": "sluizborges@gmail.com",
      "img_url": "https://via.placeholder.com/150/28a745/ffffff?text=SB",
      "initials": "SB",
      "email_verified_at": "2025-01-21T17:00:00.000000Z",
      "created_at": "2025-01-21T17:00:00.000000Z",
      "updated_at": "2025-01-21T17:00:00.000000Z",
      "role": {
        "id": 1,
        "name": "Administrador",
        "slug": "admin"
      },
      "informer": {
        "id": "uuid-do-informer",
        "cpf": "11144477735",
        "phone": "(61) 98888-8888",
        "function": "Padre",
        "provision_candidate": "João Silva",
        "created_at": "2025-01-21T17:00:00.000000Z",
        "updated_at": "2025-01-21T17:00:00.000000Z",
        "treatment_pronoun": {
          "id": 1,
          "name": "Pe.",
          "description": "Padre"
        },
        "diocese": {
          "id": 1,
          "name": "Arquidiocese de Brasília",
          "state": "DF"
        },
        "group": {
          "id": "uuid-do-grupo",
          "name": "Grupo 1",
          "description": "Bispo em saída/transferido",
          "color": "#007bff"
        }
      }
    },
    "permissions": ["manage_users", "manage_roles", "manage_permissions"]
  }
}

Nota: O campo "informer" só aparece para usuários com o papel (role) de "Informer". Usuários com outros papéis (ex: Admin) não possuem este campo.
Novos campos: "img_url" (URL da foto de perfil), "initials" (iniciais do nome) e "cpf" (apenas para informadores, 11 dígitos numéricos com validação automática).

Erro - 401 (Token não fornecido)

{
  "success": false,
  "message": "Token não fornecido"
}

Condição: Token JWT não foi enviado no header Authorization

Erro - 401 (Token expirado)

{
  "success": false,
  "message": "Token expirado"
}

Condição: Token JWT expirado (TTL de 180 minutos excedido)

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token inválido"
}

Condição: Token JWT malformado ou com assinatura inválida

Códigos de Resposta

Código Descrição
200 Dados do usuário retornados com sucesso
401 Token não fornecido, inválido ou expirado