groups¶

Groups are collections of users and other principals who share access to resources in Microsoft services or in your app. All group-related operations in Microsoft Graph require administrator consent.

Note: Groups can only be created through work or school accounts. Personal Microsoft accounts don't support groups.

You can learn more about Microsoft Graph Groups by reading the Official Microsoft Graph Documentation.

IGroup, IGroups¶

Add a Group¶

Add a new group.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";
import { GroupType } from '@pnp/graph/groups';

const graph = graphfi(...);

const groupAddResult = await graph.groups.add("GroupName", "Mail_NickName", GroupType.Office365);
const group = await groupAddResult.group();

Delete a Group¶

Deletes an existing group.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").delete();

Update Group Properties¶

Updates an existing group.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").update({ displayName: newName, propertyName: updatedValue});

Add favorite¶

Add the group to the list of the current user's favorite groups. Supported for Office 365 groups only.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").addFavorite();

Remove favorite¶

Remove the group from the list of the current user's favorite groups. Supported for Office 365 Groups only.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").removeFavorite();

Reset Unseen Count¶

Reset the unseenCount of all the posts that the current user has not seen since their last visit. Supported for Office 365 groups only.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").resetUnseenCount();

Calling this method will enable the current user to receive email notifications for this group, about new posts, events, and files in that group. Supported for Office 365 groups only.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").subscribeByMail();

Unsubscribe By Mail¶

Calling this method will prevent the current user from receiving email notifications for this group about new posts, events, and files in that group. Supported for Office 365 groups only.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").unsubscribeByMail();

Get Calendar View¶

Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the default calendar of a group.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";

const graph = graphfi(...);

const startDate = new Date("2020-04-01");
const endDate = new Date("2020-03-01");

const events = graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").getCalendarView(startDate, endDate);

Group Photo Operations¶

See Photos

Group Membership¶

Get the members and/or owners of a group.

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";
import "@pnp/graph/members";

const graph = graphfi(...);
const members = await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").members();
const owners = await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").owners();

Get the Team Site for a Group¶

import { graphfi } from "@pnp/graph";
import "@pnp/graph/groups";
import "@pnp/graph/sites/group";

const graph = graphfi(...);

const teamSite = await graph.groups.getById("7d2b9355-0891-47d3-84c8-bf2cd9c62177").sites.root();
const url = teamSite.webUrl