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.
type
string
Default value: UPDATE_ORGANIZATION
Available values: The only valid value is UPDATE_ORGANIZATION
.
changed_fields
string[]
Fields requested to be changed in this update.
Available values:
ORG_NAME
: The name of the organization.DEFAULT_TEAM_ID
: 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.
old_name
string
The previous name of the organization.
new_name
string
The new name of the organization.
default_team_id
string
The team to provision users into by default.
default_team_policy
string
The policy for determining if a user can be provisioned into a default team.
Available values:
ADMIN_AND_UP
: Users with theADMIN
organization role or higher are added to the team.DESIGNER_AND_UP
: Users with theDESIGNER
organization role or higher are added to the team.MEMBER_AND_UP
: Users with theMEMBER
organization role or higher are added to the team.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UPDATE_ORGANIZATION","changed_fields": ["ORG_NAME","DEFAULT_TEAM_ID","DEFAULT_TEAM_POLICY"],"old_name": "Untitled Corporation","new_name": "Acme Corporation","default_team_id": "BXeFatjDhdR","default_team_policy": "ADMIN_AND_UP"},"outcome": ...,"context": ...}
Create a user's organization role
An actor
triggers this event when they promote a
Canva organization
MEMBER
to BRAND_DESIGNER
or ADMIN
.
type
string
Default value: CREATE_ORGANIZATION_USER_ROLE
Available values: The only valid value is CREATE_ORGANIZATION_USER_ROLE
.
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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.
role
string
The user's role in the organization.
Available values:
ADMIN
: Organization admin.BRAND_DESIGNER
: Organization brand designer.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "CREATE_ORGANIZATION_USER_ROLE","user": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe",},"role": "ADMIN"},"outcome": ...,"context": ...}
Update a user's organization role
An actor
triggers this event when they update a Canva user's membership within a
Canva organization,
such as changing the user's role from BRAND_DESIGNER
to ADMIN
. This event is only
triggered when changing their role between either BRAND_DESIGNER
or ADMIN
. Giving a user
one of the roles or taking one of these roles away from a user will trigger either the
CREATE_ORGANIZATION_USER_ROLE
or DELETE_ORGANIZATION_USER_ROLE
events.
type
string
Default value: UPDATE_ORGANIZATION_USER_ROLE
Available values: The only valid value is UPDATE_ORGANIZATION_USER_ROLE
.
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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_role
string
The user's role in the organization.
Available values:
ADMIN
: Organization admin.BRAND_DESIGNER
: Organization brand designer.
new_role
string
The user's role in the organization.
Available values:
ADMIN
: Organization admin.BRAND_DESIGNER
: Organization brand designer.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "UPDATE_ORGANIZATION_USER_ROLE","user": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe",},"old_role": "BRAND_DESIGNER","new_role": "ADMIN"},"outcome": ...,"context": ...}
Remove a user's organization role
An actor
triggers this event when they remove a user's ADMIN
or BRAND_DESIGNER
role within a
Canva organization.
type
string
Default value: DELETE_ORGANIZATION_USER_ROLE
Available values: The only valid value is DELETE_ORGANIZATION_USER_ROLE
.
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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_role
string
The user's role in the organization.
Available values:
ADMIN
: Organization admin.BRAND_DESIGNER
: Organization brand designer.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "DELETE_ORGANIZATION_USER_ROLE","user": {"id": "UXoqDbwwSbQ","display_name": "Jane Doe",},"old_role": "ADMIN"},"outcome": ...,"context": ...}
Add a team to the organization
An actor
triggers this event when they add a Canva Team to their
Canva organization.
type
string
Default value: ADD_TEAM_TO_ORGANIZATION
Available values: The only valid value is ADD_TEAM_TO_ORGANIZATION
.
team
AuditLogTeam
A Canva team.
Properties of team
id
string
The team ID.
display_name
string
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.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "ADD_TEAM_TO_ORGANIZATION","team": {"id": "BXeFatjDhdR","display_name": "Acme Team"}},"outcome": ...,"context": ...}
Remove a team from the organization
An actor
triggers this event when they remove a Canva Team from their
Canva organization.
type
string
Default value: REMOVE_TEAM_FROM_ORGANIZATION
Available values: The only valid value is REMOVE_TEAM_FROM_ORGANIZATION
.
team
AuditLogTeam
A Canva team.
Properties of team
id
string
The team ID.
display_name
string
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.
Example
{"id": ...,"timestamp": ...,"actor": ...,"target": ...,"action": {"type": "REMOVE_TEAM_FROM_ORGANIZATION","team": {"id": "BXeFatjDhdR","display_name": "Acme Team"}},"outcome": ...,"context": ...}