/webconsole - audit-log

Rest API Documentation

REST API Documentation for Group audit-log, application /webconsole Version: 4.2.1.2

Endpoints (DRAFT)

GET /rest/api/auditlog/exportLogs

Audit Logs Rest API, Export audit logs to CSV

Query Params:

  • fromDate [{'type': 'integer', 'format': 'int64'}]:
  • toDate [{'type': 'integer', 'format': 'int64'}]:
  • offset [{'type': 'integer', 'format': 'int32'}]:
  • doPurge [{'type': 'boolean'}]:
  • actions[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • result [{'type': 'string'}]:
  • showChildren [{'type': 'boolean'}]:
  • targetManagedSystems[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • targetOrganizations[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • targetResources[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • targetGroups[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • targetRoles[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:
  • targetUsers[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]:

Responses:

  • Status Code: 200 Success.

    Content-type: text/csv

  • Status Code: 404 Not Found.

  • Status Code: 500 Failure.

GET /rest/api/auditlog/findLogs

Audit Logs Rest API, Find Audit logs by search params

Query Params:

  • userId [{'type': 'string'}]: Requester User Id.

  • fromDate [{'type': 'integer', 'format': 'int64'}]: Limit result by time from the bottom. The value is the number of milliseconds from the beginning of epoch .

  • toDate [{'type': 'integer', 'format': 'int64'}]: Limit result by time from the top. The value is the number of milliseconds from the beginning of epoch .

  • from [{'type': 'integer', 'format': 'int32'}]: Offset of the search results.

  • size [{'type': 'integer', 'format': 'int32'}]: Size of the results page.

  • offset [{'type': 'integer', 'format': 'int32'}]: Timezone offset in offset minutes.

  • actions[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: The array of actions for search filter.

  • result [{'type': 'string'}]: The Result (SUCCESS/FAILURE) for search filter.

  • clientIP [{'type': 'string'}]: The Ip Addresses of requesters for search filter.

  • showChildren [{'type': 'boolean'}]: If 'false' will be shown only audit logs with empty parentId, otherwise all entities satisfied search filters.

  • allActions [{'type': 'boolean'}]: If 'true' userId param will be used as a target user as a requester Id. .

  • targetManagedSystems[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set Of target Managed System Ids.

  • targetOrganizations[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set Of target Organization Ids.

  • targetResources[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set Of target Resource Ids.

  • targetGroups[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set of target Group Ids.

  • targetRoles[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set of target Role Ids.

  • targetUsers[][{'uniqueItems': True, 'type': 'array', 'items': {'type': 'string'}}]: Set of target User Ids.

  • authProviderId [{'type': 'string'}]: Id of target Authentication Provider (for example for OAuth authorization).

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BeanResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BeanResponse

GET /rest/api/auditlog/get/(id)

Audit Logs Rest API, Get Audit Log Id

Path Params:

  • id [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/IdmAuditLogDoc

  • Status Code: 404 Not Found.

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/IdmAuditLogDoc

GET /rest/api/auditlog/get/(id)/children

Audit Logs Rest API, Get Audit Log Id

Query Params:

  • from [{'type': 'integer', 'format': 'int32'}]:
  • size [{'type': 'integer', 'format': 'int32'}]:

Path Params:

  • id [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BeanResponse

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BeanResponse

GET /rest/api/auditlog/get/(id)/children/docs

Audit Logs Rest API, Get Audit Log Children Docs

Query Params:

  • from [{'type': 'integer', 'format': 'int32'}]:
  • size [{'type': 'integer', 'format': 'int32'}]:

Path Params:

  • id [{'type': 'string'}]:

Responses:

  • Status Code: 200 Success.

    Content-type: application/json

  • Status Code: 500 Failure.

    Content-type: application/json

POST /rest/api/auditlog/sync/docs

Audit Logs Rest API, Get Audit Log Children Docs by multiple parent Ids

Responses:

  • Status Code: 200 Success.

    Content-type: application/json

  • Status Code: 500 Failure.

    Content-type: application/json## Definitions