Ir para o conteúdo principal
Adaptive Planning
Última atualização: 2023-06-23
exportSecurityAudit

exportSecurityAudit

Com suporte na API v20 +
Categoria
Recuperação de dados
Descrição
Retorna um relatório de todos os eventos de segurança em um intervalo de tempo especificado, filtrável por tipo de evento. Os eventos de segurança incluem tentativas malsucedidas de logon, alterações de senha, bloqueio de conta, criação de conta e outras informações relacionadas à segurança. Se nenhum intervalo de tempo é solicitado, todos os eventos das últimas 24 horas são retornados. Os eventos de segurança registrados pelo registro de auditoria são baseados no NIST 800-53. O Adaptive Planning mantém apenas 30 dias de dados de auditoria de segurança.
Permissões obrigatórias para invocar
Administrador
Parâmetros obrigatórios na solicitação
Credenciais
A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada, e uma etiqueta de inclusão que identifica o agente e o intervalo de tempo para os quais recuperar eventos de segurança. Uma vez verificado, o método retorna um documento XML que descreve todos os eventos de segurança no intervalo de tempo especificado, que pode ser filtrado por tipo de evento.

Formato da solicitação

<?xml version='1.0' encoding='UTF-8'?> <call method="exportSecurityAudit" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include actor="stevec@greenco.com" dateTimeFrom="2019-07-30 00:00:00" dateTimeTo="2019-07-30 11:59:59"/> </call>
elemento de credenciais
Nome da etiqueta
credenciais
Descrição
Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
login
S
O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.
sampleuser@company.com
senha
S
A senha do usuário que invoca o método de API.
my_password
Conteúdo do elemento
nenhum
incluir elemento
Nome da etiqueta
incluir
Descrição
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
agente
N
O nome de usuário cujos eventos de segurança você quer recuperar. Retorna eventos para todos os usuários quando o agente não está incluído.
stevec@greenco.com
dateTimeFrom
N
O início do intervalo de tempo no formato compatível com ISO-8601 (
YYYY-MM-DDTHH:MM:SS
) em UTC para os eventos de segurança que você quer recuperar.
2019-07-30 00:00:00
dateTimeTo
N
O fim do intervalo de tempo no formato compatível com ISO-8601 (
YYYY-MM-DDTHH:MM:SS
) em UTC para os eventos de segurança que você quer recuperar.
2019-07-30 11:59:59
Conteúdo do elemento
nenhum

Formato da resposta

<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <audit> <event timestamp="2019-07-30 01:59:48.7781" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 01:59:48.9822" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:01:29.115" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:02:03.0594" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:35.8937" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:36.0589" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:36.1219" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:59.8724" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:07:36.5505" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:07:37.8862" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:08:06.7037" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:08:10.4557" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:08:14.8878" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> </audit> </output> </response>
elemento de resposta
Nome da etiqueta
resposta
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
êxito
S
Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta.
verdadeiro
obsoleto
N
Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta por
Adaptive Planning
. Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente.
false
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.
elemento de saída
Nome da etiqueta
saída
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um único elemento de auditoria Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida.
elemento de auditoria
Nome da etiqueta
auditoria
Descrição
Uma coleção de eventos de segurança.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de evento.
elemento de evento
Nome da etiqueta
evento
Descrição
Um evento de segurança
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
timestamp
S
A data e hora no formato compatível com ISO-8601 (
YYYY-MM-DDTHH:MM:SS.sssZ
) no UTC do evento
30-07-2019 01:59:48.7781
ação
S
A ação que acionou o evento de auditoria:
  • Criação de conta "CRE"
  • Conta "DIS" desabilitada
  • Bloqueio de conta "LOK"
  • Desbloqueio de conta "UOK"
  • Conexão "USC" malsucedida
  • "SUC" logon concluído com êxito
  • Logout do usuário "ULO"
  • Alteração de senha do usuário "PWC"
  • Encerramento da sessão "TER" devido a exceções
  • Término da sessão "EXP"
  • Alterações de credenciais "CRD"
  • Alterações "AUTO" na configuração de autenticação
SUC
agente
S
GUID do agente (serviço, usuário, usuário do sistema) que iniciou a operação que aciona o evento (NULL se nenhum usuário específico puder ser atribuído).
Você pode recuperar nomes de usuário atuais por GUID nos resultados de uma exportUsers chamada.
475245454E434F000000000001000004
versão
S
A versão do software usada para executar a ação.
21
interface
N
A interface (API, UI ou URI) que aciona o evento de auditoria.
API
objeto
N
O objeto do sistema que aciona o evento de auditoria.
User - 475245454E434F000000000001000004
resultado
S
O êxito ou a falha da ação. 0 indica êxito, 1 indica falha.
0
contexto
N
Informações específicas do sistema sobre o evento de auditoria.
Conteúdo do elemento
(nenhum)