auditeventsep

package
v1.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuditEventSvcConfig

type AuditEventSvcConfig struct {
	// AuditClient (required) is the platform-service audit gRPC client.
	AuditClient pb.AuditServiceClient
}

type ListAuditEventResourceTypesEndpoint

type ListAuditEventResourceTypesEndpoint struct{}

Returns every resource type an audit event can refer to, as plain strings.

This is the accepted vocabulary for the `resource_types` filter when listing audit events. It is the API's complete resource-type list rather than a list derived from your account's data, so it includes types you may never have recorded events for.

type ListAuditEventResourceTypesRequest

type ListAuditEventResourceTypesRequest struct{}

Request to list the valid audit event resource types.

type ListAuditEventsEndpoint

type ListAuditEventsEndpoint struct{}

Returns a paginated list of audit events, newest first.

Results cover every change where your account is either the acting account or the account that was acted upon, so a customer's or supplier's changes to your records appear alongside your own. The `q` parameter searches the resource type, action, resource ID, and originating request ID.

type ListAuditEventsRequest

type ListAuditEventsRequest struct {
	apiresource.PaginationRequest
	// Restricts results to audit events on or after this timestamp.
	StartDate *time.Time `query:"starts_at"`
	// Restricts results to audit events on or before this timestamp.
	EndDate *time.Time `query:"ends_at"`
	// Filter by the resource type of the audited entity.
	//
	// The full set of valid values is available from the List Audit Event Resource Types endpoint.
	ResourceTypes []constants.ObjectType `query:"resource_types"`
	// Filter by the audited resource IDs.
	ResourceIDs []string `query:"resource_ids"`
	// Scope results to a root record's entire history tree.
	//
	// Returns every event whose root resource matches, covering the root record itself and all of its descendants — for example a sales order together with its lines, picks, shipments, and invoices. Both `root_resource_type` and `root_resource_id` must be supplied together; supplying only one has no effect.
	RootResourceType *constants.ObjectType `query:"root_resource_type"`
	// ID of the root record whose history tree to return.
	//
	// Only applied when paired with `root_resource_type`.
	RootResourceID *string `query:"root_resource_id"`
	// Filter by the actor identifier.
	//
	// Matches the event's `actor.id`: a user ID for `user` actors, an API key ID for `api_key` actors, or an agent ID for `agent` actors.
	ActorIDs []string `query:"actor_ids"`
	// Filter by the actor type.
	//
	// Events are recorded for actors of type `user`, `api_key`, and `agent` — the last covering changes an OpenMRP agent made on your account's behalf.
	ActorTypes []constants.ActorType `query:"actor_types"`
	// Filter by the mutation type recorded on the event.
	Actions []constants.AuditAction `query:"actions"`
	// Filter by the _acting_ account: the account that performed the mutation.
	//
	// Results are always scoped to events where your account is either the acting account or the target account; this narrows that set to specific acting accounts — for example a specific customer's account that mutated a resource on your account.
	ActorAccountIDs []string `query:"actor_account_ids"`
	// Filter by the _target_ account the mutation was performed against (the event's `account`).
	//
	// Results are always scoped to events where your account is either the acting account or the target account; this narrows that set to specific target accounts — for example a specific customer's or supplier's account.
	TargetAccountIDs []string `query:"target_account_ids"`
}

Request to list audit events.

type RetrieveAuditEventEndpoint

type RetrieveAuditEventEndpoint struct{}

Returns a single audit event by ID.

The event is readable when your account is either the acting account or the account that was acted upon.

func (*RetrieveAuditEventEndpoint) Materialize

type RetrieveAuditEventRequest

type RetrieveAuditEventRequest struct {
	// Audit event ID.
	ID string `path:"id" validate:"required"`
}

Request to retrieve an audit event.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL