Grupos de acesso

Grupos de acesso definem perfis de uso do sistema, como Comercial, Financeiro ou Instrutor. Corresponde à tela Grupos de acesso do módulo Administrativo. Cada grupo escolhe as páginas que os seus usuários podem abrir e, em cada página, o nível de permissão. Cada usuário pertence a um único grupo.

Um grupo tem dois sub-recursos, cada um em sua página:

• Controles de acesso: as páginas liberadas ao grupo e o nível de cada uma.
• Usuários do grupo: os usuários que pertencem ao grupo.

Endpoints

Método	Caminho	Descrição
GET	/administrative/access-groups	Lista os grupos de acesso
POST	/administrative/access-groups	Cadastra um grupo de acesso
GET	/administrative/access-groups/{uuid}	Consulta um grupo de acesso
PUT	/administrative/access-groups/{uuid}	Altera o nome de um grupo de acesso
DELETE	/administrative/access-groups/{uuid}	Apaga um grupo de acesso
GET	/administrative/access-groups/controllers	Lista de apoio: páginas do pacote contratado
GET	/administrative/access-groups/permissions	Lista de apoio: níveis de permissão
GET	/administrative/access-groups/departments	Lista de apoio: departamentos
GET	/administrative/access-groups/{access_group_uuid}/controllers	Controles de acesso: lista as páginas do grupo
POST	/administrative/access-groups/{access_group_uuid}/controllers	Controles de acesso: libera uma página ao grupo
GET	/administrative/access-groups/{access_group_uuid}/controllers/{id}	Controles de acesso: consulta uma página do grupo
PUT	/administrative/access-groups/{access_group_uuid}/controllers/{id}	Controles de acesso: altera a página do grupo
DELETE	/administrative/access-groups/{access_group_uuid}/controllers/{id}	Controles de acesso: remove a página do grupo
GET	/administrative/access-groups/{access_group_uuid}/users	Usuários do grupo: lista os usuários do grupo
POST	/administrative/access-groups/{access_group_uuid}/users	Usuários do grupo: cadastra um usuário no grupo
PUT	/administrative/access-groups/{access_group_uuid}/users/{uuid}	Usuários do grupo: altera um usuário do grupo

GET /administrative/access-groups

Lista os grupos de acesso do cliente, em ordem alfabética, salvo se columnName e orderData forem informados.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre: busca pelo nome do grupo e pelo nome ou e-mail de seus usuários
columnName	Coluna para ordenar
orderData	Sentido da ordenação: asc ou desc
per_page	Quantidade de registros por página
page	Número da página, quando per_page é informado

Resposta (200): lista de grupos, direta ou paginada. Campos principais: uuid, access_group e user_update_name.

Exemplo:

curl https://api.pedagogo.app/administrative/access-groups \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /administrative/access-groups

Cadastra um grupo de acesso. O grupo começa sem páginas liberadas: as páginas são adicionadas pelo sub-recurso Controles de acesso.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
access_group	Sim	Texto	Nome do grupo, por exemplo Comercial ou Financeiro

Resposta (201): o grupo criado, com o uuid.

Exemplo:

curl -X POST https://api.pedagogo.app/administrative/access-groups \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -H "Content-Type: application/json" \
  -d '{"access_group": "Grupo exemplo"}'

GET /administrative/access-groups/{uuid}

Devolve um grupo de acesso pelo uuid.

PUT /administrative/access-groups/{uuid}

Altera o nome do grupo.

Corpo (JSON)

Campo	Obrigatório	Tipo	Descrição
access_group	Sim	Texto	Novo nome do grupo

Resposta (200): o grupo alterado.

DELETE /administrative/access-groups/{uuid}

Apaga o grupo de acesso. A exclusão é lógica e não move os usuários do grupo para outro. Antes de apagar, troque o grupo dos usuários pela página Usuários.

Resposta (200): sem conteúdo relevante (null).

Listas de apoio

Os endpoints abaixo alimentam as telas de controles de acesso e de usuários.

GET /administrative/access-groups/controllers

Lista as páginas do sistema incluídas no pacote contratado pelo cliente. Use o campo id de cada página como controller_id em Controles de acesso.

Resposta (200): lista de páginas, agrupadas por módulo. Campos principais: id, controller (nome da página), module (nome do módulo), url e order.

GET /administrative/access-groups/permissions

Lista os níveis de permissão que podem ser aplicados a uma página do grupo. Use o campo id de cada nível como permission_id em Controles de acesso.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre que busca no nome do nível
per_page	Quantidade de registros por página
page	Número da página, quando per_page é informado

Resposta (200): lista de níveis, com os campos id e permission.

GET /administrative/access-groups/departments

Lista os departamentos do cliente. Devolve a mesma resposta de GET /administrative/departments, descrita na página Departamentos.