Skip to content

Asana: Audit log API schemas

11 Asana schemas with complete fields and constraints.

← Audit log API operations · All schemas

Get audit log events — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get audit log events — response body — data, next page data item — sdk__Audit Log Event
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get audit log events — response body — data, next page data item — sdk__Audit Log Event

Get audit log events — response body — data, next page data item actor — Audit Log Event Actor

FieldTypePresenceDescription and constraints
$objectRootThe entity that triggered the event. Will typically be a user.
actor_typestringOptionalThe type of actor.
Can be one of `user`, `asana`, `asana_support`, `anonymous`, `external_administrator`, or `data_retention_policy`.
Known values: user, asana, asana_support, anonymous, external_administrator, data_retention_policy
gidstringOptionalGlobally unique identifier of the actor, if it is a user.
namestringOptionalThe name of the actor, if it is a user.
emailstringOptionalThe email of the actor, if it is a user.

Get audit log events — response body — data, next page data item actor — shared_outputauditlogeventactor_408212e50bac

FieldTypePresenceDescription and constraints
$objectRootThe entity that triggered the event. Will typically be a user.
actor_typestringOptionalThe type of actor.
Can be one of `user`, `asana`, `asana_support`, `anonymous`, `external_administrator`, or `data_retention_policy`.
Known values: user, asana, asana_support, anonymous, external_administrator, data_retention_policy
gidstringOptionalGlobally unique identifier of the actor, if it is a user.
namestringOptionalThe name of the actor, if it is a user.
emailstringOptionalThe email of the actor, if it is a user.

Get audit log events — response body — data, next page data item context — Audit Log Event Context

FieldTypePresenceDescription and constraints
$objectRootThe context from which this event originated.
context_typestringOptionalThe type of context.
Can be one of `web`, `desktop`, `mobile`, `asana_support`, `asana`, `email`, or `api`.
Known values: web, desktop, mobile, asana_support, asana, email, api
api_authentication_methodstringOptionalThe authentication method used in the context of an API request.
Only present if the `context_type` is `api`. Can be one of `cookie`, `oauth`, `personal_access_token`, or `service_account`.
Known values: cookie, oauth, personal_access_token, service_account
client_ip_addressstringOptionalThe IP address of the client that initiated the event, if applicable.
user_agentstringOptionalThe user agent of the client that initiated the event, if applicable.
oauth_app_namestringOptionalThe name of the OAuth App that initiated the event.
Only present if the `api_authentication_method` is `oauth`.
rule_namestringOptionalThe name of the automation rule that initiated the event.
on_behalf_of_user_idJSONOptional
on_behalf_of_user_id (anyOf 1)integerAlternativeThe ID of the user who requested a change via support.
on_behalf_of_user_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get audit log events — response body — data, next page data item context — shared_outputauditlogeventcontext_4b9e813b0103

FieldTypePresenceDescription and constraints
$objectRootThe context from which this event originated.
context_typestringOptionalThe type of context.
Can be one of `web`, `desktop`, `mobile`, `asana_support`, `asana`, `email`, or `api`.
Known values: web, desktop, mobile, asana_support, asana, email, api
api_authentication_methodstringOptionalThe authentication method used in the context of an API request.
Only present if the `context_type` is `api`. Can be one of `cookie`, `oauth`, `personal_access_token`, or `service_account`.
Known values: cookie, oauth, personal_access_token, service_account
client_ip_addressstringOptionalThe IP address of the client that initiated the event, if applicable.
user_agentstringOptionalThe user agent of the client that initiated the event, if applicable.
oauth_app_namestringOptionalThe name of the OAuth App that initiated the event.
Only present if the `api_authentication_method` is `oauth`.
rule_namestringOptionalThe name of the automation rule that initiated the event.
on_behalf_of_user_idJSONOptional
on_behalf_of_user_id (anyOf 1)integerAlternativeThe ID of the user who requested a change via support.
on_behalf_of_user_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get audit log events — response body — data, next page data item details — Audit Log Event Details

FieldTypePresenceDescription and constraints
$objectRootEvent specific details. The schema will vary depending on the `event_type`.
Additional keys: allowed
old_valueJSONOptional
old_value (anyOf 1)stringAlternativeThe previous value of the field that was modified in the audited event.
old_value (anyOf 2)nullAlternative
new_valueJSONOptional
new_value (anyOf 1)stringAlternativeThe new value after the modification in the audited event.
new_value (anyOf 2)nullAlternative
groupobjectOptionalThe division or organizational unit where the event occurred. Primarily used to scope role change events (e.g., `user_division_admin_role_changed`), but may appear in other contexts involving group-level changes.
Additional keys: allowed
saml_responseJSONOptional
saml_response (anyOf 1)stringAlternativeThe response received from the IdP when a user logs in with SAML SSO. Present on `user_login_failed` and `user_login_succeeded` events.
saml_response (anyOf 2)nullAlternative

Get audit log events — response body — data, next page data item details — shared_auditlogeventdetails_5d1508c34080

FieldTypePresenceDescription and constraints
$objectRootEvent specific details. The schema will vary depending on the `event_type`.
Additional keys: allowed
old_valueJSONOptional
old_value (anyOf 1)stringAlternativeThe previous value of the field that was modified in the audited event.
old_value (anyOf 2)nullAlternative
new_valueJSONOptional
new_value (anyOf 1)stringAlternativeThe new value after the modification in the audited event.
new_value (anyOf 2)nullAlternative
groupobjectOptionalThe division or organizational unit where the event occurred. Primarily used to scope role change events (e.g., `user_division_admin_role_changed`), but may appear in other contexts involving group-level changes.
Additional keys: allowed
saml_responseJSONOptional
saml_response (anyOf 1)stringAlternativeThe response received from the IdP when a user logs in with SAML SSO. Present on `user_login_failed` and `user_login_succeeded` events.
saml_response (anyOf 2)nullAlternative

Get audit log events — response body — data, next page data item resource — Audit Log Event Resource

FieldTypePresenceDescription and constraints
$objectRootThe primary object that was affected by this event.
resource_typestringOptionalThe type of resource.
resource_subtypestringOptionalThe subtype of resource. Most resources will not have a subtype.
gidstringOptionalGlobally unique identifier of the resource.
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the resource.
name (anyOf 2)nullAlternative
emailstringOptionalThe email of the resource, if applicable.

Get audit log events — response body — data, next page data item resource — shared_auditlogeventresource_b270252d203e

FieldTypePresenceDescription and constraints
$objectRootThe primary object that was affected by this event.
resource_typestringOptionalThe type of resource.
resource_subtypestringOptionalThe subtype of resource. Most resources will not have a subtype.
gidstringOptionalGlobally unique identifier of the resource.
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the resource.
name (anyOf 2)nullAlternative
emailstringOptionalThe email of the resource, if applicable.

Get audit log events — response body — data, next page data item — Audit Log Event

FieldTypePresenceDescription and constraints
$objectRootAn object representing a single event within an Asana domain.

Every audit log event is comprised of an `event_type`, `actor`, `resource`, and `context`. Some events will include additional metadata about the event under `details`. See our [currently supported list of events](/docs/audit-log-events#supported-audit-log-events) for more details.
gidstringOptionalGlobally unique identifier of the `AuditLogEvent`, as a string.
created_atstringOptionalThe time the event was created.
Format: date-time
event_typestringOptionalThe type of the event.
event_categorystringOptionalThe category that this `event_type` belongs to.
actorModelOptionalExpand Get audit log events — response body — data, next page data item actor — Audit Log Event Actor
resourceModelOptionalExpand Get audit log events — response body — data, next page data item resource — Audit Log Event Resource
detailsModelOptionalExpand Get audit log events — response body — data, next page data item details — Audit Log Event Details
contextModelOptionalExpand Get audit log events — response body — data, next page data item context — Audit Log Event Context

Referenced models: Get audit log events — response body — data, next page data item details — Audit Log Event Details, Get audit log events — response body — data, next page data item resource — Audit Log Event Resource, Get audit log events — response body — data, next page data item actor — Audit Log Event Actor, Get audit log events — response body — data, next page data item context — Audit Log Event Context

Get audit log events — response body — data, next page data item — sdk__Audit Log Event

FieldTypePresenceDescription and constraints
$objectRootAn object representing a single event within an Asana domain.

Every audit log event is comprised of an `event_type`, `actor`, `resource`, and `context`. Some events will include additional metadata about the event under `details`. See our [currently supported list of events](/docs/audit-log-events#supported-audit-log-events) for more details.
gidstringOptionalGlobally unique identifier of the `AuditLogEvent`, as a string.
created_atstringOptionalThe time the event was created.
Format: date-time
event_typestringOptionalThe type of the event.
event_categorystringOptionalThe category that this `event_type` belongs to.
actorModelOptionalExpand Get audit log events — response body — data, next page data item actor — shared_outputauditlogeventactor_408212e50bac
resourceModelOptionalExpand Get audit log events — response body — data, next page data item resource — shared_auditlogeventresource_b270252d203e
detailsModelOptionalExpand Get audit log events — response body — data, next page data item details — shared_auditlogeventdetails_5d1508c34080
contextModelOptionalExpand Get audit log events — response body — data, next page data item context — shared_outputauditlogeventcontext_4b9e813b0103

Referenced models: Get audit log events — response body — data, next page data item details — shared_auditlogeventdetails_5d1508c34080, Get audit log events — response body — data, next page data item resource — shared_auditlogeventresource_b270252d203e, Get audit log events — response body — data, next page data item actor — shared_outputauditlogeventactor_408212e50bac, Get audit log events — response body — data, next page data item context — shared_outputauditlogeventcontext_4b9e813b0103

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.