Jump to

• Request
• Response

Get all audit entries

get

https://{your_site_interface}/opa-hub/api/12.2.39/audit-entries

This operation will get all audit entries.

Request

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : auditEntries

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/auditEntry"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object auditEntry

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/auditEntry"
    }
}

Nested Schema : auditEntry

Type: object

Show Source

• auditDateTime: string (date-time)
  Read Only: true

  The date and time when the event or operation was performed and audited.
• auditId: integer (int64)
  Read Only: true

  The value that uniquely identifies an audit entry.
• authenticationId: integer (int64)
  Read Only: true

  The ID of the user or API client who performed the operation.
• authenticationName: string
  Read Only: true

  The name of the user or API client who performed the operation.
• description: string
  Read Only: true

  The description of the event or operation that occurred.
• details: string
  Read Only: true

  The value contains additional information about the object that was operated in JSON format.
• objectId: integer (int64)
  Read Only: true

  The value that identifies the object that was operated.
• objectType: string
  Read Only: true

  The type of the object that was operated.
• operation: string
  Read Only: true

  The operation performed on the object.
• outcome: boolean
  Read Only: true

  The value is true if the operation was successful, otherwise, false.

{
    "type":"object",
    "properties":{
        "auditId":{
            "type":"integer",
            "format":"int64",
            "description":"The value that uniquely identifies an audit entry.",
            "readOnly":true
        },
        "auditDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the event or operation was performed and audited.",
            "readOnly":true
        },
        "authenticationId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the user or API client who performed the operation.",
            "readOnly":true
        },
        "authenticationName":{
            "type":"string",
            "description":"The name of the user or API client who performed the operation.",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"The description of the event or operation that occurred.",
            "readOnly":true
        },
        "objectType":{
            "type":"string",
            "description":"The type of the object that was operated.",
            "readOnly":true
        },
        "objectId":{
            "type":"integer",
            "format":"int64",
            "description":"The value that identifies the object that was operated.",
            "readOnly":true
        },
        "operation":{
            "type":"string",
            "description":"The operation performed on the object.",
            "readOnly":true
        },
        "outcome":{
            "type":"boolean",
            "description":"The value is true if the operation was successful, otherwise, false.",
            "readOnly":true
        },
        "details":{
            "type":"string",
            "description":"The value contains additional information about the object that was operated in JSON format.",
            "readOnly":true
        }
    },
    "additionalProperties":false
}

Back to Top