auditlog.get

Descrição

integer/array auditlog.get(object parameters)

O método permite recuperar registros de log de auditoria de acordo com o dado parâmetros.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Ver Do utilizador funções Para maiores informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método oferece suporte aos seguintes parâmetros.

Parâmetro Tipo Descrição
auditids string/array Retorna apenas o log de auditoria com os IDs fornecidos.
userids string/array Retorna apenas o log de auditoria que foi criado pelos usuários fornecidos.
time_from timestamp Retorna apenas as entradas de log de auditoria que foram criadas após ou em determinado momento.
time_till timestamp Retorna apenas as entradas de log de auditoria que foram criadas antes ou em determinado momento.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: auditid, userid, clock.
filter object Retorna apenas os resultados que correspondem exatamente ao filtro fornecido.

Aceita uma matriz, em que as chaves são nomes de propriedades e os valores são um valor único ou uma matriz de valores para correspondência.< br>
Suporta adicionalmente a filtragem por campos de propriedade de detalhes: table_name, field_name.
pesquisa objeto Pesquisa de substring sem distinção entre maiúsculas e minúsculas no conteúdo dos campos: username, ip, resourcename, details.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos no comentário de referência.
excludePesquisa boolean
limite inteiro
saída consulta
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
ordem de classificação cadeia/matriz
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • uma matriz de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperar log de auditoria

Recupera os dois últimos registros do log de auditoria.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "auditlog.get",
    "params": {
        "output": "extend",
        "sortfield": "clock",
        "sortorder": "DESC",
        "limit": 2
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "auditid": "cksstgfam0001yhdcc41y20q2",
            "userid": "1",
            "username": "Admin",
            "clock": "1629975715",
            "ip": "127.0.0.1",
            "action": "1",
            "resourcetype": "0",
            "resourceid": "0",
            "resourcename": "Jim",
            "recordsetid": "cksstgfal0000yhdcso67ondl",
            "details": "{\"user.name\":[\"update\",\"Jim\",\"\"],\"user.medias[37]\":[\"add\"],\"user.medias[37].\":[\"add\"],\"user.medias[37].mediatypeid\":[\"add\",\"1\"],\"user.medias[37].sendto\":[\"add\",\"[email protected]\"]}"

        },
        {
            "auditid": "ckssofl0p0001yhdcqxclsg8r",
            "userid": "1",
            "username": "Admin",
            "clock": "1629967278",
            "ip": "127.0.0.1",
            "action": "0",
            "resourcetype": "0",
            "resourceid": "20",
            "resourcename": "John",
            "recordsetid": "ckssofl0p0000yhdcpxyo1jgo",
            "details": "{\"user.username\":[\"add\",\"John\"], \"user.userid:\":[\"add\",\"20\"],\"user.usrgrps[28]\":[\"add\"],\"user.usrgrps[28].usrgrpid\":[\"add\", \"7\"]}"
        }
    ],
    "id": 1
}

Veja também

Fonte

CAuditLog::get() em ui/include/classes/api/services/CAuditLog.php.