Skip navigation

Skip to main content

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.

The owner of the folder changed when a user left the team.

typestring

Default value: UPDATE_FOLDER_OWNER

Available values: The only valid value is UPDATE_FOLDER_OWNER.

old_ownerAuditLogUser
Optional

A Canva 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.

new_ownerAuditLogUser
Optional

A Canva 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.

A user granted another user access to the folder.

typestring

Default value: GRANT_USER_FOLDER_ACCESS

Available values: The only valid value is GRANT_USER_FOLDER_ACCESS.

accessFolderAccessLevel

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

readboolean

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

writeboolean

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

userAuditLogUser

A Canva 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.

A user revoked another user's access to the folder.

typestring

Default value: REVOKE_USER_FOLDER_ACCESS

Available values: The only valid value is REVOKE_USER_FOLDER_ACCESS.

userAuditLogUser

A Canva 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.

accessFolderAccessLevel
Optional

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

readboolean

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

writeboolean

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

A user changed another user's access to the folder.

typestring

Default value: UPDATE_USER_FOLDER_ACCESS

Available values: The only valid value is UPDATE_USER_FOLDER_ACCESS.

old_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

new_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

userAuditLogUser

A Canva 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.

A user granted a group⁠(opens in a new tab or window) access to the folder.

typestring

Default value: GRANT_GROUP_FOLDER_ACCESS

Available values: The only valid value is GRANT_GROUP_FOLDER_ACCESS.

accessFolderAccessLevel

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

readboolean

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

writeboolean

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

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

A user revoked a group's⁠(opens in a new tab or window) access to the folder.

typestring

Default value: REVOKE_GROUP_FOLDER_ACCESS

Available values: The only valid value is REVOKE_GROUP_FOLDER_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

accessFolderAccessLevel
Optional

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

readboolean

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

writeboolean

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

A user changed a group's⁠(opens in a new tab or window) access to the folder.

typestring

Default value: UPDATE_GROUP_FOLDER_ACCESS

Available values: The only valid value is UPDATE_GROUP_FOLDER_ACCESS.

old_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

new_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

A user granted a team⁠(opens in a new tab or window) access to the folder.

typestring

Default value: GRANT_TEAM_FOLDER_ACCESS

Available values: The only valid value is GRANT_TEAM_FOLDER_ACCESS.

accessFolderAccessLevel

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

readboolean

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

writeboolean

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

teamAuditLogTeam

A Canva 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.

A user revoked a team's⁠(opens in a new tab or window) access to the folder.

typestring

Default value: REVOKE_TEAM_FOLDER_ACCESS

Available values: The only valid value is REVOKE_TEAM_FOLDER_ACCESS.

teamAuditLogTeam

A Canva 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.

accessFolderAccessLevel
Optional

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

readboolean

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

writeboolean

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

A user changed a team's⁠(opens in a new tab or window) access to the folder.

typestring

Default value: UPDATE_TEAM_FOLDER_ACCESS

Available values: The only valid value is UPDATE_TEAM_FOLDER_ACCESS.

old_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

new_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

teamAuditLogTeam

A Canva 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.

A user granted an organization access to the folder.

typestring

Default value: GRANT_ORGANIZATION_FOLDER_ACCESS

Available values: The only valid value is GRANT_ORGANIZATION_FOLDER_ACCESS.

accessFolderAccessLevel

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

readboolean

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

writeboolean

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

organizationAuditLogOrganization

A Canva 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.

A user revoked an organization's access to the folder.

typestring

Default value: REVOKE_ORGANIZATION_FOLDER_ACCESS

Available values: The only valid value is REVOKE_ORGANIZATION_FOLDER_ACCESS.

organizationAuditLogOrganization

A Canva 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.

accessFolderAccessLevel
Optional

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

readboolean

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

writeboolean

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

A user changed an organization's access to the folder.

typestring

Default value: UPDATE_ORGANIZATION_FOLDER_ACCESS

Available values: The only valid value is UPDATE_ORGANIZATION_FOLDER_ACCESS.

old_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

new_accessFolderAccessLevel

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

readboolean

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

writeboolean

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

organizationAuditLogOrganization

A Canva 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.

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_ITEM_TO_FOLDER

Available values: The only valid value is ADD_ITEM_TO_FOLDER.

itemFolderItem

An item in a folder, such as a design.

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
Optional

A Canva 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
Optional

A Canva 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.

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_ITEM_TO_FOLDER",
    "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_ITEM_FROM_FOLDER

Available values: The only valid value is REMOVE_ITEM_FROM_FOLDER.

itemFolderItem

An item in a folder, such as a design.

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
Optional

A Canva 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
Optional

A Canva 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.

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_ITEM_FROM_FOLDER",
    "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.

typestring

Default value: REQUEST_FOLDER_ACCESS

Available values: The only valid value is REQUEST_FOLDER_ACCESS.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REQUEST_FOLDER_ACCESS"
  },
  "outcome": ...,
  "context": ...
}
JSON

Grant access to a folder

An actor (typically 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.

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
Optional

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