API atual/Referência completa/Conta do administrador

Catálogo de privilégios

Lista todos os privilégios que um grupo de usuários pode receber e completa o catálogo com os padrões.

O catálogo de privilégios é a lista de tudo o que um grupo de usuários pode receber. Ele é lido para montar telas de permissão e para validar nomes antes de gravar um grupo. Para ver o que você pode, use Minha conta.

GET/api/v1/admin/privilegesAdmin

Exige o privilégio manage_usergroups. Não é paginada: devolve o catálogo inteiro (centenas de itens).

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/privileges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Catálogo

json

{
  "privileges": [
    {
      "privilege": "view_orders",
      "section_id": "orders",
      "group_id": "orders",
      "is_view": true,
      "is_default": false
    },
    {
      "privilege": "manage_incentives",
      "section_id": "marketing",
      "group_id": "incentives",
      "is_view": false,
      "is_default": false,
      "module_slug": "incentive-program"
    }
  ],
  "total": 248
}

Campos da resposta

privilegesobject[]

Os privilégios do catálogo.

privileges[].privilegestring

Nome do privilégio, o valor que aparece em me/privileges e nos grupos.

privileges[].section_idstring

Seção do painel em que o privilégio é mostrado.

privileges[].group_idstring

Agrupamento dentro da seção.

privileges[].is_viewboolean

true para privilégios apenas de leitura (view_*).

privileges[].is_defaultboolean

true quando o privilégio vem marcado por padrão em um grupo novo.

privileges[].module_slugstring

Módulo que precisa estar ligado para o privilégio ter efeito. Ausente quando não depende de módulo.

privileges[].riskstring

Classe de risco, quando o privilégio tem uma. Ausente nos demais.

totalinteger

Quantidade de itens em privileges.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio `manage_usergroups`.	`{"error":"insufficient privileges","required":"manage_usergroups"}`
500	Falha ao ler o catálogo.	`{"error":"failed to list privileges","detail":"..."}`

POST/api/v1/admin/privileges/seed-defaultsAdmin

Completar o catálogo de privilégios

Insere no catálogo da loja os privilégios padrão da plataforma que ainda não existem. É idempotente: privilégios que já estão lá não são alterados, então personalizações ficam intactas. Exige manage_usergroups, não recebe corpo e tem limite de 25 segundos.

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/privileges/seed-defaults" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Semeadura concluída

json

{
  "inserted": 0,
  "total": 248,
  "skipped": false
}

Campos da resposta

insertedinteger

Privilégios novos inseridos nesta chamada.

totalinteger

Tamanho do catálogo padrão da plataforma.

skippedboolean

true quando nada foi feito. Nesse caso message explica.

messagestring

Explicação, presente só quando skipped é true.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio `manage_usergroups`.	`{"error":"insufficient privileges","required":"manage_usergroups"}`
500	Falha ou tempo esgotado ao semear.	`{"error":"failed to seed default privileges","detail":"..."}`

Veja também

Catálogo de privilégios

Lista todos os privilégios que um grupo de usuários pode receber e completa o catálogo com os padrões.

GET/api/v1/admin/privilegesAdmin

Catálogo de privilégios

Exige o privilégio manage_usergroups. Não é paginada: devolve o catálogo inteiro (centenas de itens).

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/privileges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Catálogo

json

{
  "privileges": [
    {
      "privilege": "view_orders",
      "section_id": "orders",
      "group_id": "orders",
      "is_view": true,
      "is_default": false
    },
    {
      "privilege": "manage_incentives",
      "section_id": "marketing",
      "group_id": "incentives",
      "is_view": false,
      "is_default": false,
      "module_slug": "incentive-program"
    }
  ],
  "total": 248
}

Campos da resposta

privilegesobject[]

Os privilégios do catálogo.

privileges[].privilegestring

Nome do privilégio, o valor que aparece em me/privileges e nos grupos.

privileges[].section_idstring

Seção do painel em que o privilégio é mostrado.

privileges[].group_idstring

Agrupamento dentro da seção.

privileges[].is_viewboolean

true para privilégios apenas de leitura (view_*).

privileges[].is_defaultboolean

true quando o privilégio vem marcado por padrão em um grupo novo.

privileges[].module_slugstring

Módulo que precisa estar ligado para o privilégio ter efeito. Ausente quando não depende de módulo.

privileges[].riskstring

Classe de risco, quando o privilégio tem uma. Ausente nos demais.

totalinteger

Quantidade de itens em privileges.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio `manage_usergroups`.	`{"error":"insufficient privileges","required":"manage_usergroups"}`
500	Falha ao ler o catálogo.	`{"error":"failed to list privileges","detail":"..."}`

POST/api/v1/admin/privileges/seed-defaultsAdmin

Completar o catálogo de privilégios

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário (veja Tokens).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/privileges/seed-defaults" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Semeadura concluída

json

{
  "inserted": 0,
  "total": 248,
  "skipped": false
}

Campos da resposta

insertedinteger

Privilégios novos inseridos nesta chamada.

totalinteger

Tamanho do catálogo padrão da plataforma.

skippedboolean

true quando nada foi feito. Nesse caso message explica.

messagestring

Explicação, presente só quando skipped é true.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio `manage_usergroups`.	`{"error":"insufficient privileges","required":"manage_usergroups"}`
500	Falha ou tempo esgotado ao semear.	`{"error":"failed to seed default privileges","detail":"..."}`