Package com.microsoft.graph.models

Class Group

java.lang.Object
com.microsoft.graph.models.Entity
com.microsoft.graph.models.DirectoryObject
com.microsoft.graph.models.Group
All Implemented Interfaces:
com.microsoft.kiota.serialization.AdditionalDataHolder, com.microsoft.kiota.serialization.Parsable, com.microsoft.kiota.store.BackedModel
@Generated("com.microsoft.kiota") public class Group extends DirectoryObject implements com.microsoft.kiota.serialization.Parsable
Represents a Microsoft Entra group.

  • Constructor Details

    • Group

      public Group()
      Instantiates a new Group and sets the default values.

  • Method Details

    • createFromDiscriminatorValue

      @Nonnull public static Group createFromDiscriminatorValue(@Nonnull com.microsoft.kiota.serialization.ParseNode parseNode)
      Creates a new instance of the appropriate class based on discriminator value
      Parameters:
      parseNode - The parse node to use to read the discriminator value and create the object
      Returns:
      a Group

    • getAcceptedSenders

      @Nullable public List<DirectoryObject> getAcceptedSenders()
      Gets the acceptedSenders property value. The list of users or groups allowed to create posts or calendar events in this group. If this list is nonempty, then only users or groups listed here are allowed to post.
      Returns:
      a List<DirectoryObject>

    • getAllowExternalSenders

      @Nullable public Boolean getAllowExternalSenders()
      Gets the allowExternalSenders property value. Indicates if people external to the organization can send messages to the group. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Returns:
      a Boolean

    • getAppRoleAssignments

      @Nullable public List<AppRoleAssignment> getAppRoleAssignments()
      Gets the appRoleAssignments property value. Represents the app roles granted to a group for an application. Supports $expand.
      Returns:
      a List<AppRoleAssignment>

    • getAssignedLabels

      @Nullable public List<AssignedLabel> getAssignedLabels()
      Gets the assignedLabels property value. The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role.
      Returns:
      a List<AssignedLabel>

    • getAssignedLicenses

      @Nullable public List<AssignedLicense> getAssignedLicenses()
      Gets the assignedLicenses property value. The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq). Read-only.
      Returns:
      a List<AssignedLicense>

    • getAutoSubscribeNewMembers

      @Nullable public Boolean getAutoSubscribeNewMembers()
      Gets the autoSubscribeNewMembers property value. Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Returns:
      a Boolean

    • getCalendar

      @Nullable public Calendar getCalendar()
      Gets the calendar property value. The group's calendar. Read-only.
      Returns:
      a Calendar

    • getCalendarView

      @Nullable public List<Event> getCalendarView()
      Gets the calendarView property value. The calendar view for the calendar. Read-only.
      Returns:
      a List<Event>

    • getClassification

      @Nullable public String getClassification()
      Gets the classification property value. Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
      Returns:
      a String

    • getConversations

      @Nullable public List<Conversation> getConversations()
      Gets the conversations property value. The group's conversations.
      Returns:
      a List<Conversation>

    • getCreatedDateTime

      @Nullable public OffsetDateTime getCreatedDateTime()
      Gets the createdDateTime property value. Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.
      Returns:
      a OffsetDateTime

    • getCreatedOnBehalfOf

      @Nullable public DirectoryObject getCreatedOnBehalfOf()
      Gets the createdOnBehalfOf property value. The user (or application) that created the group. NOTE: This property isn't set if the user is an administrator. Read-only.
      Returns:
      a DirectoryObject

    • getDescription

      @Nullable public String getDescription()
      Gets the description property value. An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
      Returns:
      a String

    • getDisplayName

      @Nullable public String getDisplayName()
      Gets the displayName property value. The display name for the group. This property is required when a group is created and can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
      Returns:
      a String

    • getDrive

      @Nullable public Drive getDrive()
      Gets the drive property value. The group's default drive. Read-only.
      Returns:
      a Drive

    • getDrives

      @Nullable public List<Drive> getDrives()
      Gets the drives property value. The group's drives. Read-only.
      Returns:
      a List<Drive>

    • getEvents

      @Nullable public List<Event> getEvents()
      Gets the events property value. The group's calendar events.
      Returns:
      a List<Event>

    • getExpirationDateTime

      @Nullable public OffsetDateTime getExpirationDateTime()
      Gets the expirationDateTime property value. Timestamp of when the group is set to expire. It's null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
      Returns:
      a OffsetDateTime

    • getExtensions

      @Nullable public List<Extension> getExtensions()
      Gets the extensions property value. The collection of open extensions defined for the group. Read-only. Nullable.
      Returns:
      a List<Extension>

    • getFieldDeserializers

      @Nonnull public Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>> getFieldDeserializers()
      The deserialization information for the current model
      Specified by:
      getFieldDeserializers in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      getFieldDeserializers in class DirectoryObject
      Returns:
      a Map<String,Consumer<com.microsoft.kiota.serialization.ParseNode>>

    • getGroupLifecyclePolicies

      @Nullable public List<GroupLifecyclePolicy> getGroupLifecyclePolicies()
      Gets the groupLifecyclePolicies property value. The collection of lifecycle policies for this group. Read-only. Nullable.
      Returns:
      a List<GroupLifecyclePolicy>

    • getGroupTypes

      @Nullable public List<String> getGroupTypes()
      Gets the groupTypes property value. Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).
      Returns:
      a List<String>

    • getHasMembersWithLicenseErrors

      @Nullable public Boolean getHasMembersWithLicenseErrors()
      Gets the hasMembersWithLicenseErrors property value. Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).
      Returns:
      a Boolean

    • getHideFromAddressLists

      @Nullable public Boolean getHideFromAddressLists()
      Gets the hideFromAddressLists property value. True if the group isn't displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Returns:
      a Boolean

    • getHideFromOutlookClients

      @Nullable public Boolean getHideFromOutlookClients()
      Gets the hideFromOutlookClients property value. True if the group isn't displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Returns:
      a Boolean

    • getIsArchived

      @Nullable public Boolean getIsArchived()
      Gets the isArchived property value. When a group is associated with a team, this property determines whether the team is in read-only mode.To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.
      Returns:
      a Boolean

    • getIsAssignableToRole

      @Nullable public Boolean getIsAssignableToRole()
      Gets the isAssignableToRole property value. Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group can't be a dynamic group (that is, groupTypes can't contain DynamicMembership). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignmentsUsing this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not).
      Returns:
      a Boolean

    • getIsManagementRestricted

      @Nullable public Boolean getIsManagementRestricted()
      Gets the isManagementRestricted property value. Indicates whether the group is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.
      Returns:
      a Boolean

    • getIsSubscribedByMail

      @Nullable public Boolean getIsSubscribedByMail()
      Gets the isSubscribedByMail property value. Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Returns:
      a Boolean

    • getLicenseProcessingState

      @Nullable public LicenseProcessingState getLicenseProcessingState()
      Gets the licenseProcessingState property value. Indicates the status of the group license assignment to all group members. The default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.
      Returns:
      a LicenseProcessingState

    • getMail

      @Nullable public String getMail()
      Gets the mail property value. The SMTP address for the group, for example, 'serviceadmins@contoso.com'. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
      Returns:
      a String

    • getMailEnabled

      @Nullable public Boolean getMailEnabled()
      Gets the mailEnabled property value. Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).
      Returns:
      a Boolean

    • getMailNickname

      @Nullable public String getMailNickname()
      Gets the mailNickname property value. The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () / [] ' ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
      Returns:
      a String

    • getMemberOf

      @Nullable public List<DirectoryObject> getMemberOf()
      Gets the memberOf property value. Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.
      Returns:
      a List<DirectoryObject>

    • getMembers

      @Nullable public List<DirectoryObject> getMembers()
      Gets the members property value. The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).
      Returns:
      a List<DirectoryObject>

    • getMembershipRule

      @Nullable public String getMembershipRule()
      Gets the membershipRule property value. The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
      Returns:
      a String

    • getMembershipRuleProcessingState

      @Nullable public String getMembershipRuleProcessingState()
      Gets the membershipRuleProcessingState property value. Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).
      Returns:
      a String

    • getMembersWithLicenseErrors

      @Nullable public List<DirectoryObject> getMembersWithLicenseErrors()
      Gets the membersWithLicenseErrors property value. A list of group members with license errors from this group-based license assignment. Read-only.
      Returns:
      a List<DirectoryObject>

    • getOnenote

      @Nullable public Onenote getOnenote()
      Gets the onenote property value. The onenote property
      Returns:
      a Onenote

    • getOnPremisesDomainName

      @Nullable public String getOnPremisesDomainName()
      Gets the onPremisesDomainName property value. Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
      Returns:
      a String

    • getOnPremisesLastSyncDateTime

      @Nullable public OffsetDateTime getOnPremisesLastSyncDateTime()
      Gets the onPremisesLastSyncDateTime property value. Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).
      Returns:
      a OffsetDateTime

    • getOnPremisesNetBiosName

      @Nullable public String getOnPremisesNetBiosName()
      Gets the onPremisesNetBiosName property value. Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
      Returns:
      a String

    • getOnPremisesProvisioningErrors

      @Nullable public List<OnPremisesProvisioningError> getOnPremisesProvisioningErrors()
      Gets the onPremisesProvisioningErrors property value. Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).
      Returns:
      a List<OnPremisesProvisioningError>

    • getOnPremisesSamAccountName

      @Nullable public String getOnPremisesSamAccountName()
      Gets the onPremisesSamAccountName property value. Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.
      Returns:
      a String

    • getOnPremisesSecurityIdentifier

      @Nullable public String getOnPremisesSecurityIdentifier()
      Gets the onPremisesSecurityIdentifier property value. Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values).
      Returns:
      a String

    • getOnPremisesSyncBehavior

      @Nullable public OnPremisesSyncBehavior getOnPremisesSyncBehavior()
      Gets the onPremisesSyncBehavior property value. The onPremisesSyncBehavior property
      Returns:
      a OnPremisesSyncBehavior

    • getOnPremisesSyncEnabled

      @Nullable public Boolean getOnPremisesSyncEnabled()
      Gets the onPremisesSyncEnabled property value. true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
      Returns:
      a Boolean

    • getOwners

      @Nullable public List<DirectoryObject> getOwners()
      Gets the owners property value. The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. A non-admin user can't explicitly add themselves to this collection when they're creating the group. For more information, see the related known issue. For security groups, the admin user isn't automatically added to this collection. For more information, see the related known issue. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).
      Returns:
      a List<DirectoryObject>

    • getPermissionGrants

      @Nullable public List<ResourceSpecificPermissionGrant> getPermissionGrants()
      Gets the permissionGrants property value. The permissionGrants property
      Returns:
      a List<ResourceSpecificPermissionGrant>

    • getPhoto

      @Nullable public ProfilePhoto getPhoto()
      Gets the photo property value. The group's profile photo
      Returns:
      a ProfilePhoto

    • getPhotos

      @Nullable public List<ProfilePhoto> getPhotos()
      Gets the photos property value. The profile photos owned by the group. Read-only. Nullable.
      Returns:
      a List<ProfilePhoto>

    • getPlanner

      @Nullable public PlannerGroup getPlanner()
      Gets the planner property value. Entry-point to Planner resource that might exist for a Unified Group.
      Returns:
      a PlannerGroup

    • getPreferredDataLocation

      @Nullable public String getPreferredDataLocation()
      Gets the preferredDataLocation property value. The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles: User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.
      Returns:
      a String

    • getPreferredLanguage

      @Nullable public String getPreferredLanguage()
      Gets the preferredLanguage property value. The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
      Returns:
      a String

    • getProxyAddresses

      @Nullable public List<String> getProxyAddresses()
      Gets the proxyAddresses property value. Email addresses for the group that direct to the same group mailbox. For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
      Returns:
      a List<String>

    • getRejectedSenders

      @Nullable public List<DirectoryObject> getRejectedSenders()
      Gets the rejectedSenders property value. The list of users or groups not allowed to create posts or calendar events in this group. Nullable
      Returns:
      a List<DirectoryObject>

    • getRenewedDateTime

      @Nullable public OffsetDateTime getRenewedDateTime()
      Gets the renewedDateTime property value. Timestamp of when the group was last renewed. This value can't be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
      Returns:
      a OffsetDateTime

    • getSecurityEnabled

      @Nullable public Boolean getSecurityEnabled()
      Gets the securityEnabled property value. Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).
      Returns:
      a Boolean

    • getSecurityIdentifier

      @Nullable public String getSecurityIdentifier()
      Gets the securityIdentifier property value. Security identifier of the group, used in Windows scenarios. Read-only. Returned by default.
      Returns:
      a String

    • getServiceProvisioningErrors

      @Nullable public List<ServiceProvisioningError> getServiceProvisioningErrors()
      Gets the serviceProvisioningErrors property value. Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).
      Returns:
      a List<ServiceProvisioningError>

    • getSettings

      @Nullable public List<GroupSetting> getSettings()
      Gets the settings property value. Settings that can govern this group's behavior, like whether members can invite guests to the group. Nullable.
      Returns:
      a List<GroupSetting>

    • getSites

      @Nullable public List<Site> getSites()
      Gets the sites property value. The list of SharePoint sites in this group. Access the default site with /sites/root.
      Returns:
      a List<Site>

    • getTeam

      @Nullable public Team getTeam()
      Gets the team property value. The team associated with this group.
      Returns:
      a Team

    • getTheme

      @Nullable public String getTheme()
      Gets the theme property value. Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default.
      Returns:
      a String

    • getThreads

      @Nullable public List<ConversationThread> getThreads()
      Gets the threads property value. The group's conversation threads. Nullable.
      Returns:
      a List<ConversationThread>

    • getTransitiveMemberOf

      @Nullable public List<DirectoryObject> getTransitiveMemberOf()
      Gets the transitiveMemberOf property value. The groups that a group is a member of, either directly or through nested membership. Nullable.
      Returns:
      a List<DirectoryObject>

    • getTransitiveMembers

      @Nullable public List<DirectoryObject> getTransitiveMembers()
      Gets the transitiveMembers property value. The direct and transitive members of a group. Nullable.
      Returns:
      a List<DirectoryObject>

    • getUniqueName

      @Nullable public String getUniqueName()
      Gets the uniqueName property value. The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only.
      Returns:
      a String

    • getUnseenCount

      @Nullable public Integer getUnseenCount()
      Gets the unseenCount property value. Count of conversations that received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Returns:
      a Integer

    • getVisibility

      @Nullable public String getVisibility()
      Gets the visibility property value. Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value isn't specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable.
      Returns:
      a String

    • serialize

      public void serialize(@Nonnull com.microsoft.kiota.serialization.SerializationWriter writer)
      Serializes information the current object
      Specified by:
      serialize in interface com.microsoft.kiota.serialization.Parsable
      Overrides:
      serialize in class DirectoryObject
      Parameters:
      writer - Serialization writer to use to serialize this model

    • setAcceptedSenders

      public void setAcceptedSenders(@Nullable List<DirectoryObject> value)
      Sets the acceptedSenders property value. The list of users or groups allowed to create posts or calendar events in this group. If this list is nonempty, then only users or groups listed here are allowed to post.
      Parameters:
      value - Value to set for the acceptedSenders property.

    • setAllowExternalSenders

      public void setAllowExternalSenders(@Nullable Boolean value)
      Sets the allowExternalSenders property value. Indicates if people external to the organization can send messages to the group. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Parameters:
      value - Value to set for the allowExternalSenders property.

    • setAppRoleAssignments

      public void setAppRoleAssignments(@Nullable List<AppRoleAssignment> value)
      Sets the appRoleAssignments property value. Represents the app roles granted to a group for an application. Supports $expand.
      Parameters:
      value - Value to set for the appRoleAssignments property.

    • setAssignedLabels

      public void setAssignedLabels(@Nullable List<AssignedLabel> value)
      Sets the assignedLabels property value. The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role.
      Parameters:
      value - Value to set for the assignedLabels property.

    • setAssignedLicenses

      public void setAssignedLicenses(@Nullable List<AssignedLicense> value)
      Sets the assignedLicenses property value. The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq). Read-only.
      Parameters:
      value - Value to set for the assignedLicenses property.

    • setAutoSubscribeNewMembers

      public void setAutoSubscribeNewMembers(@Nullable Boolean value)
      Sets the autoSubscribeNewMembers property value. Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Parameters:
      value - Value to set for the autoSubscribeNewMembers property.

    • setCalendar

      public void setCalendar(@Nullable Calendar value)
      Sets the calendar property value. The group's calendar. Read-only.
      Parameters:
      value - Value to set for the calendar property.

    • setCalendarView

      public void setCalendarView(@Nullable List<Event> value)
      Sets the calendarView property value. The calendar view for the calendar. Read-only.
      Parameters:
      value - Value to set for the calendarView property.

    • setClassification

      public void setClassification(@Nullable String value)
      Sets the classification property value. Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
      Parameters:
      value - Value to set for the classification property.

    • setConversations

      public void setConversations(@Nullable List<Conversation> value)
      Sets the conversations property value. The group's conversations.
      Parameters:
      value - Value to set for the conversations property.

    • setCreatedDateTime

      public void setCreatedDateTime(@Nullable OffsetDateTime value)
      Sets the createdDateTime property value. Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.
      Parameters:
      value - Value to set for the createdDateTime property.

    • setCreatedOnBehalfOf

      public void setCreatedOnBehalfOf(@Nullable DirectoryObject value)
      Sets the createdOnBehalfOf property value. The user (or application) that created the group. NOTE: This property isn't set if the user is an administrator. Read-only.
      Parameters:
      value - Value to set for the createdOnBehalfOf property.

    • setDescription

      public void setDescription(@Nullable String value)
      Sets the description property value. An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.
      Parameters:
      value - Value to set for the description property.

    • setDisplayName

      public void setDisplayName(@Nullable String value)
      Sets the displayName property value. The display name for the group. This property is required when a group is created and can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
      Parameters:
      value - Value to set for the displayName property.

    • setDrive

      public void setDrive(@Nullable Drive value)
      Sets the drive property value. The group's default drive. Read-only.
      Parameters:
      value - Value to set for the drive property.

    • setDrives

      public void setDrives(@Nullable List<Drive> value)
      Sets the drives property value. The group's drives. Read-only.
      Parameters:
      value - Value to set for the drives property.

    • setEvents

      public void setEvents(@Nullable List<Event> value)
      Sets the events property value. The group's calendar events.
      Parameters:
      value - Value to set for the events property.

    • setExpirationDateTime

      public void setExpirationDateTime(@Nullable OffsetDateTime value)
      Sets the expirationDateTime property value. Timestamp of when the group is set to expire. It's null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
      Parameters:
      value - Value to set for the expirationDateTime property.

    • setExtensions

      public void setExtensions(@Nullable List<Extension> value)
      Sets the extensions property value. The collection of open extensions defined for the group. Read-only. Nullable.
      Parameters:
      value - Value to set for the extensions property.

    • setGroupLifecyclePolicies

      public void setGroupLifecyclePolicies(@Nullable List<GroupLifecyclePolicy> value)
      Sets the groupLifecyclePolicies property value. The collection of lifecycle policies for this group. Read-only. Nullable.
      Parameters:
      value - Value to set for the groupLifecyclePolicies property.

    • setGroupTypes

      public void setGroupTypes(@Nullable List<String> value)
      Sets the groupTypes property value. Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not).
      Parameters:
      value - Value to set for the groupTypes property.

    • setHasMembersWithLicenseErrors

      public void setHasMembersWithLicenseErrors(@Nullable Boolean value)
      Sets the hasMembersWithLicenseErrors property value. Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq).
      Parameters:
      value - Value to set for the hasMembersWithLicenseErrors property.

    • setHideFromAddressLists

      public void setHideFromAddressLists(@Nullable Boolean value)
      Sets the hideFromAddressLists property value. True if the group isn't displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Parameters:
      value - Value to set for the hideFromAddressLists property.

    • setHideFromOutlookClients

      public void setHideFromOutlookClients(@Nullable Boolean value)
      Sets the hideFromOutlookClients property value. True if the group isn't displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Parameters:
      value - Value to set for the hideFromOutlookClients property.

    • setIsArchived

      public void setIsArchived(@Nullable Boolean value)
      Sets the isArchived property value. When a group is associated with a team, this property determines whether the team is in read-only mode.To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs.
      Parameters:
      value - Value to set for the isArchived property.

    • setIsAssignableToRole

      public void setIsAssignableToRole(@Nullable Boolean value)
      Sets the isAssignableToRole property value. Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group can't be a dynamic group (that is, groupTypes can't contain DynamicMembership). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignmentsUsing this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not).
      Parameters:
      value - Value to set for the isAssignableToRole property.

    • setIsManagementRestricted

      public void setIsManagementRestricted(@Nullable Boolean value)
      Sets the isManagementRestricted property value. Indicates whether the group is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Returned only on $select.
      Parameters:
      value - Value to set for the isManagementRestricted property.

    • setIsSubscribedByMail

      public void setIsSubscribedByMail(@Nullable Boolean value)
      Sets the isSubscribedByMail property value. Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Parameters:
      value - Value to set for the isSubscribedByMail property.

    • setLicenseProcessingState

      public void setLicenseProcessingState(@Nullable LicenseProcessingState value)
      Sets the licenseProcessingState property value. Indicates the status of the group license assignment to all group members. The default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.
      Parameters:
      value - Value to set for the licenseProcessingState property.

    • setMail

      public void setMail(@Nullable String value)
      Sets the mail property value. The SMTP address for the group, for example, 'serviceadmins@contoso.com'. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
      Parameters:
      value - Value to set for the mail property.

    • setMailEnabled

      public void setMailEnabled(@Nullable Boolean value)
      Sets the mailEnabled property value. Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).
      Parameters:
      value - Value to set for the mailEnabled property.

    • setMailNickname

      public void setMailNickname(@Nullable String value)
      Sets the mailNickname property value. The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () / [] ' ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
      Parameters:
      value - Value to set for the mailNickname property.

    • setMemberOf

      public void setMemberOf(@Nullable List<DirectoryObject> value)
      Sets the memberOf property value. Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand.
      Parameters:
      value - Value to set for the memberOf property.

    • setMembers

      public void setMembers(@Nullable List<DirectoryObject> value)
      Sets the members property value. The members of this group, who can be users, devices, other groups, or service principals. Supports the List members, Add member, and Remove member operations. Nullable. Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName).
      Parameters:
      value - Value to set for the members property.

    • setMembershipRule

      public void setMembershipRule(@Nullable String value)
      Sets the membershipRule property value. The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith).
      Parameters:
      value - Value to set for the membershipRule property.

    • setMembershipRuleProcessingState

      public void setMembershipRuleProcessingState(@Nullable String value)
      Sets the membershipRuleProcessingState property value. Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in).
      Parameters:
      value - Value to set for the membershipRuleProcessingState property.

    • setMembersWithLicenseErrors

      public void setMembersWithLicenseErrors(@Nullable List<DirectoryObject> value)
      Sets the membersWithLicenseErrors property value. A list of group members with license errors from this group-based license assignment. Read-only.
      Parameters:
      value - Value to set for the membersWithLicenseErrors property.

    • setOnenote

      public void setOnenote(@Nullable Onenote value)
      Sets the onenote property value. The onenote property
      Parameters:
      value - Value to set for the onenote property.

    • setOnPremisesDomainName

      public void setOnPremisesDomainName(@Nullable String value)
      Sets the onPremisesDomainName property value. Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
      Parameters:
      value - Value to set for the onPremisesDomainName property.

    • setOnPremisesLastSyncDateTime

      public void setOnPremisesLastSyncDateTime(@Nullable OffsetDateTime value)
      Sets the onPremisesLastSyncDateTime property value. Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in).
      Parameters:
      value - Value to set for the onPremisesLastSyncDateTime property.

    • setOnPremisesNetBiosName

      public void setOnPremisesNetBiosName(@Nullable String value)
      Sets the onPremisesNetBiosName property value. Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Read-only.
      Parameters:
      value - Value to set for the onPremisesNetBiosName property.

    • setOnPremisesProvisioningErrors

      public void setOnPremisesProvisioningErrors(@Nullable List<OnPremisesProvisioningError> value)
      Sets the onPremisesProvisioningErrors property value. Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).
      Parameters:
      value - Value to set for the onPremisesProvisioningErrors property.

    • setOnPremisesSamAccountName

      public void setOnPremisesSamAccountName(@Nullable String value)
      Sets the onPremisesSamAccountName property value. Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect.Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.
      Parameters:
      value - Value to set for the onPremisesSamAccountName property.

    • setOnPremisesSecurityIdentifier

      public void setOnPremisesSecurityIdentifier(@Nullable String value)
      Sets the onPremisesSecurityIdentifier property value. Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values).
      Parameters:
      value - Value to set for the onPremisesSecurityIdentifier property.

    • setOnPremisesSyncBehavior

      public void setOnPremisesSyncBehavior(@Nullable OnPremisesSyncBehavior value)
      Sets the onPremisesSyncBehavior property value. The onPremisesSyncBehavior property
      Parameters:
      value - Value to set for the onPremisesSyncBehavior property.

    • setOnPremisesSyncEnabled

      public void setOnPremisesSyncEnabled(@Nullable Boolean value)
      Sets the onPremisesSyncEnabled property value. true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values).
      Parameters:
      value - Value to set for the onPremisesSyncEnabled property.

    • setOwners

      public void setOwners(@Nullable List<DirectoryObject> value)
      Sets the owners property value. The owners of the group who can be users or service principals. Limited to 100 owners. Nullable. If this property isn't specified when creating a Microsoft 365 group the calling user (admin or non-admin) is automatically assigned as the group owner. A non-admin user can't explicitly add themselves to this collection when they're creating the group. For more information, see the related known issue. For security groups, the admin user isn't automatically added to this collection. For more information, see the related known issue. Supports $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1); Supports $expand including nested $select. For example, /groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName).
      Parameters:
      value - Value to set for the owners property.

    • setPermissionGrants

      public void setPermissionGrants(@Nullable List<ResourceSpecificPermissionGrant> value)
      Sets the permissionGrants property value. The permissionGrants property
      Parameters:
      value - Value to set for the permissionGrants property.

    • setPhoto

      public void setPhoto(@Nullable ProfilePhoto value)
      Sets the photo property value. The group's profile photo
      Parameters:
      value - Value to set for the photo property.

    • setPhotos

      public void setPhotos(@Nullable List<ProfilePhoto> value)
      Sets the photos property value. The profile photos owned by the group. Read-only. Nullable.
      Parameters:
      value - Value to set for the photos property.

    • setPlanner

      public void setPlanner(@Nullable PlannerGroup value)
      Sets the planner property value. Entry-point to Planner resource that might exist for a Unified Group.
      Parameters:
      value - Value to set for the planner property.

    • setPreferredDataLocation

      public void setPreferredDataLocation(@Nullable String value)
      Sets the preferredDataLocation property value. The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles: User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.
      Parameters:
      value - Value to set for the preferredDataLocation property.

    • setPreferredLanguage

      public void setPreferredLanguage(@Nullable String value)
      Sets the preferredLanguage property value. The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
      Parameters:
      value - Value to set for the preferredLanguage property.

    • setProxyAddresses

      public void setProxyAddresses(@Nullable List<String> value)
      Sets the proxyAddresses property value. Email addresses for the group that direct to the same group mailbox. For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
      Parameters:
      value - Value to set for the proxyAddresses property.

    • setRejectedSenders

      public void setRejectedSenders(@Nullable List<DirectoryObject> value)
      Sets the rejectedSenders property value. The list of users or groups not allowed to create posts or calendar events in this group. Nullable
      Parameters:
      value - Value to set for the rejectedSenders property.

    • setRenewedDateTime

      public void setRenewedDateTime(@Nullable OffsetDateTime value)
      Sets the renewedDateTime property value. Timestamp of when the group was last renewed. This value can't be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only.
      Parameters:
      value - Value to set for the renewedDateTime property.

    • setSecurityEnabled

      public void setSecurityEnabled(@Nullable Boolean value)
      Sets the securityEnabled property value. Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).
      Parameters:
      value - Value to set for the securityEnabled property.

    • setSecurityIdentifier

      public void setSecurityIdentifier(@Nullable String value)
      Sets the securityIdentifier property value. Security identifier of the group, used in Windows scenarios. Read-only. Returned by default.
      Parameters:
      value - Value to set for the securityIdentifier property.

    • setServiceProvisioningErrors

      public void setServiceProvisioningErrors(@Nullable List<ServiceProvisioningError> value)
      Sets the serviceProvisioningErrors property value. Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance).
      Parameters:
      value - Value to set for the serviceProvisioningErrors property.

    • setSettings

      public void setSettings(@Nullable List<GroupSetting> value)
      Sets the settings property value. Settings that can govern this group's behavior, like whether members can invite guests to the group. Nullable.
      Parameters:
      value - Value to set for the settings property.

    • setSites

      public void setSites(@Nullable List<Site> value)
      Sets the sites property value. The list of SharePoint sites in this group. Access the default site with /sites/root.
      Parameters:
      value - Value to set for the sites property.

    • setTeam

      public void setTeam(@Nullable Team value)
      Sets the team property value. The team associated with this group.
      Parameters:
      value - Value to set for the team property.

    • setTheme

      public void setTheme(@Nullable String value)
      Sets the theme property value. Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default.
      Parameters:
      value - Value to set for the theme property.

    • setThreads

      public void setThreads(@Nullable List<ConversationThread> value)
      Sets the threads property value. The group's conversation threads. Nullable.
      Parameters:
      value - Value to set for the threads property.

    • setTransitiveMemberOf

      public void setTransitiveMemberOf(@Nullable List<DirectoryObject> value)
      Sets the transitiveMemberOf property value. The groups that a group is a member of, either directly or through nested membership. Nullable.
      Parameters:
      value - Value to set for the transitiveMemberOf property.

    • setTransitiveMembers

      public void setTransitiveMembers(@Nullable List<DirectoryObject> value)
      Sets the transitiveMembers property value. The direct and transitive members of a group. Nullable.
      Parameters:
      value - Value to set for the transitiveMembers property.

    • setUniqueName

      public void setUniqueName(@Nullable String value)
      Sets the uniqueName property value. The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only.
      Parameters:
      value - Value to set for the uniqueName property.

    • setUnseenCount

      public void setUnseenCount(@Nullable Integer value)
      Sets the unseenCount property value. Count of conversations that received new posts since the signed-in user last visited the group. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).
      Parameters:
      value - Value to set for the unseenCount property.

    • setVisibility

      public void setVisibility(@Nullable String value)
      Sets the visibility property value. Specifies the group join policy and group content visibility for groups. Possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation. If visibility value isn't specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable.
      Parameters:
      value - Value to set for the visibility property.