> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/audit-logs/llms.txt
> Use this file to discover all available pages before exploring further.

# Groups

## Create a group

An `actor` triggers this event when they create a new
[Canva group](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/).
For details on creating Canva groups, see
[Canva Help: Creating groups](https://www.canva.com/help/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](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/),
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](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/).

<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](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/).
For details on adding users to a Canva group, see
[Canva Help: Creating groups — Adding people to a group](https://www.canva.com/help/groups/).

<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](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/),
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](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/).
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

## Send a group invitation

An `actor` triggers this event when they send an invitation to join a
[Canva group](https://www.canva.dev/docs/audit-logs/how-are-teams-structured/).
The invitation is addressed to a user, an email address, or shared as a link.

<Prop.List>
  <Prop name="type" type="string" required mode="output">
    <Prop.Extras>
      **Default value:** `CREATE_GROUP_INVITATION`

      **Available values:** The only valid value is `CREATE_GROUP_INVITATION`.
    </Prop.Extras>
  </Prop>

  <Prop name="invitation_type" type="GroupInvitationType" required mode="output">
    How a user is invited to join a group. The invitation can be addressed
    to an email address, issued as a short-lived join code, or a
    shareable link.

    <Tabs>
      <Tab name="EMAIL">
        A group invitation addressed to an email address.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `EMAIL`

              **Available values:** The only valid value is `EMAIL`: Invite by an email..
            </Prop.Extras>
          </Prop>

          <Prop name="email" type="string" required mode="output">
            The email address invited to the group.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="CODE">
        A group invitation issued as a short-lived join code.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `CODE`

              **Available values:** The only valid value is `CODE`: Invite by a short-lived code..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="LINK">
        A group invitation issued as a shareable join link.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `LINK`

              **Available values:** The only valid value is `LINK`: Invite by a link..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </Prop>

  <Prop name="role" type="string" required 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

## Resend a group invitation

An `actor` triggers this event when they resend a group invitation to an email address.

<Prop.List>
  <Prop name="type" type="string" required mode="output">
    <Prop.Extras>
      **Default value:** `RESEND_GROUP_INVITATION`

      **Available values:** The only valid value is `RESEND_GROUP_INVITATION`.
    </Prop.Extras>
  </Prop>

  <Prop name="invitation_type" type="GroupInvitationType" required mode="output">
    How a user is invited to join a group. The invitation can be addressed
    to an email address, issued as a short-lived join code, or a
    shareable link.

    <Tabs>
      <Tab name="EMAIL">
        A group invitation addressed to an email address.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `EMAIL`

              **Available values:** The only valid value is `EMAIL`: Invite by an email..
            </Prop.Extras>
          </Prop>

          <Prop name="email" type="string" required mode="output">
            The email address invited to the group.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="CODE">
        A group invitation issued as a short-lived join code.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `CODE`

              **Available values:** The only valid value is `CODE`: Invite by a short-lived code..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="LINK">
        A group invitation issued as a shareable join link.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `LINK`

              **Available values:** The only valid value is `LINK`: Invite by a link..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </Prop>

  <Prop name="role" type="string" required mode="output">
    The user's role within a group.

    <Prop.Extras>
      **Available values:**

      * `MEMBER`: Group member.
      * `ADMIN`: Group administrator.
    </Prop.Extras>
  </Prop>

  <Prop name="inviter" type="AuditLogUser" mode="output">
    A Canva user.

    <PillAccordion title={<>Properties of <strong>inviter</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 group invitation

An `actor` triggers this event when they change a pending group invitation, such as updating the invitee's role.
The optional `old_role` field is the previous group role when the role was changed.

<Prop.List>
  <Prop name="type" type="string" required mode="output">
    <Prop.Extras>
      **Default value:** `UPDATE_GROUP_INVITATION`

      **Available values:** The only valid value is `UPDATE_GROUP_INVITATION`.
    </Prop.Extras>
  </Prop>

  <Prop name="invitation_type" type="GroupInvitationType" required mode="output">
    How a user is invited to join a group. The invitation can be addressed
    to an email address, issued as a short-lived join code, or a
    shareable link.

    <Tabs>
      <Tab name="EMAIL">
        A group invitation addressed to an email address.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `EMAIL`

              **Available values:** The only valid value is `EMAIL`: Invite by an email..
            </Prop.Extras>
          </Prop>

          <Prop name="email" type="string" required mode="output">
            The email address invited to the group.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="CODE">
        A group invitation issued as a short-lived join code.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `CODE`

              **Available values:** The only valid value is `CODE`: Invite by a short-lived code..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="LINK">
        A group invitation issued as a shareable join link.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `LINK`

              **Available values:** The only valid value is `LINK`: Invite by a link..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </Prop>

  <Prop name="new_role" type="string" required mode="output">
    The user's role within a group.

    <Prop.Extras>
      **Available values:**

      * `MEMBER`: Group member.
      * `ADMIN`: Group administrator.
    </Prop.Extras>
  </Prop>

  <Prop name="changed_fields" type="string[]" mode="output">
    Fields requested to be changed in this update.

    <Prop.Extras>
      **Available values:** The only valid value is `ROLE`: The group role..
    </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 name="inviter" type="AuditLogUser" mode="output">
    A Canva user.

    <PillAccordion title={<>Properties of <strong>inviter</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

## Cancel a group invitation

An `actor` triggers this event when they cancel a pending group invitation.
The invitation is identified by the invited user, an email address, or the invitation link.

<Prop.List>
  <Prop name="type" type="string" required mode="output">
    <Prop.Extras>
      **Default value:** `DELETE_GROUP_INVITATION`

      **Available values:** The only valid value is `DELETE_GROUP_INVITATION`.
    </Prop.Extras>
  </Prop>

  <Prop name="role" type="string" required mode="output">
    The user's role within a group.

    <Prop.Extras>
      **Available values:**

      * `MEMBER`: Group member.
      * `ADMIN`: Group administrator.
    </Prop.Extras>
  </Prop>

  <Prop name="invitation_type" type="GroupInvitationType" mode="output">
    How a user is invited to join a group. The invitation can be addressed
    to an email address, issued as a short-lived join code, or a
    shareable link.

    <Tabs>
      <Tab name="EMAIL">
        A group invitation addressed to an email address.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `EMAIL`

              **Available values:** The only valid value is `EMAIL`: Invite by an email..
            </Prop.Extras>
          </Prop>

          <Prop name="email" type="string" required mode="output">
            The email address invited to the group.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="CODE">
        A group invitation issued as a short-lived join code.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `CODE`

              **Available values:** The only valid value is `CODE`: Invite by a short-lived code..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="LINK">
        A group invitation issued as a shareable join link.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `LINK`

              **Available values:** The only valid value is `LINK`: Invite by a link..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </Prop>

  <Prop name="inviter" type="AuditLogUser" mode="output">
    A Canva user.

    <PillAccordion title={<>Properties of <strong>inviter</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

## Accept a group invitation

An `actor` triggers this event when they accept a pending group invitation.

<Prop.List>
  <Prop name="type" type="string" required mode="output">
    <Prop.Extras>
      **Default value:** `ACCEPT_GROUP_INVITATION`

      **Available values:** The only valid value is `ACCEPT_GROUP_INVITATION`.
    </Prop.Extras>
  </Prop>

  <Prop name="invitation_type" type="GroupInvitationType" required mode="output">
    How a user is invited to join a group. The invitation can be addressed
    to an email address, issued as a short-lived join code, or a
    shareable link.

    <Tabs>
      <Tab name="EMAIL">
        A group invitation addressed to an email address.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `EMAIL`

              **Available values:** The only valid value is `EMAIL`: Invite by an email..
            </Prop.Extras>
          </Prop>

          <Prop name="email" type="string" required mode="output">
            The email address invited to the group.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="CODE">
        A group invitation issued as a short-lived join code.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `CODE`

              **Available values:** The only valid value is `CODE`: Invite by a short-lived code..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="LINK">
        A group invitation issued as a shareable join link.

        <Prop.List>
          <Prop name="type" type="string" required mode="output">
            <Prop.Extras>
              **Default value:** `LINK`

              **Available values:** The only valid value is `LINK`: Invite by a link..
            </Prop.Extras>
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </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="invitee" type="AuditLogUser" mode="output">
    A Canva user.

    <PillAccordion title={<>Properties of <strong>invitee</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="inviter" type="AuditLogUser" mode="output">
    A Canva user.

    <PillAccordion title={<>Properties of <strong>inviter</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