Authentication Audit Log

object

An authentication audit log entry that captures authentication attempts and their outcomes.

successfulbooleanrequired

Indicates whether authentication was successful.

principal_idstring

If successful, the principal ID.

signaturestringrequired

Base64 URL encoded signature of this entity.

org_idstring

If it can be determined, the organization ID.

outcomestringrequired

The outcome of an authentication attempt.

Allowed values:invalidsuccessnot_foundinvalid_passwordlockeddisabledtoken_expired

authentication_typestringrequired

The type of authentication used.

Allowed values:invalidbasicssopatspatgooglegithubwindowslivefederated

tsstring(date-time)required

Timestamp when the authentication event occurred.

client_ipstringrequired

IP address of the client.

uristringrequired

URI the request was made on.

user_agentstringrequired

User agent making the request.

trace_idstringrequired

Trace ID of the request.

portal_idstring

Optional Dev Portal ID.

Example

Authentication Outcome

string

The outcome of an authentication attempt.

Allowed values:invalidsuccessnot_foundinvalid_passwordlockeddisabledtoken_expired

Authentication Type

string

The type of authentication used.

Allowed values:invalidbasicssopatspatgooglegithubwindowslivefederated

Audit Log

An individual audit log entry.

One Of
typestringrequired

The type of audit log entry.

Allowed values:authorization

signaturestringrequired

Base64 URL encoded signature of this entity.

servicestringrequired

The name of the API service performing the operation (for example, servicehub).

resourcestringrequired

KRN of the resource.

actionstringrequired

Action performed on the resource.

grantedbooleanrequired

Indicates whether the action was granted.

org_idstringrequired

Organization ID.

tsstring(date-time)required

Timestamp when the authorization event occurred.

principal_idstringrequired

Principal that performed the action.

actor_idstring

If using an actor JWT, the ID of the person doing the acting.

client_ipstring

IP address of the client.

uristring

URI the request was made on.

user_agentstring

User agent making the request.

trace_idstring

Trace ID of the request.

portal_idstring

Optional Dev Portal ID.

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example