Appearance
Audit Log Actions
Apps
Install an app
An actor triggers this event when they use a third-party app for the first time (or following app uninstall). For example, when a user selects "open" on a new app in the editor, or selects Use in a new design or Use in existing design from the apps marketplace. The installation is for a user in a team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: INSTALL_APP
**Available values:** The only valid value is `INSTALL_APP`.
</Prop.Extras>
</Prop>
<Prop name="app" type="AuditLogApp" required mode="output"> A Canva app.
<PillAccordion title={<>Properties of <strong>app</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The app ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the app.
</Prop>
<Prop name="version" type="string" mode="output">
The version of the app.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="permissions" type="string[]" mode="output"> A set of permissions.
<Prop.Extras>
**Available values:**
* `DESIGN_CONTENT_READ`: Permission to view design content.
* `DESIGN_CONTENT_WRITE`: Permission to modify design content.
* `ASSET_PRIVATE_READ`: Permission to view private assets.
* `ASSET_PRIVATE_WRITE`: Permission to modify private assets.
* `BRANDKIT_READ`: Permission to view Brand Kits.
* `BRAND_TEMPLATE_READ`: Permission to view brand templates.
</Prop.Extras>
</Prop> </Prop.List>
Example
Uninstall an app
An actor triggers this event when they remove a third-party app from their list of apps.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNINSTALL_APP
**Available values:** The only valid value is `UNINSTALL_APP`.
</Prop.Extras>
</Prop>
<Prop name="app" type="AuditLogApp" required mode="output"> A Canva app.
<PillAccordion title={<>Properties of <strong>app</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The app ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the app.
</Prop>
<Prop name="version" type="string" mode="output">
The version of the app.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Update an app's permissions
An actor triggers this event when they accept updated permissions for an installed third-party app. The app's developer may have updated the permissions required by the app.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_APP_PERMISSIONS
**Available values:** The only valid value is `UPDATE_APP_PERMISSIONS`.
</Prop.Extras>
</Prop>
<Prop name="app" type="AuditLogApp" required mode="output"> A Canva app.
<PillAccordion title={<>Properties of <strong>app</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The app ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the app.
</Prop>
<Prop name="version" type="string" mode="output">
The version of the app.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_permissions" type="string[]" mode="output"> A set of permissions.
<Prop.Extras>
**Available values:**
* `DESIGN_CONTENT_READ`: Permission to view design content.
* `DESIGN_CONTENT_WRITE`: Permission to modify design content.
* `ASSET_PRIVATE_READ`: Permission to view private assets.
* `ASSET_PRIVATE_WRITE`: Permission to modify private assets.
* `BRANDKIT_READ`: Permission to view Brand Kits.
* `BRAND_TEMPLATE_READ`: Permission to view brand templates.
</Prop.Extras>
</Prop>
<Prop name="new_permissions" type="string[]" mode="output"> A set of permissions.
<Prop.Extras>
**Available values:**
* `DESIGN_CONTENT_READ`: Permission to view design content.
* `DESIGN_CONTENT_WRITE`: Permission to modify design content.
* `ASSET_PRIVATE_READ`: Permission to view private assets.
* `ASSET_PRIVATE_WRITE`: Permission to modify private assets.
* `BRANDKIT_READ`: Permission to view Brand Kits.
* `BRAND_TEMPLATE_READ`: Permission to view brand templates.
</Prop.Extras>
</Prop> </Prop.List>
Example
Disconnect from a third-party service through an app
An actor triggers this event when they disconnect from a third-party service from within a third-party app installed in Canva. For example, a user disconnects from Google Drive in the Google Drive App.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DISCONNECT_FROM_THIRD_PARTY_APP
**Available values:** The only valid value is `DISCONNECT_FROM_THIRD_PARTY_APP`.
</Prop.Extras>
</Prop>
<Prop name="app" type="AuditLogApp" required mode="output"> A Canva app.
<PillAccordion title={<>Properties of <strong>app</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The app ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the app.
</Prop>
<Prop name="version" type="string" mode="output">
The version of the app.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Connect to a third-party service through an app
An actor triggers this event when they connect to a third-party service using a third-party app installed in Canva. For example, a user connects to Google Drive using the Google Drive App.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CONNECT_TO_THIRD_PARTY_APP
**Available values:** The only valid value is `CONNECT_TO_THIRD_PARTY_APP`.
</Prop.Extras>
</Prop>
<Prop name="app" type="AuditLogApp" required mode="output"> A Canva app.
<PillAccordion title={<>Properties of <strong>app</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The app ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the app.
</Prop>
<Prop name="version" type="string" mode="output">
The version of the app.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Audio
Create an audio
An actor triggers this event when they create/upload an audio to their account or team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_AUDIO
**Available values:** The only valid value is `CREATE_AUDIO`.
</Prop.Extras>
</Prop>
<Prop name="filename" type="string" mode="output"> The name of the uploaded file. </Prop> </Prop.List>
Example
Update an audio's details
An actor triggers this event when they update audios in their account or team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_AUDIO
**Available values:** The only valid value is `UPDATE_AUDIO`.
</Prop.Extras>
</Prop>
<Prop name="old_title" type="string" mode="output"> The old title of the audio. </Prop>
<Prop name="new_title" type="string" mode="output"> The new title of the audio. </Prop>
<Prop name="old_tags" type="string[]" mode="output"> Original list of tags associated with the audio. </Prop>
<Prop name="new_tags" type="string[]" mode="output"> New list of tags associated with the audio. </Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `TITLE`: The audio's title.
* `TAGS`: The audio's tags.
</Prop.Extras>
</Prop> </Prop.List>
Example
Delete an audio
An actor triggers this event when they permanently delete audios from their account or team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_AUDIO
**Available values:** The only valid value is `DELETE_AUDIO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Trash an audio
An actor triggers this event when they move audios to the trash folder. Audios in the trash folder aren't accessible to collaborators and will be deleted after a period of time.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: TRASH_AUDIO
**Available values:** The only valid value is `TRASH_AUDIO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Restore an audio from Trash
An actor triggers this event when they restore audios from the trash folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNDELETE_AUDIO
**Available values:** The only valid value is `UNDELETE_AUDIO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Copy an audio
An actor triggers this event when they copy an audio.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: COPY_AUDIO
**Available values:** The only valid value is `COPY_AUDIO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update an audio's access controls
An actor triggers this event when they change the rules that control access to an audio asset. There can be multiple changes in a single update.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_AUDIO_ACCESS_CONTROLS
**Available values:** The only valid value is `UPDATE_AUDIO_ACCESS_CONTROLS`.
</Prop.Extras>
</Prop>
<Prop name="changes" type="AudioAccessControlListChange[]" required mode="output"> A change to the rules that control the access to the audio asset.
<Tabs>
<Tab name="GRANT_USER_AUDIO_ACCESS">
A user granted another user access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_USER_AUDIO_ACCESS`
**Available values:** The only valid value is `GRANT_USER_AUDIO_ACCESS`.
</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="access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_USER_AUDIO_ACCESS">
A user revoked another user's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_USER_AUDIO_ACCESS`
**Available values:** The only valid value is `REVOKE_USER_AUDIO_ACCESS`.
</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.List>
</Tab>
<Tab name="UPDATE_USER_AUDIO_ACCESS">
A user changed another user's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_USER_AUDIO_ACCESS`
**Available values:** The only valid value is `UPDATE_USER_AUDIO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
</Tab>
<Tab name="GRANT_GROUP_AUDIO_ACCESS">
A user granted a group access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_GROUP_AUDIO_ACCESS`
**Available values:** The only valid value is `GRANT_GROUP_AUDIO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_GROUP_AUDIO_ACCESS">
A user revoked a group's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_GROUP_AUDIO_ACCESS`
**Available values:** The only valid value is `REVOKE_GROUP_AUDIO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_GROUP_AUDIO_ACCESS">
A user changed a group's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_GROUP_AUDIO_ACCESS`
**Available values:** The only valid value is `UPDATE_GROUP_AUDIO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_TEAM_AUDIO_ACCESS">
A user granted a team access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_TEAM_AUDIO_ACCESS`
**Available values:** The only valid value is `GRANT_TEAM_AUDIO_ACCESS`.
</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 name="access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_TEAM_AUDIO_ACCESS">
A user revoked a team's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_TEAM_AUDIO_ACCESS`
**Available values:** The only valid value is `REVOKE_TEAM_AUDIO_ACCESS`.
</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="UPDATE_TEAM_AUDIO_ACCESS">
A user changed a team's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_TEAM_AUDIO_ACCESS`
**Available values:** The only valid value is `UPDATE_TEAM_AUDIO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</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="GRANT_ORGANIZATION_AUDIO_ACCESS">
A user granted an organization access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_ORGANIZATION_AUDIO_ACCESS`
**Available values:** The only valid value is `GRANT_ORGANIZATION_AUDIO_ACCESS`.
</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 name="access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_ORGANIZATION_AUDIO_ACCESS">
A user revoked an organization's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_ORGANIZATION_AUDIO_ACCESS`
**Available values:** The only valid value is `REVOKE_ORGANIZATION_AUDIO_ACCESS`.
</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="UPDATE_ORGANIZATION_AUDIO_ACCESS">
A user changed an organization's access to the audio.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_ORGANIZATION_AUDIO_ACCESS`
**Available values:** The only valid value is `UPDATE_ORGANIZATION_AUDIO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="AudioAccessLevel" required mode="output">
Access permissions for an audio asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</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="UPDATE_AUDIO_OWNER">
The owner of the audio asset was changed.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_AUDIO_OWNER`
**Available values:** The only valid value is `UPDATE_AUDIO_OWNER`.
</Prop.Extras>
</Prop>
<Prop name="old_owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>old_owner</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="new_owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>new_owner</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.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Audit Logs
Export audit logs
An actor triggers this event when they click the Export button on the Audit logs settings page, then click Download, as described in Canva Help: About Canva audit logs.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: EXPORT_AUDIT_LOGS
**Available values:** The only valid value is `EXPORT_AUDIT_LOGS`.
</Prop.Extras>
</Prop>
<Prop name="start_timestamp" type="integer" mode="output"> The start of the time period queried by the actor, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop>
<Prop name="end_timestamp" type="integer" mode="output"> The end of the time period queried by the actor, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop>
<Prop name="team" type="AuditLogTeam" mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>team</strong></>} defaultExpanded={true}>
<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>
Example
View audit logs
An actor triggers this event when they view the audit logs, as described in Canva Help: About Canva audit logs.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: VIEW_AUDIT_LOGS
**Available values:** The only valid value is `VIEW_AUDIT_LOGS`.
</Prop.Extras>
</Prop>
<Prop name="start_timestamp" type="integer" mode="output"> The start of the time period viewed by the actor, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop>
<Prop name="end_timestamp" type="integer" mode="output"> The end of the time period viewed by the actor, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop>
<Prop name="team" type="AuditLogTeam" mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>team</strong></>} defaultExpanded={true}>
<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>
Example
Update audit log settings
An actor triggers this event when they update the audit log settings. If the change updated the S3 Bucket name, this event will appear in the new S3 bucket (the configured S3 Bucket after the change).
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_AUDIT_LOGS_SETTINGS
**Available values:** The only valid value is `UPDATE_AUDIT_LOGS_SETTINGS`.
</Prop.Extras>
</Prop>
<Prop name="changed_fields" type="string[]" mode="output"> The configuration settings the actor requested changes for.
<Prop.Extras>
**Available values:**
* `REGION`: The region of the AWS S3 bucket.
* `S3_BUCKET_NAME`: The name of your Canva audit logs S3 bucket.
* `S3_KEY_PREFIX`: An optional S3 key prefix.
* `ROLE_ARN`: The Amazon Resource Name (ARN) of the AWS Role that Canva uses to access the S3 bucket.
</Prop.Extras>
</Prop>
<Prop name="old_region" type="string" mode="output"> The old region of the AWS S3 bucket. </Prop>
<Prop name="new_region" type="string" mode="output"> The new region of the AWS S3 bucket. </Prop>
<Prop name="old_s3_bucket_name" type="string" mode="output"> The old name of your Canva audit logs S3 bucket. </Prop>
<Prop name="new_s3_bucket_name" type="string" mode="output"> The new name of your Canva audit logs S3 bucket. </Prop>
<Prop name="old_s3_key_prefix" type="string" mode="output"> The old S3 key prefix. </Prop>
<Prop name="new_s3_key_prefix" type="string" mode="output"> The new S3 key prefix. </Prop>
<Prop name="old_role_arn" type="string" mode="output"> The old Amazon Resource Name (ARN) of the AWS Role that Canva uses to access the S3 bucket. </Prop>
<Prop name="new_role_arn" type="string" mode="output"> The new Amazon Resource Name (ARN) of the AWS Role that Canva uses to access the S3 bucket. </Prop> </Prop.List>
Example
Brands
Create a Brand Kit
An actor triggers this event when they create a new Brand Kit. For details, see Canva Help: Setting up Brand Kits.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_BRAND_KIT
**Available values:** The only valid value is `CREATE_BRAND_KIT`.
</Prop.Extras>
</Prop>
<Prop name="name" type="string" mode="output"> The name of the Brand Kit. </Prop> </Prop.List>
Example
Update a Brand Kit's details
An actor triggers this event when they update a Brand Kit. For details, see Canva Help: Setting up Brand Kits.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_BRAND_KIT
**Available values:** The only valid value is `UPDATE_BRAND_KIT`.
</Prop.Extras>
</Prop>
<Prop name="changed_fields" type="string[]" mode="output"> The fields the actor requested changes for in this update.
<Prop.Extras>
**Available values:**
* `NAME`: The name of the Brand Kit.
* `SHARES`: The shares of the Brand Kit.
* `FONTS`: The fonts of the Brand Kit.
* `FOLDER_LINKS`: The links to the Brand Kit folders.
* `INGREDIENT`: The ingredient of the Brand Kit.
* `ICON`: The icon of the Brand Kit.
* `GUIDELINES`: The guidelines design of the Brand Kit.
</Prop.Extras>
</Prop>
<Prop name="old_name" type="string" mode="output"> The previous name of the Brand Kit. </Prop>
<Prop name="new_name" type="string" mode="output"> The new name of the Brand Kit. </Prop>
<Prop name="old_shares" type="BrandKitShare[]" mode="output"> The shares of the Brand Kit.
<Tabs>
<Tab name="TEAM">
A team the Brand Kit is shared with.
<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="FOLDER">
A folder the Brand Kit is shared with.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `FOLDER`
**Available values:** The only valid value is `FOLDER`.
</Prop.Extras>
</Prop>
<Prop name="folder" type="AuditLogFolder" required mode="output">
A Canva folder.
<PillAccordion title={<>Properties of <strong>folder</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The folder ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the folder.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="ORGANIZATION">
An organization the Brand Kit is shared with.
<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>
<Tab name="USER">
A user the Brand Kit is shared with (within a team).
<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="GROUP">
A group the Brand Kit is shared with (within a team).
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GROUP`
**Available values:** The only valid value is `GROUP`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</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>
</Tabs>
</Prop>
<Prop name="new_shares" type="BrandKitShare[]" mode="output"> The shares of the Brand Kit.
<Tabs>
<Tab name="TEAM">
A team the Brand Kit is shared with.
<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="FOLDER">
A folder the Brand Kit is shared with.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `FOLDER`
**Available values:** The only valid value is `FOLDER`.
</Prop.Extras>
</Prop>
<Prop name="folder" type="AuditLogFolder" required mode="output">
A Canva folder.
<PillAccordion title={<>Properties of <strong>folder</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The folder ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the folder.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="ORGANIZATION">
An organization the Brand Kit is shared with.
<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>
<Tab name="USER">
A user the Brand Kit is shared with (within a team).
<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="GROUP">
A group the Brand Kit is shared with (within a team).
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GROUP`
**Available values:** The only valid value is `GROUP`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</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>
</Tabs>
</Prop>
<Prop name="old_fonts" type="BrandKitFont[]" mode="output"> The fonts of the Brand Kit.
<PillAccordion title={<>Properties of <strong>old_fonts</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the font family.
</Prop>
<Prop name="font_family" type="string" mode="output">
The name of the font family.
</Prop>
<Prop name="font_style" type="string" mode="output">
The style of the font.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_fonts" type="BrandKitFont[]" mode="output"> The fonts of the Brand Kit.
<PillAccordion title={<>Properties of <strong>new_fonts</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the font family.
</Prop>
<Prop name="font_family" type="string" mode="output">
The name of the font family.
</Prop>
<Prop name="font_style" type="string" mode="output">
The style of the font.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_folder_links" type="BrandKitFolderLink[]" mode="output"> The previous folder links to the Brand Kit.
<PillAccordion title={<>Properties of <strong>old_folder_links</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="folder" type="AuditLogFolder" required mode="output">
A Canva folder.
<PillAccordion title={<>Properties of <strong>folder</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The folder ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the folder.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="type" type="string" mode="output">
The type of the brand assets in the folder.
<Prop.Extras>
**Available values:**
* `CHARTS`: A folder with Charts.
* `GRAPHICS`: A folder with Graphics.
* `ICONS`: A folder with Icons.
* `LOGOS`: A folder with Logos.
* `PHOTOS`: A folder with Photos.
</Prop.Extras>
</Prop>
<Prop name="ingredient" type="BrandKitLinkedIngredient" mode="output">
A linked ingredient of the Brand Kit.
<PillAccordion title={<>Properties of <strong>ingredient</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
ID of the ingredient.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the ingredient.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_folder_links" type="BrandKitFolderLink[]" mode="output"> The new folder links to the Brand Kit.
<PillAccordion title={<>Properties of <strong>new_folder_links</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="folder" type="AuditLogFolder" required mode="output">
A Canva folder.
<PillAccordion title={<>Properties of <strong>folder</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The folder ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the folder.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="type" type="string" mode="output">
The type of the brand assets in the folder.
<Prop.Extras>
**Available values:**
* `CHARTS`: A folder with Charts.
* `GRAPHICS`: A folder with Graphics.
* `ICONS`: A folder with Icons.
* `LOGOS`: A folder with Logos.
* `PHOTOS`: A folder with Photos.
</Prop.Extras>
</Prop>
<Prop name="ingredient" type="BrandKitLinkedIngredient" mode="output">
A linked ingredient of the Brand Kit.
<PillAccordion title={<>Properties of <strong>ingredient</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
ID of the ingredient.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the ingredient.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_ingredient" type="BrandKitIngredient" mode="output"> An ingredient of the Brand Kit.
<PillAccordion title={<>Properties of <strong>old_ingredient</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="name" type="string" mode="output">
A name of the ingredient.
</Prop>
<Prop name="id" type="string" mode="output">
ID of the ingredient.
</Prop>
<Prop name="guidelines" type="string" mode="output">
User-provided guidelines to help members of the team understand how, where, and when to use the ingredient.
</Prop>
<Prop name="color_palettes" type="BrandKitColorPalette[]" mode="output">
The color palettes of the Brand Kit.
<PillAccordion title={<>Properties of <strong>color_palettes</strong></>}>
<Prop.List>
<Prop name="name" type="string" mode="output">
The name of the color palette.
</Prop>
<Prop name="colors" type="BrandKitColor[]" mode="output">
The colors in the palette.
<PillAccordion title={<>Properties of <strong>colors</strong></>}>
<Prop.List>
<Prop name="name" type="string" mode="output">
The name of the color.
</Prop>
<Prop name="hex" type="string" mode="output">
The hex value of the color.
</Prop>
<Prop name="cmyk" type="string" mode="output">
The CMYK value of the color.
</Prop>
<Prop name="gradient" type="BrandKitGradient" mode="output">
A color gradient in the Brand Kit.
<Tabs>
<Tab name="LINEAR">
A linear gradient in the Brand Kit.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `LINEAR`
**Available values:** The only valid value is `LINEAR`.
</Prop.Extras>
</Prop>
<Prop name="stops" type="BrandKitGradientStop[]" required mode="output">
The color stops in the gradient.
<PillAccordion title={<>Properties of <strong>stops</strong></>}>
<Prop.List>
<Prop name="color" type="string" required mode="output">
The color of the stop.
</Prop>
<Prop name="transparency" type="number" required mode="output">
The transparency of the stop.
</Prop>
<Prop name="position" type="number" required mode="output">
The position of the stop as a percentage along the gradient line.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="rotation" type="number" required mode="output">
The rotation of the gradient in degrees.
</Prop>
</Prop.List>
</Tab>
<Tab name="RADIAL">
A radial gradient in the Brand Kit.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `RADIAL`
**Available values:** The only valid value is `RADIAL`.
</Prop.Extras>
</Prop>
<Prop name="stops" type="BrandKitGradientStop[]" required mode="output">
The color stops in the gradient.
<PillAccordion title={<>Properties of <strong>stops</strong></>}>
<Prop.List>
<Prop name="color" type="string" required mode="output">
The color of the stop.
</Prop>
<Prop name="transparency" type="number" required mode="output">
The transparency of the stop.
</Prop>
<Prop name="position" type="number" required mode="output">
The position of the stop as a percentage along the gradient line.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="center" type="object" required mode="output">
The center of the radial gradient. If the `top` and `left` are both zero, the center
is in the top-left of the gradient.
<PillAccordion title={<>Properties of <strong>center</strong></>}>
<Prop.List>
<Prop name="top" type="number" required mode="output">
The top position of the center, as a percentage down from the top of the gradient.
</Prop>
<Prop name="left" type="number" required mode="output">
The left position of the center, as a percentage from the left of the gradient.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="text_styles" type="BrandKitTextStylesGroup[]" mode="output">
The text styles of the Brand Kit.
<PillAccordion title={<>Properties of <strong>text_styles</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The name of the text style group.
</Prop>
<Prop name="text_styles" type="BrandKitTextStyle[]" required mode="output">
The formatting set for the text style.
<PillAccordion title={<>Properties of <strong>text_styles</strong></>}>
<Prop.List>
<Prop name="font" type="BrandKitFont" required mode="output">
A font in the Brand Kit.
<PillAccordion title={<>Properties of <strong>font</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the font family.
</Prop>
<Prop name="font_family" type="string" mode="output">
The name of the font family.
</Prop>
<Prop name="font_style" type="string" mode="output">
The style of the font.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="size" type="integer" required mode="output">
The size of the text style in pixels.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the text style.
</Prop>
<Prop name="custom_name" type="string" mode="output">
The user-defined text style name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="voice" type="string" mode="output">
The voice of the brand.
</Prop>
<Prop name="assets" type="BrandKitAsset[]" mode="output">
The assets in the ingredient.
<PillAccordion title={<>Properties of <strong>assets</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
An ID of the asset.
</Prop>
<Prop name="name" type="string" mode="output">
A name of the asset.
</Prop>
<Prop name="file_name" type="string" mode="output">
A name of the asset file.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="dos_and_donts" type="BrandKitDosAndDonts" mode="output">
The dos and donts for the ingredient
<PillAccordion title={<>Properties of <strong>dos_and_donts</strong></>}>
<Prop.List>
<Prop name="dos" type="string[]" mode="output">
The dos of the ingredient.
</Prop>
<Prop name="donts" type="string[]" mode="output">
The donts of the ingredient.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_ingredient" type="BrandKitIngredient" mode="output"> An ingredient of the Brand Kit.
<PillAccordion title={<>Properties of <strong>new_ingredient</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="name" type="string" mode="output">
A name of the ingredient.
</Prop>
<Prop name="id" type="string" mode="output">
ID of the ingredient.
</Prop>
<Prop name="guidelines" type="string" mode="output">
User-provided guidelines to help members of the team understand how, where, and when to use the ingredient.
</Prop>
<Prop name="color_palettes" type="BrandKitColorPalette[]" mode="output">
The color palettes of the Brand Kit.
<PillAccordion title={<>Properties of <strong>color_palettes</strong></>}>
<Prop.List>
<Prop name="name" type="string" mode="output">
The name of the color palette.
</Prop>
<Prop name="colors" type="BrandKitColor[]" mode="output">
The colors in the palette.
<PillAccordion title={<>Properties of <strong>colors</strong></>}>
<Prop.List>
<Prop name="name" type="string" mode="output">
The name of the color.
</Prop>
<Prop name="hex" type="string" mode="output">
The hex value of the color.
</Prop>
<Prop name="cmyk" type="string" mode="output">
The CMYK value of the color.
</Prop>
<Prop name="gradient" type="BrandKitGradient" mode="output">
A color gradient in the Brand Kit.
<Tabs>
<Tab name="LINEAR">
A linear gradient in the Brand Kit.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `LINEAR`
**Available values:** The only valid value is `LINEAR`.
</Prop.Extras>
</Prop>
<Prop name="stops" type="BrandKitGradientStop[]" required mode="output">
The color stops in the gradient.
<PillAccordion title={<>Properties of <strong>stops</strong></>}>
<Prop.List>
<Prop name="color" type="string" required mode="output">
The color of the stop.
</Prop>
<Prop name="transparency" type="number" required mode="output">
The transparency of the stop.
</Prop>
<Prop name="position" type="number" required mode="output">
The position of the stop as a percentage along the gradient line.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="rotation" type="number" required mode="output">
The rotation of the gradient in degrees.
</Prop>
</Prop.List>
</Tab>
<Tab name="RADIAL">
A radial gradient in the Brand Kit.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `RADIAL`
**Available values:** The only valid value is `RADIAL`.
</Prop.Extras>
</Prop>
<Prop name="stops" type="BrandKitGradientStop[]" required mode="output">
The color stops in the gradient.
<PillAccordion title={<>Properties of <strong>stops</strong></>}>
<Prop.List>
<Prop name="color" type="string" required mode="output">
The color of the stop.
</Prop>
<Prop name="transparency" type="number" required mode="output">
The transparency of the stop.
</Prop>
<Prop name="position" type="number" required mode="output">
The position of the stop as a percentage along the gradient line.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="center" type="object" required mode="output">
The center of the radial gradient. If the `top` and `left` are both zero, the center
is in the top-left of the gradient.
<PillAccordion title={<>Properties of <strong>center</strong></>}>
<Prop.List>
<Prop name="top" type="number" required mode="output">
The top position of the center, as a percentage down from the top of the gradient.
</Prop>
<Prop name="left" type="number" required mode="output">
The left position of the center, as a percentage from the left of the gradient.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="text_styles" type="BrandKitTextStylesGroup[]" mode="output">
The text styles of the Brand Kit.
<PillAccordion title={<>Properties of <strong>text_styles</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The name of the text style group.
</Prop>
<Prop name="text_styles" type="BrandKitTextStyle[]" required mode="output">
The formatting set for the text style.
<PillAccordion title={<>Properties of <strong>text_styles</strong></>}>
<Prop.List>
<Prop name="font" type="BrandKitFont" required mode="output">
A font in the Brand Kit.
<PillAccordion title={<>Properties of <strong>font</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The ID of the font family.
</Prop>
<Prop name="font_family" type="string" mode="output">
The name of the font family.
</Prop>
<Prop name="font_style" type="string" mode="output">
The style of the font.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="size" type="integer" required mode="output">
The size of the text style in pixels.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the text style.
</Prop>
<Prop name="custom_name" type="string" mode="output">
The user-defined text style name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="voice" type="string" mode="output">
The voice of the brand.
</Prop>
<Prop name="assets" type="BrandKitAsset[]" mode="output">
The assets in the ingredient.
<PillAccordion title={<>Properties of <strong>assets</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
An ID of the asset.
</Prop>
<Prop name="name" type="string" mode="output">
A name of the asset.
</Prop>
<Prop name="file_name" type="string" mode="output">
A name of the asset file.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="dos_and_donts" type="BrandKitDosAndDonts" mode="output">
The dos and donts for the ingredient
<PillAccordion title={<>Properties of <strong>dos_and_donts</strong></>}>
<Prop.List>
<Prop name="dos" type="string[]" mode="output">
The dos of the ingredient.
</Prop>
<Prop name="donts" type="string[]" mode="output">
The donts of the ingredient.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_icon" type="AuditLogImage" mode="output"> A Canva image.
<PillAccordion title={<>Properties of <strong>old_icon</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The image ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the image.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_icon" type="AuditLogImage" mode="output"> A Canva image.
<PillAccordion title={<>Properties of <strong>new_icon</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The image ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the image.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_guidelines" type="AuditLogDesign" mode="output"> A Canva design.
<PillAccordion title={<>Properties of <strong>old_guidelines</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The design ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the design.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_guidelines" type="AuditLogDesign" mode="output"> A Canva design.
<PillAccordion title={<>Properties of <strong>new_guidelines</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The design ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the design.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Delete a Brand Kit
An actor triggers this event when they delete a Brand Kit. For details, see Canva Help: Setting up Brand Kits.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_BRAND_KIT
**Available values:** The only valid value is `DELETE_BRAND_KIT`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Send a brand template share notification
An actor triggers this event when they share a brand template. Canva will attempt to send an email and an in-app notification to the user the brand template is shared with (recipient).
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION
**Available values:** The only valid value is `SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION`.
</Prop.Extras>
</Prop>
<Prop name="recipient" type="ShareNotificationRecipient" required mode="output"> The recipient of the share notification.
The recipient can be a user, a group, an organization, or an email address.
<Tabs>
<Tab name="USER_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `USER_RECIPIENT`
**Available values:** The only valid value is `USER_RECIPIENT`.
</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.List>
</Tab>
<Tab name="GROUP_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GROUP_RECIPIENT`
**Available values:** The only valid value is `GROUP_RECIPIENT`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="ORGANIZATION_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `ORGANIZATION_RECIPIENT`
**Available values:** The only valid value is `ORGANIZATION_RECIPIENT`.
</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="EMAIL_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `EMAIL_RECIPIENT`
**Available values:** The only valid value is `EMAIL_RECIPIENT`.
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address the design invite was sent to.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="message" type="string" mode="output"> An optional message from the actor to the recipient. </Prop> </Prop.List>
Example
Content
Transfer ownership of user content within a team
An actor triggers this event when they change the owner of a user's content (such as designs, folders, and assets) to another user on their Team. For details transferring content ownership, see Canva Help: Transfer Designs.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: INITIATE_OWNERSHIP_TRANSFER
**Available values:** The only valid value is `INITIATE_OWNERSHIP_TRANSFER`.
</Prop.Extras>
</Prop>
<Prop name="new_owner" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>new_owner</strong></>} defaultExpanded={true}>
<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.List>
Example
Copy assets, folders, or designs
An actor triggers this event when they make a copy of:
- One or more folders either within a team, or to another team.
- One or more designs or assets to another team. This event is sent to the
actor's team, not the destination team. For details on copying content between teams or accounts, see Canva Help: Copy designs or files to another team or account.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: INITIATE_CONTENT_COPY
**Available values:** The only valid value is `INITIATE_CONTENT_COPY`.
</Prop.Extras>
</Prop>
<Prop name="destination_team" type="AuditLogTeam" required mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>destination_team</strong></>} defaultExpanded={true}>
<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="reason" type="ContentCopyReason" mode="output"> The reason for the content copy operation.
<Tabs>
<Tab name="CROSS_ACCOUNT_COPY">
Content copied from one user account to another.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `CROSS_ACCOUNT_COPY`
**Available values:** The only valid value is `CROSS_ACCOUNT_COPY`.
</Prop.Extras>
</Prop>
<Prop name="source_user" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>source_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="destination_user" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>destination_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.List>
</Tab>
</Tabs>
</Prop>
<Prop name="content_copy_id" type="string" mode="output"> A unique identifier for a content copy event. This ID matches the content_copy_id for the corresponding RECEIVE_CONTENT_COPY event. </Prop> </Prop.List>
Example
Receive a copy of assets, folders, or designs
A team receives this event when they receive content from another team, or content is copied within the team, as the result of a INITIATE_CONTENT_COPY event. This event is sent to the team receiving the content, not the actor's team. For details on copying content between teams or accounts, see Canva Help: Copy designs or files to another team or account.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: RECEIVE_CONTENT_COPY
**Available values:** The only valid value is `RECEIVE_CONTENT_COPY`.
</Prop.Extras>
</Prop>
<Prop name="source_team" type="AuditLogTeam" required mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>source_team</strong></>} defaultExpanded={true}>
<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="reason" type="ContentCopyReason" mode="output"> The reason for the content copy operation.
<Tabs>
<Tab name="CROSS_ACCOUNT_COPY">
Content copied from one user account to another.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `CROSS_ACCOUNT_COPY`
**Available values:** The only valid value is `CROSS_ACCOUNT_COPY`.
</Prop.Extras>
</Prop>
<Prop name="source_user" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>source_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="destination_user" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>destination_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.List>
</Tab>
</Tabs>
</Prop>
<Prop name="content_copy_id" type="string" mode="output"> A unique identifier for a content copy event. This ID matches the content_copy_id for the corresponding INITIATE_CONTENT_COPY event. If a user retries a failed copy event, multiple RECEIVE_CONTENT_COPY events with the same content_copy_id will exist. </Prop> </Prop.List>
Example
Designs
Copy a design
An actor triggers this event when they make a copy of an existing design.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: COPY_DESIGN
**Available values:** The only valid value is `COPY_DESIGN`.
</Prop.Extras>
</Prop>
<Prop name="original_design_id" type="string" required mode="output"> The ID of the original design. </Prop>
<Prop name="title" type="string" mode="output"> Title of the new design. </Prop> </Prop.List>
Example
View a design
An actor triggers this event when they view a design. Actors viewing a publicly shared design without logging in are recorded as ANONYMOUS.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: VIEW_DESIGN
**Available values:** The only valid value is `VIEW_DESIGN`.
</Prop.Extras>
</Prop>
<Prop name="view_type" type="string" mode="output"> The activity type for viewing a design.
<Prop.Extras>
**Available values:**
* `VIEW_IN_EDITOR`: Viewed in the editor.
* `VIEW_IN_VIEWER`: Viewed in the viewer.
</Prop.Extras>
</Prop>
<Prop name="design_type" type="string" mode="output"> The type of design, such as "Presentation (16:9)", "Document", or "Instagram Post (Square)". </Prop> </Prop.List>
Example
View a design from a share link
An actor triggers this event when they open a design from a share link, and gain access to that design.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: ACCEPT_DESIGN_SHARE
**Available values:** The only valid value is `ACCEPT_DESIGN_SHARE`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Import a file to create a new design
An actor triggers this event when they import a file into Canva to create a new design. This includes uploaded presentations and PDFs, and doesn't include Canva design assets, such as images and videos.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: IMPORT_DESIGN
**Available values:** The only valid value is `IMPORT_DESIGN`.
</Prop.Extras>
</Prop>
<Prop name="title" type="string" mode="output"> The title of the imported design. </Prop>
<Prop name="file_type" type="string" mode="output"> The file type of the imported file, such as:
* `PPTX` for a Microsoft PowerPoint presentations.
* `PDF` for Portable Document Format files.
</Prop> </Prop.List>
Example
Create a design
An actor triggers this event when they create a new design in Canva. This includes when a user creates a design from a template, or using a Canva App or Canva Integration.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_DESIGN
**Available values:** The only valid value is `CREATE_DESIGN`.
</Prop.Extras>
</Prop>
<Prop name="title" type="string" mode="output"> Title of the new design. </Prop>
<Prop name="design_type" type="string" mode="output"> The type of design, such as "Presentation (16:9)", "Document", or "Instagram Post (Square)". </Prop> </Prop.List>
Example
Trash a design
An actor triggers this event when they move a design to the trash folder. Designs in the trash folder aren't accessible to collaborators and will be deleted after a period of time. For details, see: Deleting designs.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: TRASH_DESIGN
**Available values:** The only valid value is `TRASH_DESIGN`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Restore a design from Trash
An actor triggers this event when they restore a design from the trash folder. For details, see: Restoring or deleting designs or files from your Trash.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNTRASH_DESIGN
**Available values:** The only valid value is `UNTRASH_DESIGN`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Delete a design from Trash
An actor triggers this event when they permanently delete a design from the trash folder. Deleting a user's account will also delete all the designs in their trash folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_DESIGN
**Available values:** The only valid value is `DELETE_DESIGN`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Restore a deleted design
An actor triggers this event when they restore a recently deleted design. For example, when restoring a deleted user or team account, the designs deleted with the account will also be restored.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNDELETE_DESIGN
**Available values:** The only valid value is `UNDELETE_DESIGN`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update a design's access controls
An actor triggers this event when they change the rules that control access to a design. There can be multiple changes in a single update.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_DESIGN_ACCESS_CONTROLS
**Available values:** The only valid value is `UPDATE_DESIGN_ACCESS_CONTROLS`.
</Prop.Extras>
</Prop>
<Prop name="changes" type="UpdateDesignAccessControlChange[]" required mode="output"> A change to the rules that control the access to the design.
<Tabs>
<Tab name="CREATE_DESIGN_ACCESS_TOKEN">
A user created an access token that allows the design to be publicly accessible.
Examples include creating:
* A Public view link.
* An embed of a design.
* A Canva Website.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `CREATE_DESIGN_ACCESS_TOKEN`
**Available values:** The only valid value is `CREATE_DESIGN_ACCESS_TOKEN`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="token_prefix" type="string" mode="output">
The prefix of the access token for the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="DELETE_DESIGN_ACCESS_TOKEN">
A user removed an access token that allows the design to be publicly accessible,
such as deleting a Public view link.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `DELETE_DESIGN_ACCESS_TOKEN`
**Available values:** The only valid value is `DELETE_DESIGN_ACCESS_TOKEN`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="token_prefix" type="string" mode="output">
The prefix of the access token for the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="CREATE_DESIGN_ACCESS_INVITE">
A user sent an invitation to access the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `CREATE_DESIGN_ACCESS_INVITE`
**Available values:** The only valid value is `CREATE_DESIGN_ACCESS_INVITE`.
</Prop.Extras>
</Prop>
<Prop name="recipient" type="string" required mode="output">
The recipient of the invitation. This property contains the address used to share the design, such as the recipient's email address, Slack ID, or mobile number.
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="token_prefix" type="string" mode="output">
The prefix of the single-use invite token for the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="REDEEM_DESIGN_ACCESS_INVITE">
A user exchanged the invitation to access the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REDEEM_DESIGN_ACCESS_INVITE`
**Available values:** The only valid value is `REDEEM_DESIGN_ACCESS_INVITE`.
</Prop.Extras>
</Prop>
<Prop name="recipient" type="string" required mode="output">
The recipient of the invitation. This property contains the address used to share the design, such as the recipient's email address, Slack ID, or mobile number.
</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="token_prefix" type="string" mode="output">
The prefix of the single-use invite token for the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="DELETE_DESIGN_ACCESS_INVITE">
A user removed the invitation to access the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `DELETE_DESIGN_ACCESS_INVITE`
**Available values:** The only valid value is `DELETE_DESIGN_ACCESS_INVITE`.
</Prop.Extras>
</Prop>
<Prop name="recipient" type="string" required mode="output">
The recipient of the invitation. This property contains the address used to share the design, such as the recipient's email address, Slack ID, or mobile number.
</Prop>
<Prop name="token_prefix" type="string" mode="output">
The prefix of the single-use invite token for the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_DESIGN_OWNER">
The owner of the design changed when a user left the team.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_DESIGN_OWNER`
**Available values:** The only valid value is `UPDATE_DESIGN_OWNER`.
</Prop.Extras>
</Prop>
<Prop name="old_owner" type="DesignOwner" required mode="output">
<Tabs>
<Tab name="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.List>
</Tab>
<Tab name="TEAM_LIBRARY">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `TEAM_LIBRARY`
**Available values:** The only valid value is `TEAM_LIBRARY`.
</Prop.Extras>
</Prop>
<Prop name="team_library" type="AuditLogTeamLibrary" required mode="output">
A Canva Team Library.
<PillAccordion title={<>Properties of <strong>team_library</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The Team Library ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the Team Library.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="new_owner" type="DesignOwner" required mode="output">
<Tabs>
<Tab name="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.List>
</Tab>
<Tab name="TEAM_LIBRARY">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `TEAM_LIBRARY`
**Available values:** The only valid value is `TEAM_LIBRARY`.
</Prop.Extras>
</Prop>
<Prop name="team_library" type="AuditLogTeamLibrary" required mode="output">
A Canva Team Library.
<PillAccordion title={<>Properties of <strong>team_library</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The Team Library ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the Team Library.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
</Prop.List>
</Tab>
<Tab name="CREATE_DESIGN_ACCESS_RESTRICTION">
A user restricted access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `CREATE_DESIGN_ACCESS_RESTRICTION`
**Available values:** The only valid value is `CREATE_DESIGN_ACCESS_RESTRICTION`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="DELETE_DESIGN_ACCESS_RESTRICTION">
A user removed an access restriction on the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `DELETE_DESIGN_ACCESS_RESTRICTION`
**Available values:** The only valid value is `DELETE_DESIGN_ACCESS_RESTRICTION`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_USER_DESIGN_ACCESS">
A user granted another user access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_USER_DESIGN_ACCESS`
**Available values:** The only valid value is `GRANT_USER_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
</Tab>
<Tab name="REVOKE_USER_DESIGN_ACCESS">
A user revoked another user's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_USER_DESIGN_ACCESS`
**Available values:** The only valid value is `REVOKE_USER_DESIGN_ACCESS`.
</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="access" type="DesignAccessLevel" mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_USER_DESIGN_ACCESS">
A user changed another user's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_USER_DESIGN_ACCESS`
**Available values:** The only valid value is `UPDATE_USER_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
</Tab>
<Tab name="GRANT_GROUP_DESIGN_ACCESS">
A user granted a group access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_GROUP_DESIGN_ACCESS`
**Available values:** The only valid value is `GRANT_GROUP_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_GROUP_DESIGN_ACCESS">
A user removed a group's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_GROUP_DESIGN_ACCESS`
**Available values:** The only valid value is `REVOKE_GROUP_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="access" type="DesignAccessLevel" mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_GROUP_DESIGN_ACCESS">
A user changed a group's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_GROUP_DESIGN_ACCESS`
**Available values:** The only valid value is `UPDATE_GROUP_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_TEAM_DESIGN_ACCESS">
A user granted a team access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_TEAM_DESIGN_ACCESS`
**Available values:** The only valid value is `GRANT_TEAM_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</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="REVOKE_TEAM_DESIGN_ACCESS">
A user removed a team's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_TEAM_DESIGN_ACCESS`
**Available values:** The only valid value is `REVOKE_TEAM_DESIGN_ACCESS`.
</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 name="access" type="DesignAccessLevel" mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_TEAM_DESIGN_ACCESS">
A user changed a team's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_TEAM_DESIGN_ACCESS`
**Available values:** The only valid value is `UPDATE_TEAM_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</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="GRANT_ORGANIZATION_DESIGN_ACCESS">
A user granted an organization access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_ORGANIZATION_DESIGN_ACCESS`
**Available values:** The only valid value is `GRANT_ORGANIZATION_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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="REVOKE_ORGANIZATION_DESIGN_ACCESS">
A user revoked an organization's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_ORGANIZATION_DESIGN_ACCESS`
**Available values:** The only valid value is `REVOKE_ORGANIZATION_DESIGN_ACCESS`.
</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 name="access" type="DesignAccessLevel" mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_ORGANIZATION_DESIGN_ACCESS">
A user changed an organization's access to the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_ORGANIZATION_DESIGN_ACCESS`
**Available values:** The only valid value is `UPDATE_ORGANIZATION_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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="GRANT_DESIGN_LINK_ACCESS">
A user created a collaboration link for the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_DESIGN_LINK_ACCESS`
**Available values:** The only valid value is `GRANT_DESIGN_LINK_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="owning_team_only" type="boolean" mode="output">
Only users in the same team as the design's owner can access the design.
If `owning_team_only` is `false`, anyone with the link can access the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_DESIGN_LINK_ACCESS">
A user revoked a collaboration link for the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_DESIGN_LINK_ACCESS`
**Available values:** The only valid value is `REVOKE_DESIGN_LINK_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="owning_team_only" type="boolean" mode="output">
Only users in the same team as the design's owner can access the design.
If `owning_team_only` is `false`, anyone with the link can access the design.
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_DESIGN_LINK_ACCESS">
A user changed a collaboration link for the design.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_DESIGN_LINK_ACCESS`
**Available values:** The only valid value is `UPDATE_DESIGN_LINK_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_link_role" type="DesignLinkRole" required mode="output">
How the design may be accessed using a collaboration link.
<PillAccordion title={<>Properties of <strong>old_link_role</strong></>}>
<Prop.List>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="owning_team_only" type="boolean" mode="output">
Only users in the same team as the design's owner can access the design.
If `owning_team_only` is `false`, anyone with the link can access the design.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_link_role" type="DesignLinkRole" required mode="output">
How the design may be accessed using a collaboration link.
<PillAccordion title={<>Properties of <strong>new_link_role</strong></>}>
<Prop.List>
<Prop name="access" type="DesignAccessLevel" required mode="output">
Whether the design's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="comment" type="boolean" mode="output">
Whether comment access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="owning_team_only" type="boolean" mode="output">
Only users in the same team as the design's owner can access the design.
If `owning_team_only` is `false`, anyone with the link can access the design.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Send a design share notification
An actor triggers this event when they share a design. Canva will attempt to send an email and an in-app notification to the user the design is shared with (recipient).
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: SEND_DESIGN_SHARE_NOTIFICATION
**Available values:** The only valid value is `SEND_DESIGN_SHARE_NOTIFICATION`.
</Prop.Extras>
</Prop>
<Prop name="recipient" type="ShareNotificationRecipient" required mode="output"> The recipient of the share notification.
The recipient can be a user, a group, an organization, or an email address.
<Tabs>
<Tab name="USER_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `USER_RECIPIENT`
**Available values:** The only valid value is `USER_RECIPIENT`.
</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.List>
</Tab>
<Tab name="GROUP_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GROUP_RECIPIENT`
**Available values:** The only valid value is `GROUP_RECIPIENT`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="ORGANIZATION_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `ORGANIZATION_RECIPIENT`
**Available values:** The only valid value is `ORGANIZATION_RECIPIENT`.
</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="EMAIL_RECIPIENT">
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `EMAIL_RECIPIENT`
**Available values:** The only valid value is `EMAIL_RECIPIENT`.
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address the design invite was sent to.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="message" type="string" mode="output"> An optional message from the actor to the recipient. </Prop>
<Prop name="invite_to_team" type="boolean" mode="output"> Whether the recipient was invited to the team containing the shared design. </Prop> </Prop.List>
Example
Request access to a design
An actor triggers this event when they request access to a design. This request is sent to the owner of the design.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: REQUEST_DESIGN_ACCESS
**Available values:** The only valid value is `REQUEST_DESIGN_ACCESS`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Grant access to a design
An actor (typically the design owner) triggers this event when they grant the requester access to their design.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: GRANT_DESIGN_ACCESS
**Available values:** The only valid value is `GRANT_DESIGN_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="requester" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>requester</strong></>} defaultExpanded={true}>
<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="access" type="string" mode="output"> A user's access level for a design.
<Prop.Extras>
**Available values:**
* `VIEW`: The user can view the design.
* `COMMENT`: The user can view and comment on the design.
* `EDIT`: The user can view, comment, edit, and modify access to the design.
</Prop.Extras>
</Prop> </Prop.List>
Example
Exports
Export a design
An actor triggers this event when they export a design. Internal Canva systems may export the design for tasks including:
- Creating template previews.
- Creating design and template thumbnails.
- Sending a design for print.
Canva Apps and Canva Integrations can also trigger the export event.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: EXPORT_DESIGN
**Available values:** The only valid value is `EXPORT_DESIGN`.
</Prop.Extras>
</Prop>
<Prop name="reason" type="ExportReason" mode="output"> The reason the design was exported. If not specified, a user, a Canva App, or a Canva integration exported the design.
<Tabs>
<Tab name="APP">
The design was exported by an app.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `APP`
**Available values:** The only valid value is `APP`.
</Prop.Extras>
</Prop>
<Prop name="app" type="AuditLogApp" required mode="output">
A Canva app.
<PillAccordion title={<>Properties of <strong>app</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The app ID.
</Prop>
<Prop name="name" type="string" mode="output">
The name of the app.
</Prop>
<Prop name="version" type="string" mode="output">
The version of the app.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="INTERNAL">
Canva internally exported the design for tasks including creating template previews,
creating design and template thumbnails, or sending a design for
print.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `INTERNAL`
**Available values:** The only valid value is `INTERNAL`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="output_type" type="string" mode="output"> The type of export.
<Prop.Extras>
**Available values:**
* `PDF`
* `JPG`
* `PNG`
* `PPTX`
* `MP4`
* `WEB`
* `GIF`
* `SVG`
* `EMAIL`
* `HTML`
* `WEBSITE`
* `DOCX`
* `CSV`
* `XLSX`
</Prop.Extras>
</Prop>
<Prop name="bulk_export_id" type="string" mode="output"> The unique identifier for a bulk export operation. This ID will be shared across all exported resources that are part of the same bulk export operation. </Prop> </Prop.List>
Example
Export a user's data and content in bulk
Note: This isn't a Data Subject Access Request (DSAR).
An actor triggers this event when they export personal data, uploads, and designs from the Login & Security settings page. A team owner can also download their team's content. For details, see Canva Help: Downloading your personal data, uploads, and designs in bulk.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: EXPORT_BULK_DOWNLOAD
**Available values:** The only valid value is `EXPORT_BULK_DOWNLOAD`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Download a user's data and content in bulk
An actor triggers this event when they visit the page showing the download URL for their bulk download request. This event doesn't record whether the user downloaded the content.
These download URLs are valid for 14 days after the user made the request.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: VIEW_BULK_DOWNLOAD_LINKS
**Available values:** The only valid value is `VIEW_BULK_DOWNLOAD_LINKS`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Folders
Update a folder's access controls
An actor triggers this event when they change the rules that control access to a folder. There can be multiple changes in a single update.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_FOLDER_ACCESS_CONTROLS
**Available values:** The only valid value is `UPDATE_FOLDER_ACCESS_CONTROLS`.
</Prop.Extras>
</Prop>
<Prop name="access_control_changes" type="UpdateFolderAccessControlChange[]" required mode="output"> A change to the rules that control the access to the folder.
<Tabs>
<Tab name="UPDATE_FOLDER_OWNER">
The owner of the folder changed when a user left the team.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_FOLDER_OWNER`
**Available values:** The only valid value is `UPDATE_FOLDER_OWNER`.
</Prop.Extras>
</Prop>
<Prop name="old_owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>old_owner</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="new_owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>new_owner</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.List>
</Tab>
<Tab name="GRANT_USER_FOLDER_ACCESS">
A user granted another user access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_USER_FOLDER_ACCESS`
**Available values:** The only valid value is `GRANT_USER_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
</Tab>
<Tab name="REVOKE_USER_FOLDER_ACCESS">
A user revoked another user's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_USER_FOLDER_ACCESS`
**Available values:** The only valid value is `REVOKE_USER_FOLDER_ACCESS`.
</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="access" type="FolderAccessLevel" mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_USER_FOLDER_ACCESS">
A user changed another user's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_USER_FOLDER_ACCESS`
**Available values:** The only valid value is `UPDATE_USER_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
</Tab>
<Tab name="GRANT_GROUP_FOLDER_ACCESS">
A user granted a group access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_GROUP_FOLDER_ACCESS`
**Available values:** The only valid value is `GRANT_GROUP_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_GROUP_FOLDER_ACCESS">
A user revoked a group's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_GROUP_FOLDER_ACCESS`
**Available values:** The only valid value is `REVOKE_GROUP_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="access" type="FolderAccessLevel" mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_GROUP_FOLDER_ACCESS">
A user changed a group's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_GROUP_FOLDER_ACCESS`
**Available values:** The only valid value is `UPDATE_GROUP_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_TEAM_FOLDER_ACCESS">
A user granted a team access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_TEAM_FOLDER_ACCESS`
**Available values:** The only valid value is `GRANT_TEAM_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</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="REVOKE_TEAM_FOLDER_ACCESS">
A user revoked a team's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_TEAM_FOLDER_ACCESS`
**Available values:** The only valid value is `REVOKE_TEAM_FOLDER_ACCESS`.
</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 name="access" type="FolderAccessLevel" mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_TEAM_FOLDER_ACCESS">
A user changed a team's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_TEAM_FOLDER_ACCESS`
**Available values:** The only valid value is `UPDATE_TEAM_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</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="GRANT_ORGANIZATION_FOLDER_ACCESS">
A user granted an organization access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_ORGANIZATION_FOLDER_ACCESS`
**Available values:** The only valid value is `GRANT_ORGANIZATION_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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="REVOKE_ORGANIZATION_FOLDER_ACCESS">
A user revoked an organization's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_ORGANIZATION_FOLDER_ACCESS`
**Available values:** The only valid value is `REVOKE_ORGANIZATION_FOLDER_ACCESS`.
</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 name="access" type="FolderAccessLevel" mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_ORGANIZATION_FOLDER_ACCESS">
A user changed an organization's access to the folder.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_ORGANIZATION_FOLDER_ACCESS`
**Available values:** The only valid value is `UPDATE_ORGANIZATION_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="FolderAccessLevel" required mode="output">
Whether the folder's content can be viewed or edited.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
Example
Add an item to a folder
An actor triggers this event when they add an item to a folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: ADD_ITEM_TO_FOLDER
**Available values:** The only valid value is `ADD_ITEM_TO_FOLDER`.
</Prop.Extras>
</Prop>
<Prop name="item" type="FolderItem" required mode="output"> An item in a folder, such as a design.
<PillAccordion title={<>Properties of <strong>item</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="item_type" type="string" required mode="output">
The type of item.
<Prop.Extras>
**Available values:**
* `FOLDER`: A folder.
* `DESIGN`: A design.
* `IMAGE`: An image.
* `VIDEO`: A video.
* `TEMPLATE`: A template.
</Prop.Extras>
</Prop>
<Prop name="id" type="string" required mode="output">
The item ID.
</Prop>
<Prop name="team" type="AuditLogTeam" 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="owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>owner</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="display_name" type="string" mode="output">
The display name of the item.
Rarely, it may be omitted for technical reasons.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Remove an item from a folder
An actor triggers this event when they remove an item from a folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: REMOVE_ITEM_FROM_FOLDER
**Available values:** The only valid value is `REMOVE_ITEM_FROM_FOLDER`.
</Prop.Extras>
</Prop>
<Prop name="item" type="FolderItem" required mode="output"> An item in a folder, such as a design.
<PillAccordion title={<>Properties of <strong>item</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="item_type" type="string" required mode="output">
The type of item.
<Prop.Extras>
**Available values:**
* `FOLDER`: A folder.
* `DESIGN`: A design.
* `IMAGE`: An image.
* `VIDEO`: A video.
* `TEMPLATE`: A template.
</Prop.Extras>
</Prop>
<Prop name="id" type="string" required mode="output">
The item ID.
</Prop>
<Prop name="team" type="AuditLogTeam" 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="owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>owner</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="display_name" type="string" mode="output">
The display name of the item.
Rarely, it may be omitted for technical reasons.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Request access to a folder
An actor triggers this event when they request access to a folder. This request is sent to the owner of the folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: REQUEST_FOLDER_ACCESS
**Available values:** The only valid value is `REQUEST_FOLDER_ACCESS`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Grant access to a folder
An actor (typically the folder owner) triggers this event when they grant the requester access to their folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: GRANT_FOLDER_ACCESS
**Available values:** The only valid value is `GRANT_FOLDER_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="requester" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>requester</strong></>} defaultExpanded={true}>
<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="access" type="string" mode="output"> A user's access level for a folder.
<Prop.Extras>
**Available values:**
* `VIEW`: The user can view the folder and its contents.
* `EDIT`: The user can view and edit the folder and its contents.
* `ADMIN`: The user can view, edit, and modify access to the folder and its contents.
</Prop.Extras>
</Prop> </Prop.List>
Example
Groups
Create a group
An actor triggers this event when they create a new Canva group. For details on creating Canva groups, see Canva Help: Creating groups.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_GROUP
**Available values:** The only valid value is `CREATE_GROUP`.
</Prop.Extras>
</Prop>
<Prop name="display_name" type="string" required mode="output"> The display name for the group. </Prop>
<Prop name="description" type="string" mode="output"> A description for the group. </Prop> </Prop.List>
Example
Update a group's details
An actor triggers this event when they update the details of a Canva group, such as the group's display name.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_GROUP
**Available values:** The only valid value is `UPDATE_GROUP`.
</Prop.Extras>
</Prop>
<Prop name="old_display_name" type="string" mode="output"> The old display name of the group. </Prop>
<Prop name="new_display_name" type="string" mode="output"> The new display name for the group. </Prop> </Prop.List>
Example
Delete a group
An actor triggers this event when they delete a Canva group.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_GROUP
**Available values:** The only valid value is `DELETE_GROUP`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Add a user to a group
An actor triggers this event when they add a Canva user to a Canva group. For details on adding users to a Canva group, see Canva Help: Creating groups — Adding people to a group.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: ADD_USER_TO_GROUP
**Available values:** The only valid value is `ADD_USER_TO_GROUP`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="role" type="string" mode="output"> The user's role within a group.
<Prop.Extras>
**Available values:**
* `MEMBER`: Group member.
* `ADMIN`: Group administrator.
</Prop.Extras>
</Prop>
<Prop name="reason" type="GroupMembershipChangeReason" mode="output"> The reason for the change.
<Tabs>
<Tab name="PROVISIONING_POLICY">
This change was triggered by an provisioning policy.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PROVISIONING_POLICY`
**Available values:** The only valid value is `PROVISIONING_POLICY`.
</Prop.Extras>
</Prop>
<Prop name="provisioning_policy" type="AuditLogProvisioningPolicy" mode="output">
A Canva provisioning policy.
<PillAccordion title={<>Properties of <strong>provisioning_policy</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The provisioning policy ID.
</Prop>
<Prop name="name" type="string" mode="output">
The provisioning policy name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Update a user in a group
An actor triggers this event when they update a Canva user's membership within a Canva group, such as changing the user's role from ADMIN to MEMBER.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_USER_IN_GROUP
**Available values:** The only valid value is `UPDATE_USER_IN_GROUP`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="new_role" type="string" mode="output"> The user's role within a group.
<Prop.Extras>
**Available values:**
* `MEMBER`: Group member.
* `ADMIN`: Group administrator.
</Prop.Extras>
</Prop>
<Prop name="old_role" type="string" mode="output"> The user's role within a group.
<Prop.Extras>
**Available values:**
* `MEMBER`: Group member.
* `ADMIN`: Group administrator.
</Prop.Extras>
</Prop> </Prop.List>
Example
Remove a user from a group
An actor triggers this event when they remove a Canva user from a Canva group. This includes users removing themselves from a group.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: REMOVE_USER_FROM_GROUP
**Available values:** The only valid value is `REMOVE_USER_FROM_GROUP`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="role" type="string" mode="output"> The user's role within a group.
<Prop.Extras>
**Available values:**
* `MEMBER`: Group member.
* `ADMIN`: Group administrator.
</Prop.Extras>
</Prop>
<Prop name="reason" type="GroupMembershipChangeReason" mode="output"> The reason for the change.
<Tabs>
<Tab name="PROVISIONING_POLICY">
This change was triggered by an provisioning policy.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PROVISIONING_POLICY`
**Available values:** The only valid value is `PROVISIONING_POLICY`.
</Prop.Extras>
</Prop>
<Prop name="provisioning_policy" type="AuditLogProvisioningPolicy" mode="output">
A Canva provisioning policy.
<PillAccordion title={<>Properties of <strong>provisioning_policy</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The provisioning policy ID.
</Prop>
<Prop name="name" type="string" mode="output">
The provisioning policy name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Investigations
Start an investigation
An actor triggers this event when they start an investigation.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: START_INVESTIGATION
**Available values:** The only valid value is `START_INVESTIGATION`.
</Prop.Extras>
</Prop>
<Prop name="owners" type="AuditLogUser[]" required mode="output"> The list of owners that are being audited in the investigation.
<PillAccordion title={<>Properties of <strong>owners</strong></>} defaultExpanded={true}>
<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="investigation_reason" type="string" mode="output"> <Prop.Extras> Available values:
* `SECURITY_INVESTIGATION`: Security investigation.
* `COMPLIANCE_INVESTIGATION`: Compliance investigation.
* `OTHER`: Other.
</Prop.Extras>
</Prop>
<Prop name="context" type="string" mode="output"> The context provided as a rationale for starting the investigation. </Prop> </Prop.List>
Example
Investigate a design
An actor triggers this event when they view a specific design during an investigation.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: INVESTIGATE_DESIGN
**Available values:** The only valid value is `INVESTIGATE_DESIGN`.
</Prop.Extras>
</Prop>
<Prop name="investigation_id" type="string" mode="output"> The ID for the investigation. This is a UUID that represents the investigation. </Prop> </Prop.List>
Example
Organizations
Update an organization's details
An actor triggers this event when they update the details of a Canva organization, such as the organization's display name.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_ORGANIZATION
**Available values:** The only valid value is `UPDATE_ORGANIZATION`.
</Prop.Extras>
</Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `ORGANIZATION_NAME`: The name of the organization.
* `DEFAULT_TEAM`: The team to provision users into by default.
* `DEFAULT_TEAM_POLICY`: The policy for determining if a user can be provisioned into a default team.
</Prop.Extras>
</Prop>
<Prop name="old_name" type="string" mode="output"> The previous name of the organization. </Prop>
<Prop name="new_name" type="string" mode="output"> The new name of the organization. </Prop>
<Prop name="default_team" type="AuditLogTeam" mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>default_team</strong></>} defaultExpanded={true}>
<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="default_team_policy" type="string" mode="output"> The policy for determining if a user can be provisioned into a default team.
<Prop.Extras>
**Available values:**
* `ADMIN_AND_UP`: Users with the `ADMIN` organization role or higher are added to the team.
* `DESIGNER_AND_UP`: Users with the `DESIGNER` organization role or higher are added to the team.
* `MEMBER_AND_UP`: Users with the `MEMBER` organization role or higher are added to the team.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update a user in an organization
An actor triggers this event when they update a Canva user's membership within a Canva organization. This includes promoting a MEMBER to BRAND_DESIGNER or ADMIN, changing roles between BRAND_DESIGNER and ADMIN, or removing a user's ADMIN or BRAND_DESIGNER role.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_USER_IN_ORGANIZATION
**Available values:** The only valid value is `UPDATE_USER_IN_ORGANIZATION`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="old_role" type="string" mode="output"> The user's role in the organization.
<Prop.Extras>
**Available values:**
* `ADMIN`: Organization admin.
* `BRAND_DESIGNER`: Organization brand designer.
* `MEMBER`: Organization member.
</Prop.Extras>
</Prop>
<Prop name="new_role" type="string" mode="output"> The user's role in the organization.
<Prop.Extras>
**Available values:**
* `ADMIN`: Organization admin.
* `BRAND_DESIGNER`: Organization brand designer.
* `MEMBER`: Organization member.
</Prop.Extras>
</Prop> </Prop.List>
Example
Add a team to the organization
An actor triggers this event when they add a Canva Team to their Canva organization.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: ADD_TEAM_TO_ORGANIZATION
**Available values:** The only valid value is `ADD_TEAM_TO_ORGANIZATION`.
</Prop.Extras>
</Prop>
<Prop name="team" type="AuditLogTeam" required mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>team</strong></>} defaultExpanded={true}>
<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>
Example
Remove a team from the organization
An actor triggers this event when they remove a Canva Team from their Canva organization.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: REMOVE_TEAM_FROM_ORGANIZATION
**Available values:** The only valid value is `REMOVE_TEAM_FROM_ORGANIZATION`.
</Prop.Extras>
</Prop>
<Prop name="team" type="AuditLogTeam" required mode="output"> A Canva team.
<PillAccordion title={<>Properties of <strong>team</strong></>} defaultExpanded={true}>
<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>
Example
Permissions And Settings
Update a Team's Permissions
An actor triggers this event when they update a team permission for a feature. For example, when a user sets MAGIC WRITE to TEAM_ADMINS, users with the TEAM ADMIN team role can access MAGIC WRITE. If an a user adds a group to a feature's team permission, all members of this group will get access to the feature regardless of the members team role.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_TEAM_PERMISSION
**Available values:** The only valid value is `UPDATE_TEAM_PERMISSION`.
</Prop.Extras>
</Prop>
<Prop name="team_permission" type="string" required mode="output"> The feature which the permission controls access too.
<Prop.Extras>
**Available values:**
* `DREAM_STUDIO`: Use Dream studio.
* `OFFLINE_DESIGNS`: Use Offline Designs.
* `CANVA_AI`: Use Canva AI (conversational AI) to brainstorm, write, and create designs.
* `MAGIC_DESIGN`: Use Magic Design.
* `MAGIC_EDIT`: Use Magic Edit.
* `MAGIC_MEDIA`: Use Magic Media.
* `TRANSFORM_INTO_DOC`: Use Transform into Doc.
* `MAGIC_WRITE`: Use Magic Write.
* `TEMPLATE_LIBRARY`: Access the templates library.
* `ASK_CANVA`: Ask Canva for AI-generated design advice.
* `NON_INDEMNIFIED_CONTENT`: Access elements and fonts not covered by Canva’s IP indemnity.
* `MAGIC_INSIGHTS`: Use Magic Insights.
* `CANVA_CODE`: Use Canva Code.
* `ACCEPT_COPIED_CONTENT_FROM_ANOTHER_TEAM`: Accept copied content from another team.
* `SHARE_DESIGNS_EXTERNALLY_VIA_LINKS`: Share designs via public view links, public embeds, websites, and collaboration links that can be shared externally.
* `SHARE_DESIGNS_TO_EXTERNAL_EMAILS`: Share designs to external emails by design access invitation or directly granting access.
* `SCHEDULE_POSTS_WITH_CONTENT_PLANNER`: Schedule posts with the Content Planner.
* `CANVA_PRINT`: Use Canva Print.
* `DOWNLOAD_DESIGNS`: Download designs or selected elements.
* `COPY_CONTENT_TO_ANOTHER_TEAM`: Send copies of their content outside the team.
* `PHOTO_ELEMENTS`: Use photo elements.
* `AUDIO_ELEMENTS`: Use audio elements.
* `VIDEO_ELEMENTS`: Use video elements.
* `GRAPHIC_ELEMENTS`: Use graphic elements.
* `STICKER_ELEMENTS`: Use sticker elements.
* `CHART_ELEMENTS`: Use chart elements.
* `TABLE_ELEMENTS`: Use table elements.
* `FRAME_ELEMENTS`: Use frame elements.
* `GRID_ELEMENTS`: Use grid elements.
* `SHAPE_ELEMENTS`: Use shape elements.
* `OTHER_ELEMENTS`: Use any other elements.
* `VIEW_EMAILS`: See other members email addresses.
* `CREATE_GROUPS`: Create groups.
* `LEAVE_TEAM`: Leave a team.
* `REFERENCE_TEAM_CONTENT_FOR_AI_GENERATED_RESPONSES`: Reference team documents when using AI to generate content.
* `MAGIC_ACTIVITIES`: Use Magic Activities.
* `GROW_CREATE`: Use Canva Grow Create
* `GROW_INSIGHTS`: Use Canva Grow Insights
* `GROW_INSPIRE`: Use Canva Grow Inspire
* `CONNECT_AD_ACCOUNTS`: Connect Ad Accounts to Canva Grow
* `MAGIC_BACKGROUND`: Use Magic Background.
* `PUBLISH_TO_WEBSITE_DOMAIN`: Publish to a website domain.
</Prop.Extras>
</Prop>
<Prop name="old_team_permission_role" type="string" mode="output"> The team role for a feature. Users who are assigned this team role will access to the feature controlled by the Permission.
<Prop.Extras>
**Available values:**
* `NO_ONE`: No team members can use the feature.
* `TEAM_ADMINS`: Team admins can use the feature.
* `TEAM_BRAND_DESIGNERS_AND_TEAM_ADMINS`: Team designers and admins can use the feature.
* `EVERYONE`: All team members can use the feature.
</Prop.Extras>
</Prop>
<Prop name="new_team_permission_role" type="string" mode="output"> The team role for a feature. Users who are assigned this team role will access to the feature controlled by the Permission.
<Prop.Extras>
**Available values:**
* `NO_ONE`: No team members can use the feature.
* `TEAM_ADMINS`: Team admins can use the feature.
* `TEAM_BRAND_DESIGNERS_AND_TEAM_ADMINS`: Team designers and admins can use the feature.
* `EVERYONE`: All team members can use the feature.
</Prop.Extras>
</Prop>
<Prop name="old_groups" type="AuditLogGroup[]" mode="output"> The Groups associated with this Permission Setting. Members of a Group included will have access to the feature regardless of the Team Role.
<PillAccordion title={<>Properties of <strong>old_groups</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_groups" type="AuditLogGroup[]" mode="output"> The Groups associated with this Permission Setting. Members of a Group included will have access to the feature regardless of the Team Role.
<PillAccordion title={<>Properties of <strong>new_groups</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Update an Organization's Permissions
An actor triggers this event when they update an organization's default permission for a feature. For example, when an organization admin sets MAGIC WRITE to TEAM_ADMINS, all users in the organization with the TEAM ADMIN team role can access MAGIC WRITE. An organization admin is able to specify whether this default permission value is overrideable by team level admins.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_ORGANIZATION_PERMISSION
**Available values:** The only valid value is `UPDATE_ORGANIZATION_PERMISSION`.
</Prop.Extras>
</Prop>
<Prop name="team_permission" type="string" required mode="output"> The feature which the permission controls access too.
<Prop.Extras>
**Available values:**
* `DREAM_STUDIO`: Use Dream studio.
* `OFFLINE_DESIGNS`: Use Offline Designs.
* `CANVA_AI`: Use Canva AI (conversational AI) to brainstorm, write, and create designs.
* `MAGIC_DESIGN`: Use Magic Design.
* `MAGIC_EDIT`: Use Magic Edit.
* `MAGIC_MEDIA`: Use Magic Media.
* `TRANSFORM_INTO_DOC`: Use Transform into Doc.
* `MAGIC_WRITE`: Use Magic Write.
* `TEMPLATE_LIBRARY`: Access the templates library.
* `ASK_CANVA`: Ask Canva for AI-generated design advice.
* `NON_INDEMNIFIED_CONTENT`: Access elements and fonts not covered by Canva’s IP indemnity.
* `MAGIC_INSIGHTS`: Use Magic Insights.
* `CANVA_CODE`: Use Canva Code.
* `ACCEPT_COPIED_CONTENT_FROM_ANOTHER_TEAM`: Accept copied content from another team.
* `SHARE_DESIGNS_EXTERNALLY_VIA_LINKS`: Share designs via public view links, public embeds, websites, and collaboration links that can be shared externally.
* `SHARE_DESIGNS_TO_EXTERNAL_EMAILS`: Share designs to external emails by design access invitation or directly granting access.
* `SCHEDULE_POSTS_WITH_CONTENT_PLANNER`: Schedule posts with the Content Planner.
* `CANVA_PRINT`: Use Canva Print.
* `DOWNLOAD_DESIGNS`: Download designs or selected elements.
* `COPY_CONTENT_TO_ANOTHER_TEAM`: Send copies of their content outside the team.
* `PHOTO_ELEMENTS`: Use photo elements.
* `AUDIO_ELEMENTS`: Use audio elements.
* `VIDEO_ELEMENTS`: Use video elements.
* `GRAPHIC_ELEMENTS`: Use graphic elements.
* `STICKER_ELEMENTS`: Use sticker elements.
* `CHART_ELEMENTS`: Use chart elements.
* `TABLE_ELEMENTS`: Use table elements.
* `FRAME_ELEMENTS`: Use frame elements.
* `GRID_ELEMENTS`: Use grid elements.
* `SHAPE_ELEMENTS`: Use shape elements.
* `OTHER_ELEMENTS`: Use any other elements.
* `VIEW_EMAILS`: See other members email addresses.
* `CREATE_GROUPS`: Create groups.
* `LEAVE_TEAM`: Leave a team.
* `REFERENCE_TEAM_CONTENT_FOR_AI_GENERATED_RESPONSES`: Reference team documents when using AI to generate content.
* `MAGIC_ACTIVITIES`: Use Magic Activities.
* `GROW_CREATE`: Use Canva Grow Create
* `GROW_INSIGHTS`: Use Canva Grow Insights
* `GROW_INSPIRE`: Use Canva Grow Inspire
* `CONNECT_AD_ACCOUNTS`: Connect Ad Accounts to Canva Grow
* `MAGIC_BACKGROUND`: Use Magic Background.
* `PUBLISH_TO_WEBSITE_DOMAIN`: Publish to a website domain.
</Prop.Extras>
</Prop>
<Prop name="old_team_overrides_enabled" type="boolean" mode="output"> Whether or not the team permission was overrideable by team admins previously. </Prop>
<Prop name="new_team_overrides_enabled" type="boolean" mode="output"> Whether or not the team permission is overrideable by team admins currently. </Prop>
<Prop name="old_team_permission_role_default" type="string" mode="output"> The team role for a feature. Users who are assigned this team role will access to the feature controlled by the Permission.
<Prop.Extras>
**Available values:**
* `NO_ONE`: No team members can use the feature.
* `TEAM_ADMINS`: Team admins can use the feature.
* `TEAM_BRAND_DESIGNERS_AND_TEAM_ADMINS`: Team designers and admins can use the feature.
* `EVERYONE`: All team members can use the feature.
</Prop.Extras>
</Prop>
<Prop name="new_team_permission_role_default" type="string" mode="output"> The team role for a feature. Users who are assigned this team role will access to the feature controlled by the Permission.
<Prop.Extras>
**Available values:**
* `NO_ONE`: No team members can use the feature.
* `TEAM_ADMINS`: Team admins can use the feature.
* `TEAM_BRAND_DESIGNERS_AND_TEAM_ADMINS`: Team designers and admins can use the feature.
* `EVERYONE`: All team members can use the feature.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update an Organization's settings
An actor triggers this event when they update an organization setting.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_ORGANIZATION_SETTING
**Available values:** The only valid value is `UPDATE_ORGANIZATION_SETTING`.
</Prop.Extras>
</Prop>
<Prop name="setting" type="string" required mode="output"> The name of the setting that was updated.
<Prop.Extras>
**Available values:**
* `PERSONAL_TEAM_ARCHIVING_ENABLED`: Automatically archive any personal teams that your managed members may have.
* `SHARE_DESIGNS_WITH_CANVA_SUPPORT_ENABLED`: Allows or prevents members of a Canva organization from temporarily sharing affected designs with Canva Support during support requests.
* `INVESTIGATIONS_ENABLED`: Allows organisation admins to access private content that hasn’t been shared with them. This access is for security and compliance investigations only and is always audit logged.
* `DESIGN_ACTIVITY_REPORT_ENABLED`: When turned on, admins can access the design activity report which shows insights about team designs.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update data residency region
An actor triggers this event when they update the data residency region.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_DATA_RESIDENCY_REGION_SETTING
**Available values:** The only valid value is `UPDATE_DATA_RESIDENCY_REGION_SETTING`.
</Prop.Extras>
</Prop>
<Prop name="new_region" type="string" required mode="output"> The data residency region.
<Prop.Extras>
**Available values:**
* `US`: United States
* `EU`: Europe
* `ANY`: No preference
</Prop.Extras>
</Prop>
<Prop name="old_region" type="string" mode="output"> The data residency region.
<Prop.Extras>
**Available values:**
* `US`: United States
* `EU`: Europe
* `ANY`: No preference
</Prop.Extras>
</Prop> </Prop.List>
Example
Teams
Update a team's details
An actor triggers this event when they update the details of a Canva Team, such as the team's display name.
We only log the team properties that the actor requested changes for. The changed fields are listed in the changed_fields array.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_TEAM
**Available values:** The only valid value is `UPDATE_TEAM`.
</Prop.Extras>
</Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `TEAM_NAME`: The team name.
* `DISPLAY_NAME`: The team's display name as shown in the Canva UI.
* `THIRD_PARTY`: Whether this team represents a third party integration.
* `BILLING_INFO`: Billing information for the team.
* `WEBSITE_URL`: The website URL for the team.
* `ADDRESS`: The team's address.
* `EXTERNAL_LINKS`: Links to teams or other entities within external identity providers.
* `BRAND_COLORS_ONLY`: Whether the team is restricted to brand colors.
* `BRAND_FONTS_ONLY`: Whether the team is restricted to brand fonts.
</Prop.Extras>
</Prop>
<Prop name="team_name" type="string" mode="output"> The team name. </Prop>
<Prop name="display_name" type="string" mode="output"> The team's display name. This is used to represent the team with text in a UI. </Prop>
<Prop name="third_party_integrated" type="boolean" mode="output"> Whether this team represents a third-party integrated application. </Prop>
<Prop name="billing_info" type="object" mode="output"> Billing information for the team.
<PillAccordion title={<>Properties of <strong>billing_info</strong></>} defaultExpanded={true}>
<Prop.List />
</PillAccordion>
</Prop>
<Prop name="team_address" type="object" mode="output"> Address for the team.
<PillAccordion title={<>Properties of <strong>team_address</strong></>} defaultExpanded={true}>
<Prop.List />
</PillAccordion>
</Prop>
<Prop name="external_links" type="TeamExternalLink[]" mode="output"> Represents a link to teams or other entities within external identity providers.
<PillAccordion title={<>Properties of <strong>external_links</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="source" type="string" mode="output">
The source of the external link.
<Prop.Extras>
**Available values:**
* `ONE_ROSTER`: A OneRoster system.
* `MANUAL`: Manual imports, such as Canva customer support performing the import.
</Prop.Extras>
</Prop>
<Prop name="managing_team" type="object" mode="output">
Represents the managing team with the associated external configuration.
When `source` is `MANUAL`, users managed by the managing team are
provisioned into this team as a fallback.
<PillAccordion title={<>Properties of <strong>managing_team</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The managing team ID.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="external_id" type="string" mode="output">
Included when `source` is not `MANUAL`.
Otherwise, this is the SSO identity provider or OneRoster external ID associated with the team.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="website_url" type="string" mode="output"> The website URL for the team. </Prop>
<Prop name="brand_fonts_only" type="boolean" mode="output"> Whether the team is restricted to brand fonts. </Prop>
<Prop name="brand_colors_only" type="boolean" mode="output"> Whether the team is restricted to brand colors. </Prop> </Prop.List>
Example
Delete a team
An actor triggers this event when they delete a Canva Team. For details on deleting a Canva team, see Canva Help: Managing and deleting teams — Deleting a team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_TEAM
**Available values:** The only valid value is `DELETE_TEAM`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Cancel the deletion of a team
An actor triggers this event when they cancel or undo the deletion of a Canva Team. For details on deleting a Canva team, see Canva Help: Managing and deleting teams — Canceling or undoing team deletion.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNDELETE_TEAM
**Available values:** The only valid value is `UNDELETE_TEAM`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Add a user to a team
An actor triggers this event when they add a Canva user to a Canva team. For details on adding users to a Canva team, see Canva Help: Adding or removing people in a team or class — Inviting users to join your team.
The reason field contains the reason the user was added to the team. For example, they accepted a team invitation or they were provisioned by a SCIM provider.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: ADD_USER_TO_TEAM
**Available values:** The only valid value is `ADD_USER_TO_TEAM`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="role" type="string" mode="output"> The user's role within a team.
<Prop.Extras>
**Available values:**
* `MEMBER`: Team member.
* `DESIGNER`: Team designer.
* `ADMIN`: Team administrator.
* `OWNER`: Team owner.
</Prop.Extras>
</Prop>
<Prop name="reason" type="TeamMembershipChangeReason" mode="output"> The reason for the change.
<Tabs>
<Tab name="INVITATION_ACCEPTED">
An invitation to join team was accepted
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `INVITATION_ACCEPTED`
**Available values:** The only valid value is `INVITATION_ACCEPTED`.
</Prop.Extras>
</Prop>
<Prop name="inviter" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>inviter</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.List>
</Tab>
<Tab name="JOIN_POLICY_ALLOWED">
The change was permitted by your Team discovery and settings.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `JOIN_POLICY_ALLOWED`
**Available values:** The only valid value is `JOIN_POLICY_ALLOWED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="REQUEST_TO_JOIN_APPROVED">
A user request to join your team was approved.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REQUEST_TO_JOIN_APPROVED`
**Available values:** The only valid value is `REQUEST_TO_JOIN_APPROVED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="SCIM">
The change was made through your team's configured SCIM Identity 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="SAML_JIT_PROVISIONING">
SAML Just-In-Time provisioning. This event can be triggered by events like a user
linking their Canva account with your SSO provider
or when you set up Single Sign-On (SSO) for your
team.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `SAML_JIT_PROVISIONING`
**Available values:** The only valid value is `SAML_JIT_PROVISIONING`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="PROVISIONING_POLICY">
This change was triggered by an provisioning policy.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PROVISIONING_POLICY`
**Available values:** The only valid value is `PROVISIONING_POLICY`.
</Prop.Extras>
</Prop>
<Prop name="provisioning_policy" type="AuditLogProvisioningPolicy" mode="output">
A Canva provisioning policy.
<PillAccordion title={<>Properties of <strong>provisioning_policy</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The provisioning policy ID.
</Prop>
<Prop name="name" type="string" mode="output">
The provisioning policy name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Update a user in a team
An actor triggers this event when they update a Canva user's membership within a Canva team, such as changing the user's role from ADMIN to MEMBER. For details on the different team roles, see Canva Help: Team roles and permissions.
The reason field contains the reason the user was updated in the team. For example, their details were updated by a SCIM provider.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_USER_IN_TEAM
**Available values:** The only valid value is `UPDATE_USER_IN_TEAM`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="new_role" type="string" mode="output"> The user's role within a team.
<Prop.Extras>
**Available values:**
* `MEMBER`: Team member.
* `DESIGNER`: Team designer.
* `ADMIN`: Team administrator.
* `OWNER`: Team owner.
</Prop.Extras>
</Prop>
<Prop name="old_role" type="string" mode="output"> The user's role within a team.
<Prop.Extras>
**Available values:**
* `MEMBER`: Team member.
* `DESIGNER`: Team designer.
* `ADMIN`: Team administrator.
* `OWNER`: Team owner.
</Prop.Extras>
</Prop>
<Prop name="reason" type="TeamMembershipChangeReason" mode="output"> The reason for the change.
<Tabs>
<Tab name="INVITATION_ACCEPTED">
An invitation to join team was accepted
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `INVITATION_ACCEPTED`
**Available values:** The only valid value is `INVITATION_ACCEPTED`.
</Prop.Extras>
</Prop>
<Prop name="inviter" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>inviter</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.List>
</Tab>
<Tab name="JOIN_POLICY_ALLOWED">
The change was permitted by your Team discovery and settings.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `JOIN_POLICY_ALLOWED`
**Available values:** The only valid value is `JOIN_POLICY_ALLOWED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="REQUEST_TO_JOIN_APPROVED">
A user request to join your team was approved.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REQUEST_TO_JOIN_APPROVED`
**Available values:** The only valid value is `REQUEST_TO_JOIN_APPROVED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="SCIM">
The change was made through your team's configured SCIM Identity 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="SAML_JIT_PROVISIONING">
SAML Just-In-Time provisioning. This event can be triggered by events like a user
linking their Canva account with your SSO provider
or when you set up Single Sign-On (SSO) for your
team.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `SAML_JIT_PROVISIONING`
**Available values:** The only valid value is `SAML_JIT_PROVISIONING`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="PROVISIONING_POLICY">
This change was triggered by an provisioning policy.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PROVISIONING_POLICY`
**Available values:** The only valid value is `PROVISIONING_POLICY`.
</Prop.Extras>
</Prop>
<Prop name="provisioning_policy" type="AuditLogProvisioningPolicy" mode="output">
A Canva provisioning policy.
<PillAccordion title={<>Properties of <strong>provisioning_policy</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The provisioning policy ID.
</Prop>
<Prop name="name" type="string" mode="output">
The provisioning policy name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Remove a user from a team
An actor triggers this event when they remove a Canva user from a Canva team. This includes users removing themselves from a team.
The reason field contains the reason the user was removed from the team. For example, they were removed by a SCIM provider.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: REMOVE_USER_FROM_TEAM
**Available values:** The only valid value is `REMOVE_USER_FROM_TEAM`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="role" type="string" mode="output"> The user's role within a team.
<Prop.Extras>
**Available values:**
* `MEMBER`: Team member.
* `DESIGNER`: Team designer.
* `ADMIN`: Team administrator.
* `OWNER`: Team owner.
</Prop.Extras>
</Prop>
<Prop name="reason" type="TeamMembershipChangeReason" mode="output"> The reason for the change.
<Tabs>
<Tab name="INVITATION_ACCEPTED">
An invitation to join team was accepted
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `INVITATION_ACCEPTED`
**Available values:** The only valid value is `INVITATION_ACCEPTED`.
</Prop.Extras>
</Prop>
<Prop name="inviter" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>inviter</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.List>
</Tab>
<Tab name="JOIN_POLICY_ALLOWED">
The change was permitted by your Team discovery and settings.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `JOIN_POLICY_ALLOWED`
**Available values:** The only valid value is `JOIN_POLICY_ALLOWED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="REQUEST_TO_JOIN_APPROVED">
A user request to join your team was approved.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REQUEST_TO_JOIN_APPROVED`
**Available values:** The only valid value is `REQUEST_TO_JOIN_APPROVED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="SCIM">
The change was made through your team's configured SCIM Identity 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="SAML_JIT_PROVISIONING">
SAML Just-In-Time provisioning. This event can be triggered by events like a user
linking their Canva account with your SSO provider
or when you set up Single Sign-On (SSO) for your
team.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `SAML_JIT_PROVISIONING`
**Available values:** The only valid value is `SAML_JIT_PROVISIONING`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="PROVISIONING_POLICY">
This change was triggered by an provisioning policy.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PROVISIONING_POLICY`
**Available values:** The only valid value is `PROVISIONING_POLICY`.
</Prop.Extras>
</Prop>
<Prop name="provisioning_policy" type="AuditLogProvisioningPolicy" mode="output">
A Canva provisioning policy.
<PillAccordion title={<>Properties of <strong>provisioning_policy</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The provisioning policy ID.
</Prop>
<Prop name="name" type="string" mode="output">
The provisioning policy name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Request to join a team
An actor triggers this event when they request to join a team and the team's settings require an administrator to approve before they can join. For information on users joining teams, see Canva Help: Joining teams.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_TEAM_JOIN_REQUEST
**Available values:** The only valid value is `CREATE_TEAM_JOIN_REQUEST`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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.List>
Example
Update a user's request to join a team
An actor triggers this event when they update a user's request to join a team. For example, an administrator approved another user's request to join a team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_TEAM_JOIN_REQUEST
**Available values:** The only valid value is `UPDATE_TEAM_JOIN_REQUEST`.
</Prop.Extras>
</Prop>
<Prop name="user" type="AuditLogUser" required mode="output"> A Canva user.
<PillAccordion title={<>Properties of <strong>user</strong></>} defaultExpanded={true}>
<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="approval_status" type="string" required mode="output"> The status of a request or invite to join a team.
<Prop.Extras>
**Available values:**
* `PENDING`: The request is pending.
* `APPROVED`: An administrator approved the request.
* `REJECTED`: An administrator rejected the request.
</Prop.Extras>
</Prop> </Prop.List>
Example
Request to invite a user into a team
A non-administrator actor triggers this event when they create a request to invite user to join a team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_TEAM_INVITATION_REQUEST
**Available values:** The only valid value is `CREATE_TEAM_INVITATION_REQUEST`.
</Prop.Extras>
</Prop>
<Prop name="emails" type="string[]" required mode="output"> A list of emails invited to join the team. These emails might not be linked to existing Canva accounts. </Prop> </Prop.List>
Example
Update a request to invite a user into a team
An actor triggers this event when they update a non-administrator's request to invite a user to join a team. For example, an administrator approved a user's request to invite another user to join a team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_TEAM_INVITATION_REQUEST
**Available values:** The only valid value is `UPDATE_TEAM_INVITATION_REQUEST`.
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output"> The email invited to join the team. </Prop>
<Prop name="approval_status" type="string" required mode="output"> The status of a request or invite to join a team.
<Prop.Extras>
**Available values:**
* `PENDING`: The request is pending.
* `APPROVED`: An administrator approved the request.
* `REJECTED`: An administrator rejected the request.
</Prop.Extras>
</Prop> </Prop.List>
Example
Export a team report
An actor triggers this event when they export a team report. For details on these reports, see Canva Help: Checking team analytics and reports.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: EXPORT_TEAM_REPORT
**Available values:** The only valid value is `EXPORT_TEAM_REPORT`.
</Prop.Extras>
</Prop>
<Prop name="report_type" type="string" mode="output"> The type of team activity report.
<Prop.Extras>
**Available values:**
* `TEAM_MEMBER_ACTIVITY`: Team member activity. This includes the team member role, when they were last active, and the number of designs that they have created, published, shared, and viewed.
* `BRAND_TEMPLATE_ACTIVITY`: Brand template activity. This includes the number of times a brand template was used, published, or shared.
* `BRAND_KIT_ACTIVITY`: Brand Kit activity. This includes the number of times a Brand Kit was applied.
* `BRAND_KIT_DESIGN_ACTIVITY`: Brand Kit design activity. This includes either the designs using a specific Brand Kit, or designs not using any Brand Kits.
</Prop.Extras>
</Prop>
<Prop name="start_timestamp" type="integer" mode="output"> The start of the report's time window, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop>
<Prop name="end_timestamp" type="integer" mode="output"> The end of the report's time window, as a Unix timestamp (in milliseconds since the Unix Epoch). </Prop> </Prop.List>
Example
Templates
Publish a template
An actor triggers this event when they publish a template
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: PUBLISH_TEMPLATE
**Available values:** The only valid value is `PUBLISH_TEMPLATE`.
</Prop.Extras>
</Prop>
<Prop name="template_type" type="string" mode="output"> The type of a template
<Prop.Extras>
**Available values:**
* `DESIGN`: A design template
* `ELEMENT`: An element template
</Prop.Extras>
</Prop>
<Prop name="template_domain" type="string" mode="output"> The domain of a template
<Prop.Extras>
**Available values:** The only valid value is `BRAND`: Brand domain.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update a template's details
An actor triggers this event when they update a template
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_TEMPLATE
**Available values:** The only valid value is `UPDATE_TEMPLATE`.
</Prop.Extras>
</Prop>
<Prop name="template_type" type="string" mode="output"> The type of a template
<Prop.Extras>
**Available values:**
* `DESIGN`: A design template
* `ELEMENT`: An element template
</Prop.Extras>
</Prop>
<Prop name="template_domain" type="string" mode="output"> The domain of a template
<Prop.Extras>
**Available values:** The only valid value is `BRAND`: Brand domain.
</Prop.Extras>
</Prop>
<Prop name="new_title" type="string" mode="output"> The new title of the template </Prop>
<Prop name="old_title" type="string" mode="output"> The old title of the template. </Prop>
<Prop name="new_description" type="string" mode="output"> The new description of the template </Prop>
<Prop name="old_description" type="string" mode="output"> The old description of the template. </Prop>
<Prop name="new_keywords" type="string[]" mode="output"> The new keywords of the template </Prop>
<Prop name="old_keywords" type="string[]" mode="output"> The old keywords of the template </Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `TITLE`: The template's title
* `DESCRIPTION`: The template's description
* `KEYWORDS`: The template's keywords
</Prop.Extras>
</Prop> </Prop.List>
Example
Delete a template
An actor triggers this event when they delete a template.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_TEMPLATE
**Available values:** The only valid value is `DELETE_TEMPLATE`.
</Prop.Extras>
</Prop>
<Prop name="template_type" type="string" mode="output"> The type of a template
<Prop.Extras>
**Available values:**
* `DESIGN`: A design template
* `ELEMENT`: An element template
</Prop.Extras>
</Prop>
<Prop name="template_domain" type="string" mode="output"> The domain of a template
<Prop.Extras>
**Available values:** The only valid value is `BRAND`: Brand domain.
</Prop.Extras>
</Prop> </Prop.List>
Example
Restore a deleted template
An actor triggers this event when they restore a deleted template.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNDELETE_TEMPLATE
**Available values:** The only valid value is `UNDELETE_TEMPLATE`.
</Prop.Extras>
</Prop>
<Prop name="template_type" type="string" mode="output"> The type of a template
<Prop.Extras>
**Available values:**
* `DESIGN`: A design template
* `ELEMENT`: An element template
</Prop.Extras>
</Prop>
<Prop name="template_domain" type="string" mode="output"> The domain of a template
<Prop.Extras>
**Available values:** The only valid value is `BRAND`: Brand domain.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update a template's access controls
An actor triggers this event when they update the access control list of a template.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_TEMPLATE_ACCESS_CONTROLS
**Available values:** The only valid value is `UPDATE_TEMPLATE_ACCESS_CONTROLS`.
</Prop.Extras>
</Prop>
<Prop name="changes" type="TemplateAccessControlChange[]" required mode="output"> List of access control changes made to the template
<Tabs>
<Tab name="GRANT_USER_TEMPLATE_ACCESS">
Grant template access to a user
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_USER_TEMPLATE_ACCESS`
**Available values:** The only valid value is `GRANT_USER_TEMPLATE_ACCESS`.
</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="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_USER_TEMPLATE_ACCESS">
Revoke template access from a user
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_USER_TEMPLATE_ACCESS`
**Available values:** The only valid value is `REVOKE_USER_TEMPLATE_ACCESS`.
</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="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_USER_TEMPLATE_ACCESS">
Update template access from a user
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_USER_TEMPLATE_ACCESS`
**Available values:** The only valid value is `UPDATE_USER_TEMPLATE_ACCESS`.
</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="new_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_TEAM_TEMPLATE_ACCESS">
Grant template access to a team
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_TEAM_TEMPLATE_ACCESS`
**Available values:** The only valid value is `GRANT_TEAM_TEMPLATE_ACCESS`.
</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 name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="role" type="string" mode="output">
Identity context roles assignable to access control principals
<Prop.Extras>
**Available values:**
* `ORGANIZATION_ADMIN`: The admin of the organization
* `ORGANIZATION_TEAM_MANAGER`: The team manager of the organization
* `TEAM_OWNER`: The owner of the team
* `TEAM_ADMIN`: The admin of the team
* `TEAM_DESIGNER`: The designer of the team
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_TEAM_TEMPLATE_ACCESS">
Revoke template access from a team
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_TEAM_TEMPLATE_ACCESS`
**Available values:** The only valid value is `REVOKE_TEAM_TEMPLATE_ACCESS`.
</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 name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="role" type="string" mode="output">
Identity context roles assignable to access control principals
<Prop.Extras>
**Available values:**
* `ORGANIZATION_ADMIN`: The admin of the organization
* `ORGANIZATION_TEAM_MANAGER`: The team manager of the organization
* `TEAM_OWNER`: The owner of the team
* `TEAM_ADMIN`: The admin of the team
* `TEAM_DESIGNER`: The designer of the team
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_TEAM_TEMPLATE_ACCESS">
Update template access for a team
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_TEAM_TEMPLATE_ACCESS`
**Available values:** The only valid value is `UPDATE_TEAM_TEMPLATE_ACCESS`.
</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 name="new_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="role" type="string" mode="output">
Identity context roles assignable to access control principals
<Prop.Extras>
**Available values:**
* `ORGANIZATION_ADMIN`: The admin of the organization
* `ORGANIZATION_TEAM_MANAGER`: The team manager of the organization
* `TEAM_OWNER`: The owner of the team
* `TEAM_ADMIN`: The admin of the team
* `TEAM_DESIGNER`: The designer of the team
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_GROUP_TEMPLATE_ACCESS">
Grant template access to a group
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_GROUP_TEMPLATE_ACCESS`
**Available values:** The only valid value is `GRANT_GROUP_TEMPLATE_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_GROUP_TEMPLATE_ACCESS">
Revoke template access from a group
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_GROUP_TEMPLATE_ACCESS`
**Available values:** The only valid value is `REVOKE_GROUP_TEMPLATE_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_GROUP_TEMPLATE_ACCESS">
Update template access from a group
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_GROUP_TEMPLATE_ACCESS`
**Available values:** The only valid value is `UPDATE_GROUP_TEMPLATE_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_ORGANIZATION_TEMPLATE_ACCESS">
Grant template access to an organization
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_ORGANIZATION_TEMPLATE_ACCESS`
**Available values:** The only valid value is `GRANT_ORGANIZATION_TEMPLATE_ACCESS`.
</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 name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="role" type="string" mode="output">
Identity context roles assignable to access control principals
<Prop.Extras>
**Available values:**
* `ORGANIZATION_ADMIN`: The admin of the organization
* `ORGANIZATION_TEAM_MANAGER`: The team manager of the organization
* `TEAM_OWNER`: The owner of the team
* `TEAM_ADMIN`: The admin of the team
* `TEAM_DESIGNER`: The designer of the team
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_ORGANIZATION_TEMPLATE_ACCESS">
Revoke template access from an organization
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_ORGANIZATION_TEMPLATE_ACCESS`
**Available values:** The only valid value is `REVOKE_ORGANIZATION_TEMPLATE_ACCESS`.
</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 name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="role" type="string" mode="output">
Identity context roles assignable to access control principals
<Prop.Extras>
**Available values:**
* `ORGANIZATION_ADMIN`: The admin of the organization
* `ORGANIZATION_TEAM_MANAGER`: The team manager of the organization
* `TEAM_OWNER`: The owner of the team
* `TEAM_ADMIN`: The admin of the team
* `TEAM_DESIGNER`: The designer of the team
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_ORGANIZATION_TEMPLATE_ACCESS">
Update template access for an organization
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_ORGANIZATION_TEMPLATE_ACCESS`
**Available values:** The only valid value is `UPDATE_ORGANIZATION_TEMPLATE_ACCESS`.
</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 name="new_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="role" type="string" mode="output">
Identity context roles assignable to access control principals
<Prop.Extras>
**Available values:**
* `ORGANIZATION_ADMIN`: The admin of the organization
* `ORGANIZATION_TEAM_MANAGER`: The team manager of the organization
* `TEAM_OWNER`: The owner of the team
* `TEAM_ADMIN`: The admin of the team
* `TEAM_DESIGNER`: The designer of the team
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_PUBLIC_LINK_TEMPLATE_ACCESS">
Grant template access to a public share link
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_PUBLIC_LINK_TEMPLATE_ACCESS`
**Available values:** The only valid value is `GRANT_PUBLIC_LINK_TEMPLATE_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_PUBLIC_LINK_TEMPLATE_ACCESS">
Revoke template access from a public share link
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_PUBLIC_LINK_TEMPLATE_ACCESS`
**Available values:** The only valid value is `REVOKE_PUBLIC_LINK_TEMPLATE_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_TEAM_LINK_TEMPLATE_ACCESS">
Grant template access to a team share link
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_TEAM_LINK_TEMPLATE_ACCESS`
**Available values:** The only valid value is `GRANT_TEAM_LINK_TEMPLATE_ACCESS`.
</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 name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_TEAM_LINK_TEMPLATE_ACCESS">
Revoke template access from a team share link
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_TEAM_LINK_TEMPLATE_ACCESS`
**Available values:** The only valid value is `REVOKE_TEAM_LINK_TEMPLATE_ACCESS`.
</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 name="access" type="TemplateAccessLevel" required mode="output">
Template access level
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether the user can view the template.
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether the user can edit the template content.
</Prop>
<Prop name="share_view_access" type="boolean" required mode="output">
Whether the user can share the template with others to view.
</Prop>
<Prop name="share_edit_access" type="boolean" required mode="output">
Whether the user can share the template with others view and edit.
</Prop>
<Prop name="delete" type="boolean" required mode="output">
Whether the user can delete the template.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop>
<Prop name="template_type" type="string" mode="output"> The type of a template
<Prop.Extras>
**Available values:**
* `DESIGN`: A design template
* `ELEMENT`: An element template
</Prop.Extras>
</Prop>
<Prop name="template_domain" type="string" mode="output"> The domain of a template
<Prop.Extras>
**Available values:** The only valid value is `BRAND`: Brand domain.
</Prop.Extras>
</Prop> </Prop.List>
Example
Users
Create a user
An actor triggers this event when they create (or provision) a new Canva user, including when an individual creates a Canva user account by visiting a team invitation link.
The reason field contains the reason the user was created. For example, they accepted a team invitation or they were provisioned by a SCIM provider.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_USER
**Available values:** The only valid value is `CREATE_USER`.
</Prop.Extras>
</Prop>
<Prop name="display_name" type="string" mode="output"> The user's display name. This is used to represent the user with text in a UI. </Prop>
<Prop name="first_name" type="string" mode="output"> The user's first name. </Prop>
<Prop name="last_name" type="string" mode="output"> The user's last name. </Prop>
<Prop name="email" type="string" mode="output"> The user's email address. </Prop>
<Prop name="email_verified" type="boolean" mode="output"> Whether the user's email address has been verified. </Prop>
<Prop name="phone_number" type="string" mode="output"> The user's phone number. </Prop>
<Prop name="country_code" type="string" mode="output"> The user's country code, shown on user's public profile page. </Prop>
<Prop name="locale" type="string" mode="output"> The supported locale for the user. </Prop>
<Prop name="managing_entity" type="ManagingEntity" mode="output"> The entity that manages the user.
<Tabs>
<Tab name="TEAM">
A managing entity 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">
A managing entity 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="saml_accounts" type="SamlAccount[]" mode="output"> SAML accounts for the user.
<PillAccordion title={<>Properties of <strong>saml_accounts</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="idp_issuer" type="string" required mode="output">
A unique identifier for the SAML identity provider.
</Prop>
<Prop name="name_id" type="string" required mode="output">
The unique identifier for the user, within the scope of `idp_issuer`. This value is often an email address.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="oauth_accounts" type="OauthAccount[]" mode="output"> OAuth accounts for the user.
<PillAccordion title={<>Properties of <strong>oauth_accounts</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="platform" type="string" required mode="output">
The OAuth platform.
</Prop>
<Prop name="external_user_id" type="string" required mode="output">
The account ID for the user on the external platform.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="totp_mfa_enabled" type="boolean" mode="output"> Whether TOTP MFA (Time-based One-Time Password Multi-Factor Authentication) is enabled for the user. </Prop>
<Prop name="sms_mfa_enabled" type="boolean" mode="output"> Whether SMS MFA (SMS-based Multi-Factor Authentication) is enabled for the user. </Prop>
<Prop name="reason" type="TeamMembershipChangeReason" mode="output"> The reason for the change.
<Tabs>
<Tab name="INVITATION_ACCEPTED">
An invitation to join team was accepted
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `INVITATION_ACCEPTED`
**Available values:** The only valid value is `INVITATION_ACCEPTED`.
</Prop.Extras>
</Prop>
<Prop name="inviter" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>inviter</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.List>
</Tab>
<Tab name="JOIN_POLICY_ALLOWED">
The change was permitted by your Team discovery and settings.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `JOIN_POLICY_ALLOWED`
**Available values:** The only valid value is `JOIN_POLICY_ALLOWED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="REQUEST_TO_JOIN_APPROVED">
A user request to join your team was approved.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REQUEST_TO_JOIN_APPROVED`
**Available values:** The only valid value is `REQUEST_TO_JOIN_APPROVED`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="SCIM">
The change was made through your team's configured SCIM Identity 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="SAML_JIT_PROVISIONING">
SAML Just-In-Time provisioning. This event can be triggered by events like a user
linking their Canva account with your SSO provider
or when you set up Single Sign-On (SSO) for your
team.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `SAML_JIT_PROVISIONING`
**Available values:** The only valid value is `SAML_JIT_PROVISIONING`.
</Prop.Extras>
</Prop>
</Prop.List>
</Tab>
<Tab name="PROVISIONING_POLICY">
This change was triggered by an provisioning policy.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PROVISIONING_POLICY`
**Available values:** The only valid value is `PROVISIONING_POLICY`.
</Prop.Extras>
</Prop>
<Prop name="provisioning_policy" type="AuditLogProvisioningPolicy" mode="output">
A Canva provisioning policy.
<PillAccordion title={<>Properties of <strong>provisioning_policy</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The provisioning policy ID.
</Prop>
<Prop name="name" type="string" mode="output">
The provisioning policy name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Update a user's details
An actor triggers this event when they update a user's account details. This includes when a user updates their own account details.
We only log the user properties that the actor requested changes for. The changed fields are listed in the changed_fields array.
Some changed fields, such as PASSWORD, might be in the changed_fields array but won't have a property included in the log.
If the user was updated as part of the login process, the actor might be set to ANONYMOUS.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_USER
**Available values:** The only valid value is `UPDATE_USER`.
</Prop.Extras>
</Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `PASSWORD`: The user's password.
* `DISPLAY_NAME`: The user's display name.
* `FIRST_NAME`: The user's first name.
* `LAST_NAME`: The user's last name.
* `EMAIL`: The user's email address.
* `EMAIL_VERIFIED`: Whether the user's email address has been verified.
* `PHONE_NUMBER`: The user's phone number.
* `CITY`: The user's city.
* `COUNTRY_CODE`: The user's country code.
* `LOCALE`: The user's locale.
* `MANAGING_ENTITY`: The entity that manages the user.
* `SAML_ACCOUNTS`: SAML accounts.
* `OAUTH_ACCOUNTS`: OAUTH accounts.
* `TOTP_MFA_ENABLED`: Whether TOTP MFA (Time-based One-Time Password Multi-Factor Authentication) is enabled for the user.
* `SMS_MFA_ENABLED`: Whether SMS MFA (SMS-based Multi-Factor Authentication) is enabled for the user.
* `PASSKEYS`: The user's passkeys.
</Prop.Extras>
</Prop>
<Prop name="display_name" type="string" mode="output"> The user's display name. This is used to represent the user with text in a UI. </Prop>
<Prop name="first_name" type="string" mode="output"> The user's first name. </Prop>
<Prop name="last_name" type="string" mode="output"> The user's last name. </Prop>
<Prop name="email" type="string" mode="output"> The user's email address. </Prop>
<Prop name="email_verified" type="boolean" mode="output"> Whether the user's email address has been verified. </Prop>
<Prop name="phone_number" type="string" mode="output"> The user's phone number. </Prop>
<Prop name="country_code" type="string" mode="output"> The user's country code, shown on user's public profile page. </Prop>
<Prop name="locale" type="string" mode="output"> The supported locale for the user. </Prop>
<Prop name="managing_entity" type="ManagingEntity" mode="output"> The entity that manages the user.
<Tabs>
<Tab name="TEAM">
A managing entity 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">
A managing entity 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="saml_accounts" type="SamlAccount[]" mode="output"> SAML accounts for the user.
<PillAccordion title={<>Properties of <strong>saml_accounts</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="idp_issuer" type="string" required mode="output">
A unique identifier for the SAML identity provider.
</Prop>
<Prop name="name_id" type="string" required mode="output">
The unique identifier for the user, within the scope of `idp_issuer`. This value is often an email address.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="oauth_accounts" type="OauthAccount[]" mode="output"> OAuth accounts for the user.
<PillAccordion title={<>Properties of <strong>oauth_accounts</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="platform" type="string" required mode="output">
The OAuth platform.
</Prop>
<Prop name="external_user_id" type="string" required mode="output">
The account ID for the user on the external platform.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="totp_mfa_enabled" type="boolean" mode="output"> Whether TOTP MFA (Time-based One-Time Password Multi-Factor Authentication) is enabled for the user. </Prop>
<Prop name="sms_mfa_enabled" type="boolean" mode="output"> Whether SMS MFA (SMS-based Multi-Factor Authentication) is enabled for the user. </Prop>
<Prop name="passkeys" type="Passkey[]" mode="output"> Passkeys for the user.
<PillAccordion title={<>Properties of <strong>passkeys</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The passkey ID.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="reason" type="UpdateUserChangeReason" mode="output"> Why the user's details changed.
<Tabs>
<Tab name="PASSWORD_RESET_WITH_LINK">
The user's password was reset and their identity was verified using a link in an email.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PASSWORD_RESET_WITH_LINK`
**Available values:** The only valid value is `PASSWORD_RESET_WITH_LINK`.
</Prop.Extras>
</Prop>
<Prop name="email" type="string" mode="output">
The email address used for verification when resetting the password.
</Prop>
</Prop.List>
</Tab>
<Tab name="PASSWORD_RESET_WITH_SMS_CODE">
The user's password was reset and their identity was verified using a code the user received via SMS.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PASSWORD_RESET_WITH_SMS_CODE`
**Available values:** The only valid value is `PASSWORD_RESET_WITH_SMS_CODE`.
</Prop.Extras>
</Prop>
<Prop name="phone_number" type="string" mode="output">
The phone number used for verification when resetting the password.
</Prop>
</Prop.List>
</Tab>
<Tab name="PASSWORD_RESET_WITH_EMAIL_CODE">
The user's password was reset and their identity was verified using an email code.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `PASSWORD_RESET_WITH_EMAIL_CODE`
**Available values:** The only valid value is `PASSWORD_RESET_WITH_EMAIL_CODE`.
</Prop.Extras>
</Prop>
<Prop name="email" type="string" mode="output">
The email address used for verification when resetting the password.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Delete a user
An actor triggers this event when they delete a user's account. This includes when a user deletes their own account.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_USER
**Available values:** The only valid value is `DELETE_USER`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Cancel the deletion of a user
An actor triggers this event when they cancel or undo the deletion of a user's account. This includes when a user cancels the deletion of their own account.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNDELETE_USER
**Available values:** The only valid value is `UNDELETE_USER`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Create multi-factor authentication (MFA) backup codes
An actor triggers this event when they generate multi-factor authentication (MFA) backup codes for their account. For details on generating MFA backup codes, see Canva Help: Setting up Multi-Factor Authentication (MFA) — Generate backup codes.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_MFA_BACKUP_CODES
**Available values:** The only valid value is `CREATE_MFA_BACKUP_CODES`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Log in
An actor triggers this event when they log into Canva.
The actor will be USER if the login is successful. If the login is unsuccessful, the actor will be ANONYMOUS.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: LOGIN
**Available values:** The only valid value is `LOGIN`.
</Prop.Extras>
</Prop>
<Prop name="login_type" type="string" mode="output"> The general type of user login being attempted.
<Prop.Extras>
**Available values:**
* `PASSWORD`: User login with credentials, such as email address, user ID, phone number, and password.
* `ONE_TIME_PASSWORD`: User login with a temporary code delivered to the user's email address or phone.
* `MULTI_FACTOR_AUTHENTICATION`: User login with multi-factor authentication.
* `OAUTH`: User login with a social account or other third-party provider.
* `SAML`: User login with single sign-on for a specific email domain.
* `PASSKEY`: User login with a passkey (such as a security key).
* `OTHER`: Other types of user login.
* `LEARNING_TOOLS_INTEROPERABILITY`: User login for education users from a Learning Management System.
</Prop.Extras>
</Prop>
<Prop name="oauth_platform" type="string" mode="output"> The OAuth platform used for login. Only set if the login_type is OAUTH.
<Prop.Extras>
**Available values:**
* `APPLE`
* `ATLASSIAN`
* `CLEVER`
* `DROPBOX`
* `FACEBOOK`
* `GITHUB`
* `GOOGLE`
* `HUAWEI`
* `INSTAGRAM`
* `KAKAO`
* `LARK`
* `LINE`
* `LINKEDIN`
* `MAILCHIMP`
* `MICROSOFT`
* `NAVER`
* `PINTEREST`
* `QQ`
* `SLACK`
* `TRELLO`
* `TUMBLR`
* `TURKEY_EDU`
* `TWITTER`
* `WECHAT`
* `WEIBO`
* `YAHOO_JAPAN`
</Prop.Extras>
</Prop> </Prop.List>
Example
Log out
An actor triggers this event when they log out of Canva.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: LOGOUT
**Available values:** The only valid value is `LOGOUT`.
</Prop.Extras>
</Prop>
<Prop name="all_users" type="boolean" mode="output"> Whether the actor has requested that all users on the device are logged out. If false, only the current user is logged out. </Prop>
<Prop name="all_sessions" type="boolean" mode="output"> Whether the actor has requested that all sessions across all devices are logged out. If false, only the current session is logged out. </Prop> </Prop.List>
Example
Videos
Create a video
An actor triggers this event when they create/upload a video to their account or team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_VIDEO
**Available values:** The only valid value is `CREATE_VIDEO`.
</Prop.Extras>
</Prop>
<Prop name="filename" type="string" mode="output"> The name of the uploaded file. </Prop> </Prop.List>
Example
Update a video's details
An actor triggers this event when they update videos in their account or team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_VIDEO
**Available values:** The only valid value is `UPDATE_VIDEO`.
</Prop.Extras>
</Prop>
<Prop name="old_title" type="string" mode="output"> The old title of the video. </Prop>
<Prop name="new_title" type="string" mode="output"> The new title of the video. </Prop>
<Prop name="old_tags" type="string[]" mode="output"> Original list of tags associated with the video. </Prop>
<Prop name="new_tags" type="string[]" mode="output"> New list of tags associated with the video. </Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `TITLE`: The video's title.
* `TAGS`: The video's tags.
</Prop.Extras>
</Prop> </Prop.List>
Example
Delete a video
An actor triggers this event when they permanently delete videos from their account or team.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_VIDEO
**Available values:** The only valid value is `DELETE_VIDEO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Trash a video
An actor triggers this event when they move videos to the trash folder. Videos in the trash folder aren't accessible to collaborators and will be deleted after a period of time.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: TRASH_VIDEO
**Available values:** The only valid value is `TRASH_VIDEO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Restore a video from Trash
An actor triggers this event when they restore videos from the trash folder.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UNDELETE_VIDEO
**Available values:** The only valid value is `UNDELETE_VIDEO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Copy a video
An actor triggers this event when they copy a video.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: COPY_VIDEO
**Available values:** The only valid value is `COPY_VIDEO`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update a video's access controls
An actor triggers this event when they change the rules that control access to a video asset. There can be multiple changes in a single update.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_VIDEO_ACCESS_CONTROLS
**Available values:** The only valid value is `UPDATE_VIDEO_ACCESS_CONTROLS`.
</Prop.Extras>
</Prop>
<Prop name="changes" type="VideoAccessControlListChange[]" required mode="output"> A change to the rules that control the access to the video asset.
<Tabs>
<Tab name="GRANT_USER_VIDEO_ACCESS">
A user granted another user access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_USER_VIDEO_ACCESS`
**Available values:** The only valid value is `GRANT_USER_VIDEO_ACCESS`.
</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="access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_USER_VIDEO_ACCESS">
A user revoked another user's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_USER_VIDEO_ACCESS`
**Available values:** The only valid value is `REVOKE_USER_VIDEO_ACCESS`.
</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.List>
</Tab>
<Tab name="UPDATE_USER_VIDEO_ACCESS">
A user changed another user's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_USER_VIDEO_ACCESS`
**Available values:** The only valid value is `UPDATE_USER_VIDEO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</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.List>
</Tab>
<Tab name="GRANT_GROUP_VIDEO_ACCESS">
A user granted a group access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_GROUP_VIDEO_ACCESS`
**Available values:** The only valid value is `GRANT_GROUP_VIDEO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_GROUP_VIDEO_ACCESS">
A user revoked a group's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_GROUP_VIDEO_ACCESS`
**Available values:** The only valid value is `REVOKE_GROUP_VIDEO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="UPDATE_GROUP_VIDEO_ACCESS">
A user changed a group's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_GROUP_VIDEO_ACCESS`
**Available values:** The only valid value is `UPDATE_GROUP_VIDEO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="group" type="AuditLogGroup" required mode="output">
A Canva group.
<PillAccordion title={<>Properties of <strong>group</strong></>}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The group ID.
</Prop>
<Prop name="display_name" type="string" mode="output">
The display name of the group.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="GRANT_TEAM_VIDEO_ACCESS">
A user granted a team access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_TEAM_VIDEO_ACCESS`
**Available values:** The only valid value is `GRANT_TEAM_VIDEO_ACCESS`.
</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 name="access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_TEAM_VIDEO_ACCESS">
A user revoked a team's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_TEAM_VIDEO_ACCESS`
**Available values:** The only valid value is `REVOKE_TEAM_VIDEO_ACCESS`.
</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="UPDATE_TEAM_VIDEO_ACCESS">
A user changed a team's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_TEAM_VIDEO_ACCESS`
**Available values:** The only valid value is `UPDATE_TEAM_VIDEO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</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="GRANT_ORGANIZATION_VIDEO_ACCESS">
A user granted an organization access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `GRANT_ORGANIZATION_VIDEO_ACCESS`
**Available values:** The only valid value is `GRANT_ORGANIZATION_VIDEO_ACCESS`.
</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 name="access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</Tab>
<Tab name="REVOKE_ORGANIZATION_VIDEO_ACCESS">
A user revoked an organization's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `REVOKE_ORGANIZATION_VIDEO_ACCESS`
**Available values:** The only valid value is `REVOKE_ORGANIZATION_VIDEO_ACCESS`.
</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="UPDATE_ORGANIZATION_VIDEO_ACCESS">
A user changed an organization's access to the video.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_ORGANIZATION_VIDEO_ACCESS`
**Available values:** The only valid value is `UPDATE_ORGANIZATION_VIDEO_ACCESS`.
</Prop.Extras>
</Prop>
<Prop name="old_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>old_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_access" type="VideoAccessLevel" required mode="output">
Access permissions for a video asset.
<PillAccordion title={<>Properties of <strong>new_access</strong></>}>
<Prop.List>
<Prop name="read" type="boolean" required mode="output">
Whether read access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
<Prop name="write" type="boolean" required mode="output">
Whether write access has been provided (`true`) or denied (`false`).
<Prop.Extras>
**Default value:** `false`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</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="UPDATE_VIDEO_OWNER">
The owner of the video asset was changed.
<Prop.List>
<Prop name="type" type="string" required mode="output">
<Prop.Extras>
**Default value:** `UPDATE_VIDEO_OWNER`
**Available values:** The only valid value is `UPDATE_VIDEO_OWNER`.
</Prop.Extras>
</Prop>
<Prop name="old_owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>old_owner</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="new_owner" type="AuditLogUser" mode="output">
A Canva user.
<PillAccordion title={<>Properties of <strong>new_owner</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.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example
Websites
Create a website domain
An actor triggers this event when they register a new domain for their website. For information on Canva websites, visit these Canva Help Center articles:
- Publish Canva websites.
- Change website slug, favicon, and other settings.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_WEBSITE_DOMAIN
**Available values:** The only valid value is `CREATE_WEBSITE_DOMAIN`.
</Prop.Extras>
</Prop>
<Prop name="name" type="string" required mode="output"> The domain name (subdomain and the top-level domain). </Prop>
<Prop name="domain_type" type="string" mode="output"> The type of domain being created.
<Prop.Extras>
**Available values:**
* `FREE`: A free my.canva.site domain name selected by the user or allocated by Canva.
* `BRING_YOUR_OWN`: An existing domain name owned by the user.
* `PURCHASED`: A domain name purchased by the user from Canva.
</Prop.Extras>
</Prop> </Prop.List>
Example
Update a website domain's details
An actor triggers this event when they modify the data associated with an existing domain.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_WEBSITE_DOMAIN
**Available values:** The only valid value is `UPDATE_WEBSITE_DOMAIN`.
</Prop.Extras>
</Prop>
<Prop name="update_type" type="string" mode="output"> <Prop.Extras> Available values:
* `RENEW`: Renew a previously purchased domain name registration for an additional period.
* `REDEEM`: Redeem an expired domain name before it enters the redemption grace period.
* `RENAME`: Rename a domain to a new public domain, including the website deployed to the current domain.
* `CONNECT_TO_CANVA`: Connect a domain to Canva for hosting content.
* `DISCONNECT_FROM_CANVA`: Disconnect a domain from Canva to host content on a different platform.
* `TRANSFER_DOMAIN`: Unlock a purchased domain and initiate transfer of domain ownership to a different registrar.
* `CANCEL_TRANSFER`: Cancel an in-progress domain transfer.
* `UPDATE_DNS_RECORDS`: Update DNS records for the domain.
* `UPDATE_NAMESERVERS`: Update the nameserver records for the domain.
* `RESET_NAMESERVERS`: Reset the nameserver records for the domain to their default.
* `UPDATE_CONTACT`: Update contact information for the domain.
</Prop.Extras>
</Prop>
<Prop name="old_domain_name" type="string" mode="output"> The old domain name (shown when the update_type is RENAME) </Prop>
<Prop name="new_domain_name" type="string" mode="output"> The new domain name (shown when the update_type is RENAME) </Prop>
<Prop name="old_dns_records" type="DnsRecord[]" mode="output"> The old DNS records (shown when the update_type is either UPDATE_DNS_RECORDS or RESET_NAMESERVERS).
<PillAccordion title={<>Properties of <strong>old_dns_records</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The record name.
</Prop>
<Prop name="type" type="string" required mode="output">
The record type.
<Prop.Extras>
**Available values:**
* `A`: IPv4 address record.
* `AAAA`: IPv6 address record.
* `CNAME`: Canonical name record.
* `MX`: Mail exchange record.
* `TXT`: Text record.
* `NS`: Nameserver record.
* `SRV`: Service record.
* `CAA`: Certificate Authority Authorization record.
</Prop.Extras>
</Prop>
<Prop name="value" type="string" required mode="output">
The record value.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_dns_records" type="DnsRecord[]" mode="output"> The new custom DNS records (shown when the update_type is either UPDATE_DNS_RECORDS or RESET_NAMESERVERS).
<PillAccordion title={<>Properties of <strong>new_dns_records</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The record name.
</Prop>
<Prop name="type" type="string" required mode="output">
The record type.
<Prop.Extras>
**Available values:**
* `A`: IPv4 address record.
* `AAAA`: IPv6 address record.
* `CNAME`: Canonical name record.
* `MX`: Mail exchange record.
* `TXT`: Text record.
* `NS`: Nameserver record.
* `SRV`: Service record.
* `CAA`: Certificate Authority Authorization record.
</Prop.Extras>
</Prop>
<Prop name="value" type="string" required mode="output">
The record value.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_contact_info" type="ContactInfo" mode="output"> The contact information for a domain owner.
<PillAccordion title={<>Properties of <strong>new_contact_info</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The combined first and last name of the owner.
</Prop>
<Prop name="email" type="string" required mode="output">
The owner's email address.
</Prop>
<Prop name="phone" type="string" required mode="output">
The owner's phone number.
</Prop>
<Prop name="address" type="string" required mode="output">
The street and number of the owner's address.
</Prop>
<Prop name="city" type="string" required mode="output">
The city in the owner's address.
</Prop>
<Prop name="country" type="string" required mode="output">
The two-letter ISO country code representing the country in the owner's address.
</Prop>
<Prop name="organization_name" type="string" mode="output">
The name of the organization that owns the domain.
</Prop>
<Prop name="postcode" type="string" mode="output">
The postal code in the owner's address.
</Prop>
<Prop name="state" type="string" mode="output">
The state of the owner's address.
</Prop>
<Prop name="language" type="string" mode="output">
Language used for messaging the owner.
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example
Delete a website domain
An actor triggers this event when they delete a domain.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_WEBSITE_DOMAIN
**Available values:** The only valid value is `DELETE_WEBSITE_DOMAIN`.
</Prop.Extras>
</Prop> </Prop.List>
Example
Create an SSO connection for Canva Websites
An actor triggers this event when they complete the set up of an SSO connection for Canva Websites.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: CREATE_WEBSITE_SSO_CONNECTION
**Available values:** The only valid value is `CREATE_WEBSITE_SSO_CONNECTION`.
</Prop.Extras>
</Prop>
<Prop name="domains" type="AuditLogWebsiteDomain[]" required mode="output"> The domains protected by this SSO connection.
<PillAccordion title={<>Properties of <strong>domains</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The Web Domain ID.
</Prop>
<Prop name="name" type="string" mode="output">
The domain name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="name" type="string" mode="output"> The display name of the SSO connection. </Prop>
<Prop name="idp_issuer" type="string" mode="output"> The unique identifier of the SAML application, provided by the Identity Provider (IdP). </Prop>
<Prop name="idp_login_url" type="string" mode="output"> The login URL where users are redirected for authentication. </Prop>
<Prop name="idp_certificate" type="string" mode="output"> The PEM-encoded X.509 public certificate provided by an Identity Provider (IdP) for SAML authentication. </Prop> </Prop.List>
Example
Update an SSO connection for Canva Websites
An actor triggers this event when they modify an existing SSO connection for Canva Websites, including certificate updates.
We only log the team properties that the actor requested changes for. The changed fields are listed in the changed_fields array.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: UPDATE_WEBSITE_SSO_CONNECTION
**Available values:** The only valid value is `UPDATE_WEBSITE_SSO_CONNECTION`.
</Prop.Extras>
</Prop>
<Prop name="changed_fields" type="string[]" mode="output"> Fields requested to be changed in this update.
<Prop.Extras>
**Available values:**
* `NAME`: Update the display name of the SSO connection.
* `DOMAINS`: Update the domains protected by this SSO connection.
* `IDP_ISSUER`: Update the unique identifier of the SAML application, provided by the Identity Provider (IdP).
* `IDP_LOGIN_URL`: Update the login URL where users are redirected for authentication.
* `IDP_CERTIFICATE`: Update the X.509 certificate provided by the Identity Provider (IdP) for SAML authentication.
</Prop.Extras>
</Prop>
<Prop name="old_name" type="string" mode="output"> The previous name of the SSO connection. </Prop>
<Prop name="new_name" type="string" mode="output"> The updated name of the SSO connection. </Prop>
<Prop name="old_domains" type="AuditLogWebsiteDomain[]" mode="output"> The previous domains protected by this SSO connection.
<PillAccordion title={<>Properties of <strong>old_domains</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The Web Domain ID.
</Prop>
<Prop name="name" type="string" mode="output">
The domain name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="new_domains" type="AuditLogWebsiteDomain[]" mode="output"> The updated domains protected by this SSO connection.
<PillAccordion title={<>Properties of <strong>new_domains</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The Web Domain ID.
</Prop>
<Prop name="name" type="string" mode="output">
The domain name.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="old_idp_issuer" type="string" mode="output"> The previous Identity Provider (IdP) issuer. </Prop>
<Prop name="new_idp_issuer" type="string" mode="output"> The updated Identity Provider (IdP) issuer. </Prop>
<Prop name="old_idp_login_url" type="string" mode="output"> The previous login URL. </Prop>
<Prop name="new_idp_login_url" type="string" mode="output"> The updated login URL. </Prop>
<Prop name="old_idp_certificate" type="string" mode="output"> The previous PEM-encoded X.509 public certificate provided by an Identity Provider (IdP) for SAML authentication. </Prop>
<Prop name="new_idp_certificate" type="string" mode="output"> The updated PEM-encoded X.509 public certificate provided by an Identity Provider (IdP) for SAML authentication. </Prop> </Prop.List>
Example
Delete an SSO connection for Canva Websites
An actor triggers this event when they delete an SSO connection for Canva Websites.
<Prop.List> <Prop name="type" type="string" required mode="output"> <Prop.Extras> Default value: DELETE_WEBSITE_SSO_CONNECTION
**Available values:** The only valid value is `DELETE_WEBSITE_SSO_CONNECTION`.
</Prop.Extras>
</Prop> </Prop.List>