Auditoria

Registro de eventos da instituição, com estatísticas e exportação.

Lista eventos de auditoria da instituição

GET /auditoria

Acesso: Exige a capacidade ADMINISTRAR, em algum escopo (a resposta traz só o que a pessoa pode ver). Status de sucesso: 200.

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
de	string	não	^\d{4}-\d{2}-\d{2}$	Data inicial da janela (AAAA-MM-DD), inclusive.
ate	string	não	^\d{4}-\d{2}-\d{2}$	Data final da janela (AAAA-MM-DD), inclusive.
acao	string	não	^[a-z][a-z0-9_.]{0,59}$	Filtra pelo tipo de evento (ex.: presenca.confirmada).
instituicaoId	string (uuid)	não		Id da instituição.
atorId	string (uuid)	não		Filtra pelos eventos feitos por esta pessoa.
fuso	string	não	1–64 caracteres	Fuso horário IANA para agrupar por dia (ex.: America/Sao_Paulo).
cursor	string	não	a 200 caracteres; ^[A-Za-z0-9_-]+$	Cursor devolvido pela página anterior.
limite	integer	não	1…100; padrão: 50	Quantos itens por página (1 a 200; o padrão varia por rota, em geral 50).

Resposta

AuditoriaPagina

Campo	Tipo	Obrigatório	Restrições	Descrição
items	lista de AuditoriaItem	sim
proximo	string ou nulo	sim

Em caso de erro: modelo ErroApi.

Exemplo

curl -X GET "$API/auditoria" -H "Authorization: Bearer $TOKEN"

---

Estatísticas dos eventos de auditoria

GET /auditoria/estatisticas

Acesso: Exige a capacidade ADMINISTRAR, em algum escopo (a resposta traz só o que a pessoa pode ver). Status de sucesso: 200.

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
de	string	não	^\d{4}-\d{2}-\d{2}$	Data inicial da janela (AAAA-MM-DD), inclusive.
ate	string	não	^\d{4}-\d{2}-\d{2}$	Data final da janela (AAAA-MM-DD), inclusive.
acao	string	não	^[a-z][a-z0-9_.]{0,59}$	Filtra pelo tipo de evento (ex.: presenca.confirmada).
instituicaoId	string (uuid)	não		Id da instituição.
atorId	string (uuid)	não		Filtra pelos eventos feitos por esta pessoa.
fuso	string	não	1–64 caracteres	Fuso horário IANA para agrupar por dia (ex.: America/Sao_Paulo).

Resposta

AuditoriaEstatisticas

Campo	Tipo	Obrigatório	Restrições	Descrição
de	Data	sim
ate	Data	sim
total	integer	sim	0…
porAcao	lista de object	sim
porAcao[].acao	string	sim
porAcao[].total	integer	sim	0…
porDia	lista de object	sim
porDia[].dia	Data	sim
porDia[].total	integer	sim	0…

Em caso de erro: modelo ErroApi.

Exemplo

curl -X GET "$API/auditoria/estatisticas" -H "Authorization: Bearer $TOKEN"

---

Exporta a auditoria em CSV

GET /auditoria/exportar

Acesso: Exige a capacidade ADMINISTRAR, em algum escopo (a resposta traz só o que a pessoa pode ver). Limite: até 10 chamadas a cada 60 s por origem. Status de sucesso: 200.

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Restrições	Descrição
de	string	não	^\d{4}-\d{2}-\d{2}$	Data inicial da janela (AAAA-MM-DD), inclusive.
ate	string	não	^\d{4}-\d{2}-\d{2}$	Data final da janela (AAAA-MM-DD), inclusive.
acao	string	não	^[a-z][a-z0-9_.]{0,59}$	Filtra pelo tipo de evento (ex.: presenca.confirmada).
instituicaoId	string (uuid)	não		Id da instituição.
atorId	string (uuid)	não		Filtra pelos eventos feitos por esta pessoa.
fuso	string	não	1–64 caracteres	Fuso horário IANA para agrupar por dia (ex.: America/Sao_Paulo).

Resposta

Arquivo CSV (text/csv).

Em caso de erro: modelo ErroApi.

Exemplo

curl -X GET "$API/auditoria/exportar" -H "Authorization: Bearer $TOKEN"

---