Permissions

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.

typestring

Default value: UPDATE_TEAM_PERMISSION

Available values: The only valid value is UPDATE_TEAM_PERMISSION.

team_permissionstring

The feature which the permission controls access too.

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_COMMERCIALLY_SAFE_CONTENT: Access elements and fonts not covered by Canva’s IP indemnity.
MAGIC_INSIGHTS: Use Magic Insights.
CANVA_CODE: Use Canva Code.

old_team_permission_rolestring

The team role for a feature. Users who are assigned this team role will access to the feature controlled by the Permission.

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.

new_team_permission_rolestring

The team role for a feature. Users who are assigned this team role will access to the feature controlled by the Permission.

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.

old_groupsAuditLogGroup[]

The Groups associated with this Permission Setting. Members of a Group included will have access to the feature regardless of the Team Role.

idstring

The group ID.

display_namestringOptional

The display name of the group.

new_groupsAuditLogGroup[]

The Groups associated with this Permission Setting. Members of a Group included will have access to the feature regardless of the Team Role.

idstring

The group ID.

display_namestringOptional

The display name of the group.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_TEAM_PERMISSION",
    "team_permission": "DREAM_STUDIO",
    "old_team_permission_role": "NO_ONE",
    "new_team_permission_role": "NO_ONE",
    "old_groups": [
      {
        "id": "GJViWaMsqhL",
        "display_name": "Marketing Group"
      }
    ],
    "new_groups": [
      {
        "id": "GJViWaMsqhL",
        "display_name": "Marketing Group"
      }
    ]
  },
  "outcome": ...,
  "context": ...
}

JSON