Pular para o conteúdo principal

kobana dashboards audit-logs

Comandos de kobana dashboards audit-logs. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
audit-logs summaryGET /v1/audit_logs/summaryResumo da atividade auditada
audit-logs listGET /v1/audit_logsListar registros de auditoria
audit-logs getGET /v1/audit_logs/{id}Consultar registro de auditoria

audit-logs summary​

Resumo da atividade auditada

kobana dashboards audit-logs summary [OPÇÕES]

GET /v1/audit_logs/summary

Atividade das últimas hours horas: total de registros, as 10 ações mais frequentes e os 20 registros mais recentes. Exige a permissão de exportar auditoria.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
hoursnumbernãoTamanho da janela em horas, de 1 a 8760. Padrão 24.

Cabeçalhos

NomeTipoObrigatórioDescrição
X-Workspace-IdstringnãoWorkspace em que a chamada atua: o id ou o public_id mostrados em Workspaces no dashboard. Dentro da organização do token, os dados ficam em workspaces. Pode ser omitido enquanto a organização tem um único workspace; com dois ou mais, a falta dele retorna 400 workspace_required. Um workspace que não é da organização retorna 403 unknown_workspace. Com um token de pessoa, só os workspaces a que ela tem acesso (proprietários da organização alcançam todos); os demais retornam 403 workspace_access_denied.

Respostas

HTTPDescrição
200Resumo da atividade.
400Requisição inválida: corpo malformado, campo obrigatório ausente ou filtro com valor inválido.
404Recurso não encontrado na organização atual.

audit-logs list​

Listar registros de auditoria

kobana dashboards audit-logs list [OPÇÕES]

GET /v1/audit_logs

Trilha de auditoria do workspace e da organização, do mais recente ao mais antigo. A trilha não pode ser alterada.

Parâmetros de consulta

NomeTipoObrigatórioDescrição
pageintegernãoPágina (começa em 1). Padrão: 1.
per_pageintegernãoItens por página. Padrão: 20. Máximo: 100.
sort_bystringnãoCampo de ordenação. Padrão depende do recurso.
sort_orderstringnãoDireção da ordenação. Padrão: desc. Valores: asc, desc.
user_idstringnãoIdentificador exato do usuário.
actionstringnãoAção exata (ex.: webhook.created).
resource_typestringnãoTipo exato do recurso (ex.: webhook).
resource_idstringnãoID exato do recurso.
searchstringnãoTrecho da ação, do tipo de recurso, do ID ou do e-mail do usuário, sem diferenciar maiúsculas.
date_fromstringnãoLimite inferior de created_at (data ou data-hora ISO 8601).
date_tostringnãoLimite superior de created_at (data ou data-hora ISO 8601). Uma data sem hora cobre o dia inteiro (UTC).

Cabeçalhos

NomeTipoObrigatórioDescrição
X-Workspace-IdstringnãoWorkspace em que a chamada atua: o id ou o public_id mostrados em Workspaces no dashboard. Dentro da organização do token, os dados ficam em workspaces. Pode ser omitido enquanto a organização tem um único workspace; com dois ou mais, a falta dele retorna 400 workspace_required. Um workspace que não é da organização retorna 403 unknown_workspace. Com um token de pessoa, só os workspaces a que ela tem acesso (proprietários da organização alcançam todos); os demais retornam 403 workspace_access_denied.

Respostas

HTTPDescrição
200Página de registros de auditoria.
400Requisição inválida: corpo malformado, campo obrigatório ausente ou filtro com valor inválido.
404Recurso não encontrado na organização atual.

audit-logs get​

Consultar registro de auditoria

kobana dashboards audit-logs get [ID] [OPÇÕES]

GET /v1/audit_logs/{id}

Retorna um registro de auditoria com valores anteriores e novos.

Argumentos do caminho: id

Cabeçalhos

NomeTipoObrigatórioDescrição
X-Workspace-IdstringnãoWorkspace em que a chamada atua: o id ou o public_id mostrados em Workspaces no dashboard. Dentro da organização do token, os dados ficam em workspaces. Pode ser omitido enquanto a organização tem um único workspace; com dois ou mais, a falta dele retorna 400 workspace_required. Um workspace que não é da organização retorna 403 unknown_workspace. Com um token de pessoa, só os workspaces a que ela tem acesso (proprietários da organização alcançam todos); os demais retornam 403 workspace_access_denied.

Respostas

HTTPDescrição
200O registro de auditoria.
404Recurso não encontrado na organização atual.