Skip navigation

Skip to main content

Canva Audit Logs are currently in development (Beta) and are subject to change at Canva's sole discretion.

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.

typestring

Default value: UPDATE_FOLDER_ACCESS_CONTROLS

Available values: The only valid value is UPDATE_FOLDER_ACCESS_CONTROLS.

access_control_changesUpdateFolderAccessControlChange[]

A change to the rules that control the access to the folder.

Properties of access_control_changes
typestring

This can be one of the following:

  • UPDATE_FOLDER_OWNER: The owner of the folder changed when a user left the team.
  • GRANT_USER_FOLDER_ACCESS: A user granted another user access to the folder.
  • REVOKE_USER_FOLDER_ACCESS: A user revoked another user's access to the folder.
  • UPDATE_USER_FOLDER_ACCESS: A user changed another user's access to the folder.
  • GRANT_GROUP_FOLDER_ACCESS: A user granted a group⁠(opens in a new tab or window) access to the folder.
  • REVOKE_GROUP_FOLDER_ACCESS: A user revoked a group's⁠(opens in a new tab or window) access to the folder.
  • UPDATE_GROUP_FOLDER_ACCESS: A user changed a group's⁠(opens in a new tab or window) access to the folder.
  • GRANT_TEAM_FOLDER_ACCESS: A user granted a team⁠(opens in a new tab or window) access to the folder.
  • REVOKE_TEAM_FOLDER_ACCESS: A user revoked a team's⁠(opens in a new tab or window) access to the folder.
  • UPDATE_TEAM_FOLDER_ACCESS: A user changed a team's⁠(opens in a new tab or window) access to the folder.
  • GRANT_ORGANIZATION_FOLDER_ACCESS: A user granted an organization access to the folder.
  • REVOKE_ORGANIZATION_FOLDER_ACCESS: A user revoked an organization's access to the folder.
  • UPDATE_ORGANIZATION_FOLDER_ACCESS: A user changed an organization's access to the folder.
accessFolderAccessLevel
CONDITIONAL

Whether the folder's content can be viewed or edited.

Properties of access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

userAuditLogUser
CONDITIONAL

A Canva user.

Properties of user
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

old_accessFolderAccessLevel
CONDITIONAL

Whether the folder's content can be viewed or edited.

Properties of old_access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

new_accessFolderAccessLevel
CONDITIONAL

Whether the folder's content can be viewed or edited.

Properties of new_access
readboolean

Whether read access has been provided (true) or denied (false).

writeboolean

Whether write access has been provided (true) or denied (false).

groupAuditLogGroup
CONDITIONAL

A Canva group.

Properties of group
idstring

The group ID.

display_namestring
OPTIONAL

The display name of the group.

teamAuditLogTeam
CONDITIONAL

A Canva team.

Properties of team
idstring

The team ID.

display_namestring
OPTIONAL

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.

organizationAuditLogOrganization
CONDITIONAL

A Canva organization.

Properties of organization
idstring

The organization ID.

display_namestring
OPTIONAL

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.

old_ownerAuditLogUser
OPTIONAL

A Canva user.

Properties of old_owner
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

new_ownerAuditLogUser
OPTIONAL

A Canva user.

Properties of new_owner
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_FOLDER_ACCESS_CONTROLS",
    "access_control_changes": [
      {
        "type": "UPDATE_FOLDER_OWNER",
        "old_owner": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "new_owner": {
          "id": "UXqwwoQDSbb",
          "display_name": "Ash Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "GRANT_USER_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "REVOKE_USER_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "UPDATE_USER_FOLDER_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "GRANT_GROUP_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "REVOKE_GROUP_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "UPDATE_GROUP_FOLDER_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "group": "GADkBZ48E04"
      },
      {
        "type": "GRANT_TEAM_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "REVOKE_TEAM_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "UPDATE_TEAM_FOLDER_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "GRANT_ORGANIZATION_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "REVOKE_ORGANIZATION_FOLDER_ACCESS",
        "access": {
          "read": true,
          "write": true
        },
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      },
      {
        "type": "UPDATE_ORGANIZATION_FOLDER_ACCESS",
        "old_access": {
          "read": true,
          "write": false
        },
        "new_access": {
          "read": true,
          "write": true
        },
        "organization": {
          "id": "OXtgecafZvh"
        }
      }
    ]
  },
  "outcome": ...,
  "context": ...
}
JSON

