community resource type

Namespace: microsoft.graph

Represents a community in Viva Engage that is a central place for conversations, files, events, and updates for people sharing a common interest or goal.

Every community is associated with a Microsoft 365 group, but the group doesn't have the same ID as the community. For more information about managing communities in Viva Engage, see Use the Microsoft Graph API to work with Viva Engage.

This resource is an open type that allows other properties to be passed in.

Inherits from entity.

Methods

Method Return type Description
List community collection Get a list of the Viva Engage community objects and their properties.
Create engagementAsyncOperation Create a new community in Viva Engage.
Get community Read the properties and relationships of a community object.
Update None Update the properties of an existing Viva Engage community.
Delete None Delete a Viva Engage community along with all associated Microsoft 365 content, including the connected Microsoft 365 group, OneNote notebook, and Planner plans.

Properties

Property Type Description
description String The description of the community. The maximum length is 1,024 characters.
displayName String The name of the community. The maximum length is 255 characters.
groupId String The ID of the Microsoft 365 group that manages the membership of this community.
id String The unique identifier of the community. Read-only. Inherited from entity.
privacy communityPrivacy Defines the privacy level of the community. The possible values are: public, private, unknownFutureValue.

communityPrivacy values

Member Description
public Any user from the tenant can join and participate in the community.
private A community administrator must add tenant users to the community before they can participate.
unknownFutureValue Evolvable enumeration sentinel value. Don't use.

Relationships

Relationship Type Description
group group The Microsoft 365 group that manages the membership of this community.
owners user collection The admins of the community. Limited to 100 users. If this property isn't specified when you create the community, the calling user is automatically assigned as the community owner.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.community",
  "description": "String",
  "displayName": "String",
  "groupId": "String",
  "id": "String (identifier)",
  "privacy": "String"
}