Pular para o conteúdo principal

Listar Funções (Roles)

Uma Role representa um conjunto de permissões associadas a usuários ou entidades dentro do sistema. As funções determinam as ações que esses usuários podem realizar, oferecendo uma maneira de gerenciar o acesso e as capacidades de acordo com suas responsabilidades. Cada função pode ser atribuída a um Corban específico e configurada com permissões variadas, de modo a personalizar a experiência e o nível de acesso dos usuários.

Endpoint para Listar Roles​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/role

Exemplo de Requisição com curl para Listar Roles​

curl -X GET https://bff-dev.granatech.com.br/api/role

Estrutura da Resposta​

A resposta é um array de objetos Role, onde cada item representa uma função com suas permissões e informações relacionadas. Abaixo está a estrutura típica da resposta:

[
  {
    "id": "a64d4c56-c2653-4e70-b0ce-afdc5dadacf2",
    "name": "VENDEDOR",
    "permissions": ["READ"],
    "corbanId": 1,
    "createdAt": "2024-11-15T15:00:00.000Z"
  },
  {
    "id": "role124",
    "name": "SUPERVISOR",
    "permissions": ["READ", "FINANCIAL", "WRITE_PROPOSAL"],
    "corbanId": 2,
    "createdAt": "2024-11-16T09:30:00.000Z"
  }
]

Campos do Objeto Role​

  • id (string): Identificador único da função.
  • name (string): Nome da função, que descreve seu propósito.
  • permissions (array de PermissionEnum): Lista de permissões atribuídas à função.
  • corbanId (number, opcional): ID do Corban ao qual a função pertence, se aplicável.
  • createdAt (string, formato ISO): Data e hora de criação da função.

Observações​

  1. Estrutura da Permissão: Cada função inclui um conjunto de permissões específicas (permissions), que definem as ações permitidas para a função.
  2. Filtro por corbanId: Se necessário, é possível filtrar ou agrupar as funções pelo corbanId, identificando as funções atribuídas a cada Corban específico.

Esse endpoint fornece uma visão abrangente das funções e permissões disponíveis no sistema, facilitando o gerenciamento de permissões e acesso dos usuários.