Skip to content
Internal API Catalog
/
HPE GreenLake API for Audit Logs
/
Event Catalog
/
webhooks

Audit Log Events (1.0.0)

Download OpenAPI description
audit-trail-event.json
audit-trail-event.yaml
Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/audit-logs/public/catalog/audit-log-event-latest/audit-trail-event/

webhooks

Webhooks

Audit Log Created EventWebhook

Request

Triggered when an audit log event is created.

Event type—com.hpe.greenlake.audit-log.v1.logs.created

Bodyapplication/json
specversionstringrequired

The version of the CloudEvents specification the event adheres to.

Example: 1
idstring(uuid)required

The unique identifier for the event.

Example: "123e4567-e89b-12d3-a456-426614174000"
sourcestringrequired

The source field is a URI-reference that identifies the event producer.

Example: "Compute"
typestringrequired

The type of event.

Example: "AUDIT_LOGS"
subjectstringrequired
dataobject(AuditLog)required

The event payload.

data.​customer_idstringrequired

The platform customer ID or workspace ID.

Example: "1234567190abcdef1234567890abcdef"
data.​usernamestringrequired

Username of the user publishing the audit log event.

data.​app_slugstringrequired

A short and unique reference to an application resource.

Example: "COM"
data.​audit_infoobjectrequired
data.​audit_info.​usernamestring

The username of the user associated with the audit log.

data.​audit_info.​categorystring

Type of activity that was logged.

Example: "User Management"
data.​audit_info.​customer_namestring

The workspace name or customer name.

Example: "Sasha's Workspace"
data.​audit_info.​account_typestring

The type of HPE GreenLake account such as standalone, MSP, or tenant.

Example: "MSP"
data.​audit_info.​msp_idstring

The unique identifier of a managed service provider (MSP).

Example: "5434567890abcdef1234567890abcdef"
data.​audit_info.​audit_created_atstring

The date and time the audit log was created.

Example: "2023-10-01T12:00:00Z"
data.​audit_info.​additional_infoobject

Additional information related to the audit log event or the application.

Example: {"ip_address":"171.217.21.14"}
data.​audit_info.​has_detailsboolean

If set to true, the audit_details property is available for the audit log. This enables the UI to display the audit log details in the side panel.

data.​app_instance_idstring

The unique identifier of a specific application. Generated by HPE GreenLake.

Example: "3f8e1b2-1234-5678-90ab-cdef12345678"
data.​application_customer_idstring

This is the unique identifier of the customer associated with the application.

Example: null
data.​audit_detailsobject

Additional details associated with the audit log.

Example: {"header":"value","body":"value"}
data.​enable_streamingstring

Indicates whether streaming is enabled for the audit log.

Example: "true or false"
data.​created_atstring

The date and time the audit log was created in RFC 3339 format.

timestring(date-time)

The date and time the event occurred in RFC 3339 format.

Example: "2023-10-01T12:00:00Z"
dataschemastring

A URI pointing to the data property schema.

datacontenttypestring

The encoding of the data in the data property in RFC 2046 format.