Aura.Model.HexAuditLog (Aura v0.9.0)

View Source

A struct describing a single auditable action from a Hex-compliant API.

Summary

Types

A short description of the action taken. (e.g "user.add", "key.generate")

A map of all the details of an audit_action/0

t()

Type describing an auditable action coming from a Hex-compliant API.

The User-Agent provided in the HTTP headers relevant to the audit_action/0

Functions

Builds a HexAuditLog from a map

Types

audit_action()

@type audit_action() :: String.t()

A short description of the action taken. (e.g "user.add", "key.generate")

audit_params()

@type audit_params() :: map()

A map of all the details of an audit_action/0

t()

@type t() :: %Aura.Model.HexAuditLog{
  action: audit_action(),
  params: audit_params(),
  user_agent: user_agent()
}

Type describing an auditable action coming from a Hex-compliant API.

🏷️ Keys

user_agent()

@type user_agent() :: String.t()

The User-Agent provided in the HTTP headers relevant to the audit_action/0

Functions

build(m)

@spec build(m :: map()) :: t()

Builds a HexAuditLog from a map