Audit event reference
This topic provides a detailed description of the events generated by the Conjur audit service.
Unauthenticated requests to endpoints that require authentication do not generate an audit event. |
Login
A Login event is generated when logging in with a username and password using HTTP basic authentication to retrieve an API key.
API endpoint
-
Login -
GET /authn/{account}/login
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Authenticate
An Authenticate event is generated when:
-
A user or host authenticates to retrieve a short-lived access token (with an API key or OIDC).
-
A Kubernetes authenticator injects a client certificate into a Pod.
-
An authentication request is made with invalid credentials.
API endpoints
The Conjur audit service supports all authentication methods. Authentication requests typically append /authenticate
to the server URL, as shown in the following examples:
-
Authenticate -
POST /authn/{account}/{login}/authenticate
-
OIDC Authenticator -
POST /authn-oidc/{service-id}/{account}/authenticate
-
Azure Authenticator -
POST https://<-server-hostname>/authn-azure/<service-id>/<account>/<host-id>/authenticate
-
GCP Authenticator -
POST https://<-server-hostname>/authn-gcp/<account>/authenticate
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Validate authenticator status
A Validate Authenticator Status event is generated when a user or host queries an authenticator for its availability status.
API endpoint
-
Validate Status -
GET /{authenticator-type/{service-id}/{account}/status
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Change password
A Change Password event is generated when a user changes or attempts to change their password.
API endpoint
-
Change password -
PUT /authn/{account}/password
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Rotate API key
A Rotate API Key event is generated when a role rotates its own API key, or a user rotates the API key for another role.
API endpoints
-
Rotate Personal API Key -
PUT /authn/{account}/api_key
-
Rotate Another Role's API Key -
PUT /authn/{account}/api_key?role={kind}:{identifier}
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Check permission
A Check Permission event is generated when a request is made to check whether a policy role can perform some action (read, execute, etc.) on a policy resource.
API endpoints
-
Check permission -
GET /resources/{account}/{kind}/{identifier}?check=true&role={role}&privilege={privilege}
Structured data
Data Element |
Values |
---|---|
|
|
|
NA |
|
|
|
|
Policy add
A Policy Add event is generated when a policy is loaded for each new resource that is created.
API endpoints
-
Replace a Policy -
PUT /policies/{account}/policy/{identifier}
-
Load a Policy -
POST /policies/{account}/policy/{identifier}
-
Update a Policy -
PATCH /policies/{account}/policy/{identifier}
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
(see Policy event subjects) |
|
|
Policy remove
A Policy Remove event is generated when a policy is loaded for each deleted resource. The policy must be loaded through the "Replace" (PUT
) or "Update" (PATCH
) API endpoints because the "Append" (POST
) endpoint does not allow resources to be deleted.
API endpoints
-
Replace a Policy-
PUT /policies/{account}/policy/{identifier}
-
Update a Policy -
PATCH /policies/{account}/policy/{identifier}
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
(see Policy event subjects) |
|
|
Policy change
A Policy Change event is generated for each updated resource. The policy must be loaded through the "Replace" (PUT
) or "Update" (PATCH
) API endpoints because the "Append" (POST
) endpoint does not allow resource modification.
API endpoints
-
Replace a Policy-
PUT /policies/{account}/policy/{identifier}
-
Update a Policy -
PATCH /policies/{account}/policy/{identifier}
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
(see Policy event subjects) |
|
|
Set secret value
A Set Secret Value event is generated when a request is made to set a secret value.
API endpoints
-
Set a Secret -
POST /secrets/{account}/{kind}/{identifier}
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Fetch secret value
A Fetch Secret Value event is generated when a request is made to read a secret value.
API endpoints
-
Retrieve a Secret -
GET /secrets/{account}/{kind}/{identifier}{?version}
-
Batch Retrieval -
GET /secrets{?variable_ids}
Structured data
Data Element |
Values |
---|---|
|
|
|
|
|
|
|
|
Policy event subjects
The subject@43868
structured data field of policy events can contain a wide range of values, depending on the type of policy object that is the target of the policy-loading operation. This section describes the contents of this field for various policy objects.
Field |
Values |
---|---|
Annotations |
|
Permissions |
|
Resources |
|
Roles |
|
Role Membership |
|
High availability
In high-availability configurations, audit events are created by Masters and Followers. Standbys do not serve traffic, unless they are promoted to Leader, so they do not produce audit events.
The Leader can produce every type of audit event. Followers have a read-only database so they are only be able to produce audit events associated with read-only operations, which can be viewed only from the Conjur UI.
To determine whether a read-only audit event originated from the Leader or a Follower, examine the hostname
field in the Syslog Protocol formatted audit message.