Trilha de auditoria da organização

Consulte o registro de atividades somente para inclusão da organização — quem fez o quê, e quando, em toda a organização.

A trilha de auditoria é um registro somente para inclusão de ações significativas realizadas dentro da organização: rotações de chaves, alterações de membros, edições de roteamento e muito mais. Esses endpoints alimentam a tela de auditoria do Dashboard.

As entradas nunca são editadas ou excluídas, o que é o que torna a trilha confiável para conformidade e revisão de incidentes. Filtre por ator, ação ou janela de tempo para reconstruir exatamente o que aconteceu.

Esses endpoints alimentam a interface do Tokeflow Dashboard no nível da organização. Eles são autenticados por sessão (JWT bearer) — o token vem do login no Dashboard, não de uma chave de API sk_/pk_. As solicitações também carregam o header x-organization-id, e o usuário autenticado deve ser membro dessa organização.


Endpoints

GET/api/v1/org/audit-trail

Org

Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.

Lista as entradas da trilha de auditoria da organização.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
entity_typestringNãoFiltra por tipo de entidade (por exemplo, merchant, merchant_connector, routing_profile, api_key)
actionstringNãoFiltra por ação (por exemplo, created, updated, deleted, activated, deactivated)
actor_idstringNãoFiltra por ID do ator (usuário ou chave de API)
merchant_idstringNãoRestringe a trilha da organização a um único merchant. O escopo da organização ainda se aplica, portanto um merchant fora dele não corresponde a nada.
start_datestringNãoFiltra a partir desta data (formato ISO 8601)
end_datestringNãoFiltra até esta data (formato ISO 8601)
limitnumberNãoNúmero de registros a retornar. Padrão 20, mín. 1, máx. 100.
offsetnumberNãoNúmero de registros a pular. Padrão 0, mín. 0.

Exemplo de solicitação

curl -G https://api.tokeflow.com/api/v1/org/audit-trail \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "entity_type=merchant_connector" \
  --data-urlencode "action=created" \
  --data-urlencode "actor_id=string" \
  --data-urlencode "merchant_id=mrc_1"

GET/api/v1/org/audit-trail/merchant

Org

Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.

Lista as entradas da trilha de auditoria do merchant selecionado.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
entity_typestringNãoFiltra por tipo de entidade (por exemplo, merchant, merchant_connector, routing_profile, api_key)
actionstringNãoFiltra por ação (por exemplo, created, updated, deleted, activated, deactivated)
actor_idstringNãoFiltra por ID do ator (usuário ou chave de API)
merchant_idstringNãoRestringe a trilha da organização a um único merchant. O escopo da organização ainda se aplica, portanto um merchant fora dele não corresponde a nada.
start_datestringNãoFiltra a partir desta data (formato ISO 8601)
end_datestringNãoFiltra até esta data (formato ISO 8601)
limitnumberNãoNúmero de registros a retornar. Padrão 20, mín. 1, máx. 100.
offsetnumberNãoNúmero de registros a pular. Padrão 0, mín. 0.

Exemplo de solicitação

curl -G https://api.tokeflow.com/api/v1/org/audit-trail/merchant \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "entity_type=merchant_connector" \
  --data-urlencode "action=created" \
  --data-urlencode "actor_id=string" \
  --data-urlencode "merchant_id=mrc_1"

Erros

Os erros usam o envelope padrão. Os casos mais comuns aqui:

HTTPSignificado
400Parâmetros inválidos ou um estado que não permite esta operação.
401Token de sessão do Dashboard ausente, expirado ou inválido.
403Autenticado, mas o usuário autenticado não tem acesso a esta entidade.
404O registro não existe ou não é visível para esta entidade.

Relacionados

Nesta página