Add an item to a folder

An actor triggers this event when they add an item to a folder.

typestring

Default value: ADD_TO_FOLDER

Available values: The only valid value is ADD_TO_FOLDER.

added_itemFolderItem

An item in a folder, such as a design.

Properties of added_item
item_typestring

The type of item.

Available values:

  • FOLDER: A folder.
  • DESIGN: A design.
  • IMAGE: An image.
  • VIDEO: A video.
  • TEMPLATE: A template.
idstring

The item ID.

teamAuditLogTeam

A Canva team.

Properties of team
idstring

The team ID.

display_namestring
OPTIONAL

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.

ownerAuditLogUser

A Canva user.

Properties of owner
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

display_namestring
OPTIONAL

The display name of the item. Rarely, it may be omitted for technical reasons.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "ADD_TO_FOLDER",
    "added_item": {
      "item_type": "DESIGN",
      "id": "DXWEBartcNg",
      "team": {
        "id": "BXeFatjDhdR",
        "display_name": "Acme Team"
      },
      "owner": {
        "id": "UXoqDbwwSbQ",
        "display_name": "Jane Doe",
        "email": "[email protected]"
      },
      "display_name": "My awesome design"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Remove an item from a folder

An actor triggers this event when they remove an item from a folder.

typestring

Default value: REMOVE_FROM_FOLDER

Available values: The only valid value is REMOVE_FROM_FOLDER.

removed_itemFolderItem

An item in a folder, such as a design.

Properties of removed_item
item_typestring

The type of item.

Available values:

  • FOLDER: A folder.
  • DESIGN: A design.
  • IMAGE: An image.
  • VIDEO: A video.
  • TEMPLATE: A template.
idstring

The item ID.

teamAuditLogTeam

A Canva team.

Properties of team
idstring

The team ID.

display_namestring
OPTIONAL

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.

ownerAuditLogUser

A Canva user.

Properties of owner
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

display_namestring
OPTIONAL

The display name of the item. Rarely, it may be omitted for technical reasons.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REMOVE_FROM_FOLDER",
    "removed_item": {
      "item_type": "DESIGN",
      "id": "DXWEBartcNg",
      "team": {
        "id": "BXeFatjDhdR",
        "display_name": "Acme Team"
      },
      "owner": {
        "id": "UXoqDbwwSbQ",
        "display_name": "Jane Doe",
        "email": "[email protected]"
      },
      "display_name": "My awesome design"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

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, which is the creator of the folder or the user that inherited it after another user left their team.

typestring

Default value: REQUEST_FOLDER_ACCESS

Available values: The only valid value is REQUEST_FOLDER_ACCESS.

ownerAuditLogUser

A Canva user.

Properties of owner
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REQUEST_FOLDER_ACCESS",
    "owner": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Grant access to a folder

An actor (the folder owner) triggers this event when they grant the requester access to their folder.

typestring

Default value: GRANT_FOLDER_ACCESS

Available values: The only valid value is GRANT_FOLDER_ACCESS.

requesterAuditLogUser

A Canva user.

Properties of requester
idstring

The user ID.

display_namestring
OPTIONAL

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.

emailstring
OPTIONAL

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.

accessstring

A user's access level for a folder.

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "GRANT_FOLDER_ACCESS",
    "requester": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "access": "VIEW"
  },
  "outcome": ...,
  "context": ...
}
JSON