Gerenciamento de Funções (Roles)

Esta documentação descreve os endpoints disponíveis para a gestão de funções (roles) atribuíveis aos usuários.

📌 Visão Geral

• Prefixo de Rota: /api/manager/guard
• Autenticação: Requerida (Bearer Token - Laravel Sanctum)
• Headers Necessários:
  • Accept: application/json
  • Content-Type: application/json
  • X-Account-Id: ID da conta ativa

---

🛡️ Endpoints de Funções (RolesController)

1. Listar Roles Disponíveis

Retorna uma lista paginada das funções (roles) que podem ser atribuídas a novos usuários. O sistema filtra automaticamente funções administrativas e internas.

• Método: GET
• Rota: /roles
• Autenticação: Sim

🟢 Resposta de Sucesso (200 OK)

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "name": "Financeiro",
      "guard_name": "api",
      "created_at": "2024-02-23T10:00:00.000000Z",
      "updated_at": "2024-02-23T10:00:00.000000Z",
      "permissions": [
        {
          "id": 10,
          "name": "view invoices",
          "guard_name": "api"
        }
      ]
    }
  ],
  "first_page_url": "...",
  "from": 1,
  "last_page": 1,
  "last_page_url": "...",
  "next_page_url": null,
  "path": "...",
  "per_page": 15,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}

---

❌ Respostas de Erro

401 Unauthorized (Não Autorizado)

Token ausente ou inválido.

{
  "message": "Unauthenticated."
}

403 Forbidden (Proibido)

Usuário sem permissão para acessar a gestão de roles.

{
  "message": "This action is unauthorized."
}

500 Internal Server Error (Erro Interno)

Erro inesperado no servidor.

{
  "code": 500,
  "message": "Ocorreu um erro. Processo não concluído.",
  "success": false,
  "data": "Mensagem detalhada do erro."
}