List the audit log
What was done in the organization over the last year, by which credential, and whether it was allowed.
GET
/v1/organization/audit-logsAuthorization
AuthorizationBearer token · headerrequiredQuery parameters
limitinteger<int64>min 1 · max 200
afterstring<uuid>Rows past this id in `order`'s direction: a page's `next_cursor`.
beforestring<uuid>Rows just before this id, still in `order`'s direction: a page's `prev_cursor`.
orderOrderParamNewest first when omitted.
Allowed:
ascdescsincestring<date-time>Only rows recorded at or after this instant.
untilstring<date-time>Only rows recorded before this instant.
categoryAuditCategoryBodyOnly rows whose action is in this category.
Allowed:
managementauthenticationsessionactionstringOnly rows of this action.
resultAuditResultBodyOnly rows with this result.
Allowed:
successdeniedactor_idstring<uuid>Only rows this member, API key, or session token acted in, or that a
credential it issued acted in.
workspace_idstring<uuid>Only rows in this workspace.
subjectstringOnly rows about this subject.
Responses
200One page, newest first unless order=asc.
itemsAuditLogEntryBody[]requiredShow propertiesHide properties
Array of
AuditLogEntryBodyactionstringrequiredWhat was done. An open vocabulary: an action Subako starts recording
later arrives under its own name, so a client keeps a row it does not
know rather than rejecting it. `AuditEvent` lists the actions this
version knows.
actorAuditActorBodyrequiredThe credential an action came in on.
Stable vocabulary for v1: adding a value requires a new API version.
Show propertiesHide properties
One of:
object
grant_idstring<uuid> | nulltypestringrequiredAllowed:
useruser_idstring<uuid>requiredobject
api_key_idstring<uuid>requiredtypestringrequiredAllowed:
api_keyobject
session_idstring<uuid> | nullsession_token_idstring<uuid> | nulltypestringrequiredAllowed:
session_tokenobject
typestringrequiredAllowed:
operatorobject
typestringrequiredAllowed:
billingobject
typestringrequiredAllowed:
systemcategorystring | nullThe action's category, or null for an action this version does not
know. An open vocabulary, as `action` is.
detailsobjectrequiredThe action's facts. Their shape is the action's, as `AuditEvent`
documents it; a field added later is absent from older rows.
idstring<uuid>requiredipstring | nullThe address a member's or an API key's request came from. A session
token's request, and Subako's own, record none.
issuerany | AuditIssuerBodyShow propertiesHide properties
One of:
any
anyAuditIssuerBody
One of:
object
typestringrequiredAllowed:
useruser_idstring<uuid>requiredobject
api_key_idstring<uuid>requiredtypestringrequiredAllowed:
api_keynamesAuditNamesBodyrequiredThe names of what an entry names, as they are now. A field is null where
the entry has no such id, or where what it names has no name: a session
token, a login, a credit lot, an identity provider, or Subako itself.
Show propertiesHide properties
actorany | AuditNameBodyShow propertiesHide properties
One of:
any
anyAuditNameBody
One of:
object
namestring | nullstatestringrequiredAllowed:
currentobject
statestringrequiredAllowed:
deletedissuerany | AuditNameBodyShow propertiesHide properties
One of:
any
anyAuditNameBody
One of:
object
namestring | nullstatestringrequiredAllowed:
currentobject
statestringrequiredAllowed:
deletedsubjectany | AuditNameBodyShow propertiesHide properties
One of:
any
anyAuditNameBody
One of:
object
namestring | nullstatestringrequiredAllowed:
currentobject
statestringrequiredAllowed:
deletedworkspaceany | AuditNameBodyShow propertiesHide properties
One of:
any
anyAuditNameBody
One of:
object
namestring | nullstatestringrequiredAllowed:
currentobject
statestringrequiredAllowed:
deletedoccurred_atstring<date-time>requiredrequest_idstring<uuid> | nullThe request that did it, as its response's `x-request-id` named it.
resultAuditResultBodyrequiredWhether the operation went ahead.
Stable vocabulary for v1: adding a value requires a new API version.
Allowed:
successdeniedrun_idstring<uuid> | nullThe run the action happened in, for what an agent did.
subjectstring | nullThe id of what the action was done to.
subject_kindstring | nullWhat kind of thing `subject` is, which its action decides: `agent`,
`vault`, `user`, and so on, as `KnownAuditSubjectKind` lists them. An
open vocabulary, as `action` is; null when there is no subject or the
action is one this version does not know.
user_agentstring | nullThe `User-Agent` the request came with. A session token's request,
and the server acting on its own, record none.
workspace_idstring<uuid> | nullnext_cursorstring<uuid> | nullrequiredPass back as `after` for the next page; `null` on the last page.
prev_cursorstring<uuid> | nullrequiredPass back as `before` for the previous page; `null` on the first page.
400Bad limit, cursor, order, instant, category, or result.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired401Missing, malformed, or invalid bearer token.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired403Caller lacks org.audit.read.
errorErrorDetailrequiredWhat went wrong: a `code` to branch on and a `message` to show. The
message is written for a person and may change; the code will not.
Show propertiesHide properties
codeErrorCoderequiredThe machine-readable half of an error response, and the field a client
branches on. Closed: every error carries exactly one of these.
Allowed:
unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternalmessagestringrequired