Audit events

Audit events are exported as JSON and specify an actor that performed an action on a target at time timestamp with a specific outcome under a context. For example:

The actor is the user who initiated the action. This can be a logged in user, or an anonymous (logged out) user.

The action describes the activity, such as a user viewing a design or deleting another user.

The target is the user, team, organization, or resource that the action targeted. For example, a delete user action includes the ID of the user being deleted.

The outcome includes the result of the action, such as whether it succeeded and information about affected resources. For example, the outcome of a successful create user action will contain the user ID of the newly created user.

The context contains additional information related to the event, such as the IP address of the actor.

AuditEvent schema

<Prop.List> <Prop name="id" type="string" required mode="output"> The ID of the audit event. </Prop>

<Prop name="timestamp" type="integer" required mode="output"> The time the event occurred, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop>

<Prop name="actor" type="Actor" required mode="output"> The person who performed the action.

<Tabs>
  <Tab name="USER">
    A Canva user, including the team and organization context for the action.

    <Prop.List>
      <Prop name="type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `USER`

          **Available values:** The only valid value is `USER`.
        </Prop.Extras>
      </Prop>

      <Prop name="user" type="AuditLogUser" required mode="output">
        A Canva user.

        <PillAccordion title={<>Properties of <strong>user</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The user ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the user.

              For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
            </Prop>

            <Prop name="email" type="string" mode="output">
              The email address of the user.

              For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>

      <Prop name="team" type="AuditLogTeam" required mode="output">
        A Canva team.

        <PillAccordion title={<>Properties of <strong>team</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The team ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the team.

              For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>

      <Prop name="redacted" type="boolean" required mode="output">
        `true` when we've redacted the details of the user, brand, or organization because they're outside of your organization.
      </Prop>

      <Prop name="organization" type="AuditLogOrganization" mode="output">
        A Canva organization.

        <PillAccordion title={<>Properties of <strong>organization</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The organization ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the organization.

              For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="CANVA_CUSTOMER_SUPPORT">
    A Canva Staff member providing customer support.

    <Prop.List>
      <Prop name="type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `CANVA_CUSTOMER_SUPPORT`

          **Available values:** The only valid value is `CANVA_CUSTOMER_SUPPORT`.
        </Prop.Extras>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="ANONYMOUS">
    A user that isn't signed in.

    <Prop.List>
      <Prop name="type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `ANONYMOUS`

          **Available values:** The only valid value is `ANONYMOUS`.
        </Prop.Extras>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="SYSTEM">
    A system that isn't associated with a single user account. System actors include
    internal Canva system processes or external systems such as SCIM IdP providers.

    <Prop.List>
      <Prop name="type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `SYSTEM`

          **Available values:** The only valid value is `SYSTEM`.
        </Prop.Extras>
      </Prop>

      <Prop name="details" type="SystemDetails" mode="output">
        Details about the system actor.

        <Tabs>
          <Tab name="SCIM">
            Details about the SCIM IdP provider.

            <Prop.List>
              <Prop name="type" type="string" required mode="output">
                <Prop.Extras>
                  **Default value:** `SCIM`

                  **Available values:** The only valid value is `SCIM`.
                </Prop.Extras>
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="CRM">
            Details about the Customer Relationship Management system.

            <Prop.List>
              <Prop name="type" type="string" required mode="output">
                <Prop.Extras>
                  **Default value:** `CRM`

                  **Available values:** The only valid value is `CRM`.
                </Prop.Extras>
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>
      </Prop>
    </Prop.List>
  </Tab>
</Tabs>

</Prop>

<Prop name="target" type="Target" required mode="output"> The target resource of an action.

<Tabs>
  <Tab name="USER">
    The user that is the target of the action.

    <Prop.List>
      <Prop name="target_type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `USER`

          **Available values:** The only valid value is `USER`.
        </Prop.Extras>
      </Prop>

      <Prop name="user" type="AuditLogUser" required mode="output">
        A Canva user.

        <PillAccordion title={<>Properties of <strong>user</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The user ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the user.

              For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
            </Prop>

            <Prop name="email" type="string" mode="output">
              The email address of the user.

              For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>

      <Prop name="team" type="AuditLogTeam" required mode="output">
        A Canva team.

        <PillAccordion title={<>Properties of <strong>team</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The team ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the team.

              For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="TEAM">
    The team that is the target of the action.

    <Prop.List>
      <Prop name="target_type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `TEAM`

          **Available values:** The only valid value is `TEAM`.
        </Prop.Extras>
      </Prop>

      <Prop name="team" type="AuditLogTeam" required mode="output">
        A Canva team.

        <PillAccordion title={<>Properties of <strong>team</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The team ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the team.

              For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="ORGANIZATION">
    The organization that is the target of the action.

    <Prop.List>
      <Prop name="target_type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `ORGANIZATION`

          **Available values:** The only valid value is `ORGANIZATION`.
        </Prop.Extras>
      </Prop>

      <Prop name="organization" type="AuditLogOrganization" required mode="output">
        A Canva organization.

        <PillAccordion title={<>Properties of <strong>organization</strong></>}>
          <Prop.List>
            <Prop name="id" type="string" required mode="output">
              The organization ID.
            </Prop>

            <Prop name="display_name" type="string" mode="output">
              The display name of the organization.

              For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="RESOURCE">
    The resource that's the target of the action. For example, a design.

    <Prop.List>
      <Prop name="target_type" type="string" required mode="output">
        <Prop.Extras>
          **Default value:** `RESOURCE`

          **Available values:** The only valid value is `RESOURCE`.
        </Prop.Extras>
      </Prop>

      <Prop name="resource_type" type="string" required mode="output">
        The type of resource.

        <Prop.Extras>
          **Available values:**

          * `BRAND_KIT`: A Brand Kit.
          * `DESIGN`: A design.
          * `FILE`: A file.
          * `FOLDER`: A folder.
          * `GROUP`: A Canva group.
          * `MEDIA`: A media.
          * `TEMPLATE`: A template.
          * `VIDEO`: A video.
          * `AUDIO`: An audio.
          * `WEBSITE_DOMAIN`: A website domain.
          * `WEBSITE_SSO_CONNECTION`: An SSO connection for Canva Websites.
          * `PROVISIONING_POLICY`: A provisioning policy.
        </Prop.Extras>
      </Prop>

      <Prop name="id" type="string" required mode="output">
        The resource ID.
      </Prop>

      <Prop name="owner" type="Owner" required mode="output">
        The owner of the resource.

        <Tabs>
          <Tab name="USER">
            An owner who is a user.

            <Prop.List>
              <Prop name="type" type="string" required mode="output">
                <Prop.Extras>
                  **Default value:** `USER`

                  **Available values:** The only valid value is `USER`.
                </Prop.Extras>
              </Prop>

              <Prop name="user" type="AuditLogUser" required mode="output">
                A Canva user.

                <PillAccordion title={<>Properties of <strong>user</strong></>}>
                  <Prop.List>
                    <Prop name="id" type="string" required mode="output">
                      The user ID.
                    </Prop>

                    <Prop name="display_name" type="string" mode="output">
                      The display name of the user.

                      For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
                    </Prop>

                    <Prop name="email" type="string" mode="output">
                      The email address of the user.

                      For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>

              <Prop name="team" type="AuditLogTeam" required mode="output">
                A Canva team.

                <PillAccordion title={<>Properties of <strong>team</strong></>}>
                  <Prop.List>
                    <Prop name="id" type="string" required mode="output">
                      The team ID.
                    </Prop>

                    <Prop name="display_name" type="string" mode="output">
                      The display name of the team.

                      For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="TEAM">
            An owner that is a team.

            <Prop.List>
              <Prop name="type" type="string" required mode="output">
                <Prop.Extras>
                  **Default value:** `TEAM`

                  **Available values:** The only valid value is `TEAM`.
                </Prop.Extras>
              </Prop>

              <Prop name="team" type="AuditLogTeam" required mode="output">
                A Canva team.

                <PillAccordion title={<>Properties of <strong>team</strong></>}>
                  <Prop.List>
                    <Prop name="id" type="string" required mode="output">
                      The team ID.
                    </Prop>

                    <Prop name="display_name" type="string" mode="output">
                      The display name of the team.

                      For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="ORGANIZATION">
            An owner that is an organization.

            <Prop.List>
              <Prop name="type" type="string" required mode="output">
                <Prop.Extras>
                  **Default value:** `ORGANIZATION`

                  **Available values:** The only valid value is `ORGANIZATION`.
                </Prop.Extras>
              </Prop>

              <Prop name="organization" type="AuditLogOrganization" required mode="output">
                A Canva organization.

                <PillAccordion title={<>Properties of <strong>organization</strong></>}>
                  <Prop.List>
                    <Prop name="id" type="string" required mode="output">
                      The organization ID.
                    </Prop>

                    <Prop name="display_name" type="string" mode="output">
                      The display name of the organization.

                      For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>
      </Prop>

      <Prop name="name" type="string" mode="output">
        The name of the resource.
      </Prop>
    </Prop.List>
  </Tab>
</Tabs>

</Prop>

<Prop name="action" type="Action" required mode="output"> This can be one of the following action types:

* [#](/docs/audit-logs/actions/apps)
* [#](/docs/audit-logs/actions/audio)
* [#](/docs/audit-logs/actions/audit-logs)
* [#](/docs/audit-logs/actions/brands)
* [#](/docs/audit-logs/actions/content)
* [#](/docs/audit-logs/actions/designs)
* [#](/docs/audit-logs/actions/exports)
* [#](/docs/audit-logs/actions/folders)
* [#](/docs/audit-logs/actions/groups)
* [#](/docs/audit-logs/actions/investigations)
* [#](/docs/audit-logs/actions/organizations)
* [#](/docs/audit-logs/actions/permissions-and-settings)
* [#](/docs/audit-logs/actions/teams)
* [#](/docs/audit-logs/actions/templates)
* [#](/docs/audit-logs/actions/users)
* [#](/docs/audit-logs/actions/videos)
* [#](/docs/audit-logs/actions/websites)

</Prop>

<Prop name="outcome" type="Outcome" required mode="output"> Outcome of the action.

<PillAccordion title={<>Properties of <strong>outcome</strong></>} defaultExpanded={true}>
  <Prop.List>
    <Prop name="result" type="string" required mode="output">
      The outcome result.

      <Prop.Extras>
        **Available values:**

        * `UNKNOWN`: The action failed due to an unknown error.
        * `PERMITTED`: The action was permitted.
        * `DENIED`: The action was denied.
        * `RESOURCE_NOT_FOUND`: The action failed because the resource was not found.
        * `FAILED`: The action failed.
      </Prop.Extras>
    </Prop>

    <Prop name="details" type="OutcomeDetails" mode="output">
      Additional details about the outcome.

      <Tabs>
        <Tab name="RESOURCE_CREATED">
          Outcome details when a new resource is created.

          <Prop.List>
            <Prop name="type" type="string" required mode="output">
              <Prop.Extras>
                **Default value:** `RESOURCE_CREATED`

                **Available values:** The only valid value is `RESOURCE_CREATED`.
              </Prop.Extras>
            </Prop>

            <Prop name="resource_id" type="string" required mode="output">
              The resource ID.
            </Prop>

            <Prop name="resource_type" type="string" required mode="output">
              The type of resource.

              <Prop.Extras>
                **Available values:**

                * `BRAND_KIT`: A Brand Kit.
                * `DESIGN`: A design.
                * `FILE`: A file.
                * `FOLDER`: A folder.
                * `GROUP`: A Canva group.
                * `MEDIA`: A media.
                * `TEMPLATE`: A template.
                * `VIDEO`: A video.
                * `AUDIO`: An audio.
                * `WEBSITE_DOMAIN`: A website domain.
                * `WEBSITE_SSO_CONNECTION`: An SSO connection for Canva Websites.
                * `PROVISIONING_POLICY`: A provisioning policy.
              </Prop.Extras>
            </Prop>
          </Prop.List>
        </Tab>

        <Tab name="USER_CREATED">
          Outcome details when a new user is created.

          <Prop.List>
            <Prop name="type" type="string" required mode="output">
              <Prop.Extras>
                **Default value:** `USER_CREATED`

                **Available values:** The only valid value is `USER_CREATED`.
              </Prop.Extras>
            </Prop>

            <Prop name="user_id" type="string" required mode="output">
              The ID of the created user.
            </Prop>
          </Prop.List>
        </Tab>

        <Tab name="INVESTIGATION_STARTED">
          Outcome details when a new investigation is started.

          <Prop.List>
            <Prop name="type" type="string" required mode="output">
              <Prop.Extras>
                **Default value:** `INVESTIGATION_STARTED`

                **Available values:** The only valid value is `INVESTIGATION_STARTED`.
              </Prop.Extras>
            </Prop>

            <Prop name="investigation_id" type="string" required mode="output">
              The ID for the investigation. This is a UUID that represents the investigation.
            </Prop>
          </Prop.List>
        </Tab>
      </Tabs>
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop>

<Prop name="context" type="Context" required mode="output"> Additional context associated with the audit event.

<PillAccordion title={<>Properties of <strong>context</strong></>} defaultExpanded={true}>
  <Prop.List>
    <Prop name="ip_address" type="string" mode="output">
      The IP address of the actor.
    </Prop>

    <Prop name="session" type="string" mode="output">
      The session ID of the actor.
    </Prop>

    <Prop name="request_id" type="string" mode="output">
      The ID of the request.
    </Prop>

    <Prop name="device_id" type="string" mode="output">
      A hashed ID generated and stored on the device when a user logs into Canva from a device
      without a `device_id` (such as a new or reformatted device, or after a web browser's cache
      is cleared). This ID can be useful for identifying suspicious logins.

      Warning: This ID is stored on the user's device, and may be subject to forgery or tampering.
    </Prop>

    <Prop name="integration_id" type="string" mode="output">
      Identifier for the Canva Integration
    </Prop>
  </Prop.List>
</PillAccordion>

</Prop> </Prop.List>