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.graph.serializer.IJsonBackedObject

public class Group
extends DirectoryObject
implements com.microsoft.graph.serializer.IJsonBackedObject

The class for the Group.

Field Summary

Fields

Modifier and Type	Field and Description
DirectoryObjectCollectionPage	acceptedSenders The Accepted Senders.
java.lang.Boolean	allowExternalSenders The Allow External Senders.
AppRoleAssignmentCollectionPage	appRoleAssignments The App Role Assignments.
java.util.List<AssignedLabel>	assignedLabels The Assigned Labels.
java.util.List<AssignedLicense>	assignedLicenses The Assigned Licenses.
java.lang.Boolean	autoSubscribeNewMembers The Auto Subscribe New Members.
Calendar	calendar The Calendar.
EventCollectionPage	calendarView The Calendar View.
java.lang.String	classification The Classification.
ConversationCollectionPage	conversations The Conversations.
java.time.OffsetDateTime	createdDateTime The Created Date Time.
DirectoryObject	createdOnBehalfOf The Created On Behalf Of.
java.lang.String	description The Description.
java.lang.String	displayName The Display Name.
Drive	drive The Drive.
DriveCollectionPage	drives The Drives.
EventCollectionPage	events The Events.
java.time.OffsetDateTime	expirationDateTime The Expiration Date Time.
ExtensionCollectionPage	extensions The Extensions.
GroupLifecyclePolicyCollectionPage	groupLifecyclePolicies The Group Lifecycle Policies.
java.util.List<java.lang.String>	groupTypes The Group Types.
java.lang.Boolean	hasMembersWithLicenseErrors The Has Members With License Errors.
java.lang.Boolean	hideFromAddressLists The Hide From Address Lists.
java.lang.Boolean	hideFromOutlookClients The Hide From Outlook Clients.
java.lang.Boolean	isArchived The Is Archived.
java.lang.Boolean	isSubscribedByMail The Is Subscribed By Mail.
LicenseProcessingState	licenseProcessingState The License Processing State.
java.lang.String	mail The Mail.
java.lang.Boolean	mailEnabled The Mail Enabled.
java.lang.String	mailNickname The Mail Nickname.
DirectoryObjectCollectionPage	memberOf The Member Of.
DirectoryObjectCollectionPage	members The Members.
java.lang.String	membershipRule The Membership Rule.
java.lang.String	membershipRuleProcessingState The Membership Rule Processing State.
DirectoryObjectCollectionPage	membersWithLicenseErrors The Members With License Errors.
Onenote	onenote The Onenote.
java.lang.String	onPremisesDomainName The On Premises Domain Name.
java.time.OffsetDateTime	onPremisesLastSyncDateTime The On Premises Last Sync Date Time.
java.lang.String	onPremisesNetBiosName The On Premises Net Bios Name.
java.util.List<OnPremisesProvisioningError>	onPremisesProvisioningErrors The On Premises Provisioning Errors.
java.lang.String	onPremisesSamAccountName The On Premises Sam Account Name.
java.lang.String	onPremisesSecurityIdentifier The On Premises Security Identifier.
java.lang.Boolean	onPremisesSyncEnabled The On Premises Sync Enabled.
DirectoryObjectCollectionPage	owners The Owners.
ResourceSpecificPermissionGrantCollectionPage	permissionGrants The Permission Grants.
ProfilePhoto	photo The Photo.
ProfilePhotoCollectionPage	photos The Photos.
PlannerGroup	planner The Planner.
java.lang.String	preferredDataLocation The Preferred Data Location.
java.lang.String	preferredLanguage The Preferred Language.
java.util.List<java.lang.String>	proxyAddresses The Proxy Addresses.
DirectoryObjectCollectionPage	rejectedSenders The Rejected Senders.
java.time.OffsetDateTime	renewedDateTime The Renewed Date Time.
java.lang.Boolean	securityEnabled The Security Enabled.
java.lang.String	securityIdentifier The Security Identifier.
GroupSettingCollectionPage	settings The Settings.
SiteCollectionPage	sites The Sites.
Team	team The Team.
java.lang.String	theme The Theme.
ConversationThreadCollectionPage	threads The Threads.
DirectoryObjectCollectionPage	transitiveMemberOf The Transitive Member Of.
DirectoryObjectCollectionPage	transitiveMembers The Transitive Members.
java.lang.Integer	unseenCount The Unseen Count.
java.lang.String	visibility The Visibility.

Fields inherited from class com.microsoft.graph.models.DirectoryObject

deletedDateTime

Fields inherited from class com.microsoft.graph.models.Entity

id, oDataType

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Modifier and Type	Method and Description
void	setRawObject(com.microsoft.graph.serializer.ISerializer serializer, com.google.gson.JsonObject json) Sets the raw JSON object

Methods inherited from class com.microsoft.graph.models.Entity

additionalDataManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microsoft.graph.serializer.IJsonBackedObject

additionalDataManager

Field Detail

assignedLabels

@SerializedName(value="assignedLabels",
                alternate="AssignedLabels")
 @Expose
 @Nullable
public java.util.List<AssignedLabel> assignedLabels

The Assigned Labels. The list of sensitivity label pairs (label ID, label name) associated with an Microsoft 365 group. Returned only on $select. Read-only.

assignedLicenses

@SerializedName(value="assignedLicenses",
                alternate="AssignedLicenses")
 @Expose
 @Nullable
public java.util.List<AssignedLicense> assignedLicenses

The Assigned Licenses. The licenses that are assigned to the group. Returned only on $select. Read-only.

classification

@SerializedName(value="classification",
                alternate="Classification")
 @Expose
 @Nullable
public java.lang.String classification

The Classification. 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.

createdDateTime

@SerializedName(value="createdDateTime",
                alternate="CreatedDateTime")
 @Expose
 @Nullable
public java.time.OffsetDateTime createdDateTime

The Created Date Time. Timestamp of when the group was created. The value cannot 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 Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.

description

@SerializedName(value="description",
                alternate="Description")
 @Expose
 @Nullable
public java.lang.String description

The Description. An optional description for the group. Returned by default.

displayName

@SerializedName(value="displayName",
                alternate="DisplayName")
 @Expose
 @Nullable
public java.lang.String displayName

The Display Name. The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $filter and $orderby.

expirationDateTime

@SerializedName(value="expirationDateTime",
                alternate="ExpirationDateTime")
 @Expose
 @Nullable
public java.time.OffsetDateTime expirationDateTime

The Expiration Date Time. Timestamp of when the group is set to expire. The value cannot 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 Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.

groupTypes

@SerializedName(value="groupTypes",
                alternate="GroupTypes")
 @Expose
 @Nullable
public java.util.List<java.lang.String> groupTypes

The Group Types. 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 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.

hasMembersWithLicenseErrors

@SerializedName(value="hasMembersWithLicenseErrors",
                alternate="HasMembersWithLicenseErrors")
 @Expose
 @Nullable
public java.lang.Boolean hasMembersWithLicenseErrors

The Has Members With License Errors. 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.

licenseProcessingState

@SerializedName(value="licenseProcessingState",
                alternate="LicenseProcessingState")
 @Expose
 @Nullable
public LicenseProcessingState licenseProcessingState

The License Processing State. Indicates status of the group license assignment to all members of the group. Default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Returned only on $select. Read-only.

mail

@SerializedName(value="mail",
                alternate="Mail")
 @Expose
 @Nullable
public java.lang.String mail

The Mail. The SMTP address for the group, for example, '[email protected]'. Returned by default. Read-only. Supports $filter.

mailEnabled

@SerializedName(value="mailEnabled",
                alternate="MailEnabled")
 @Expose
 @Nullable
public java.lang.Boolean mailEnabled

The Mail Enabled. Specifies whether the group is mail-enabled. Returned by default.

mailNickname

@SerializedName(value="mailNickname",
                alternate="MailNickname")
 @Expose
 @Nullable
public java.lang.String mailNickname

The Mail Nickname. The mail alias for the group, unique in the organization. This property must be specified when a group is created. These characters cannot be used in the mailNickName: @()/[]';:.<>,SPACE. Returned by default. Supports $filter.

membershipRule

@SerializedName(value="membershipRule",
                alternate="MembershipRule")
 @Expose
 @Nullable
public java.lang.String membershipRule

The Membership Rule. 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.

membershipRuleProcessingState

@SerializedName(value="membershipRuleProcessingState",
                alternate="MembershipRuleProcessingState")
 @Expose
 @Nullable
public java.lang.String membershipRuleProcessingState

The Membership Rule Processing State. Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default.

onPremisesDomainName

@SerializedName(value="onPremisesDomainName",
                alternate="OnPremisesDomainName")
 @Expose
 @Nullable
public java.lang.String onPremisesDomainName

The On Premises Domain Name. Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Read-only.

onPremisesLastSyncDateTime

@SerializedName(value="onPremisesLastSyncDateTime",
                alternate="OnPremisesLastSyncDateTime")
 @Expose
 @Nullable
public java.time.OffsetDateTime onPremisesLastSyncDateTime

The On Premises Last Sync Date Time. 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 Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter.

onPremisesNetBiosName

@SerializedName(value="onPremisesNetBiosName",
                alternate="OnPremisesNetBiosName")
 @Expose
 @Nullable
public java.lang.String onPremisesNetBiosName

The On Premises Net Bios Name. Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Read-only.

onPremisesProvisioningErrors

@SerializedName(value="onPremisesProvisioningErrors",
                alternate="OnPremisesProvisioningErrors")
 @Expose
 @Nullable
public java.util.List<OnPremisesProvisioningError> onPremisesProvisioningErrors

The On Premises Provisioning Errors. Errors when using Microsoft synchronization product during provisioning. Returned by default.

onPremisesSamAccountName

@SerializedName(value="onPremisesSamAccountName",
                alternate="OnPremisesSamAccountName")
 @Expose
 @Nullable
public java.lang.String onPremisesSamAccountName

The On Premises Sam Account Name. Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned by default. Read-only.

onPremisesSecurityIdentifier

@SerializedName(value="onPremisesSecurityIdentifier",
                alternate="OnPremisesSecurityIdentifier")
 @Expose
 @Nullable
public java.lang.String onPremisesSecurityIdentifier

The On Premises Security Identifier. Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. Returned by default. Read-only.

onPremisesSyncEnabled

@SerializedName(value="onPremisesSyncEnabled",
                alternate="OnPremisesSyncEnabled")
 @Expose
 @Nullable
public java.lang.Boolean onPremisesSyncEnabled

The On Premises Sync Enabled. 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 been synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter.

preferredDataLocation

@SerializedName(value="preferredDataLocation",
                alternate="PreferredDataLocation")
 @Expose
 @Nullable
public java.lang.String preferredDataLocation

The Preferred Data Location. The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. Returned by default.

preferredLanguage

@SerializedName(value="preferredLanguage",
                alternate="PreferredLanguage")
 @Expose
 @Nullable
public java.lang.String preferredLanguage

The Preferred Language. The preferred language for an Microsoft 365 group. Should follow ISO 639-1 Code; for example 'en-US'. Returned by default.

proxyAddresses

@SerializedName(value="proxyAddresses",
                alternate="ProxyAddresses")
 @Expose
 @Nullable
public java.util.List<java.lang.String> proxyAddresses

The Proxy Addresses. Email addresses for the group that direct to the same group mailbox. For example: ['SMTP: [email protected]', 'smtp: [email protected]']. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter.

renewedDateTime

@SerializedName(value="renewedDateTime",
                alternate="RenewedDateTime")
 @Expose
 @Nullable
public java.time.OffsetDateTime renewedDateTime

The Renewed Date Time. Timestamp of when the group was last renewed. This cannot 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 time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only.

securityEnabled

@SerializedName(value="securityEnabled",
                alternate="SecurityEnabled")
 @Expose
 @Nullable
public java.lang.Boolean securityEnabled

The Security Enabled. Specifies whether the group is a security group. Returned by default. Supports $filter.

securityIdentifier

@SerializedName(value="securityIdentifier",
                alternate="SecurityIdentifier")
 @Expose
 @Nullable
public java.lang.String securityIdentifier

The Security Identifier. Security identifier of the group, used in Windows scenarios. Returned by default.

theme

@SerializedName(value="theme",
                alternate="Theme")
 @Expose
 @Nullable
public java.lang.String theme

The Theme. Specifies an Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red. Returned by default.

visibility

@SerializedName(value="visibility",
                alternate="Visibility")
 @Expose
 @Nullable
public java.lang.String visibility

The Visibility. 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 is not specified during group creation on Microsoft Graph, a security group is created as Private by default and Microsoft 365 group is Public. See group visibility options to learn more. Returned by default.

allowExternalSenders

@SerializedName(value="allowExternalSenders",
                alternate="AllowExternalSenders")
 @Expose
 @Nullable
public java.lang.Boolean allowExternalSenders

The Allow External Senders. Indicates if people external to the organization can send messages to the group. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).

autoSubscribeNewMembers

@SerializedName(value="autoSubscribeNewMembers",
                alternate="AutoSubscribeNewMembers")
 @Expose
 @Nullable
public java.lang.Boolean autoSubscribeNewMembers

The Auto Subscribe New Members. Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not 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}).

hideFromAddressLists

@SerializedName(value="hideFromAddressLists",
                alternate="HideFromAddressLists")
 @Expose
 @Nullable
public java.lang.Boolean hideFromAddressLists

The Hide From Address Lists. True if the group is not 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. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).

hideFromOutlookClients

@SerializedName(value="hideFromOutlookClients",
                alternate="HideFromOutlookClients")
 @Expose
 @Nullable
public java.lang.Boolean hideFromOutlookClients

The Hide From Outlook Clients. True if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. Default value is false. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).

isSubscribedByMail

@SerializedName(value="isSubscribedByMail",
                alternate="IsSubscribedByMail")
 @Expose
 @Nullable
public java.lang.Boolean isSubscribedByMail

The Is Subscribed By Mail. Indicates whether the signed-in user is subscribed to receive email conversations. Default value is true. Returned only on $select. Supported only on the Get group API (GET /groups/{ID}).

unseenCount

@SerializedName(value="unseenCount",
                alternate="UnseenCount")
 @Expose
 @Nullable
public java.lang.Integer unseenCount

The Unseen Count. Count of conversations that have 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}).

isArchived

@SerializedName(value="isArchived",
                alternate="IsArchived")
 @Expose
 @Nullable
public java.lang.Boolean isArchived

The Is Archived.

appRoleAssignments

@SerializedName(value="appRoleAssignments",
                alternate="AppRoleAssignments")
 @Expose
 @Nullable
public AppRoleAssignmentCollectionPage appRoleAssignments

The App Role Assignments. Represents the app roles a group has been granted for an application.

createdOnBehalfOf

@SerializedName(value="createdOnBehalfOf",
                alternate="CreatedOnBehalfOf")
 @Expose
 @Nullable
public DirectoryObject createdOnBehalfOf

The Created On Behalf Of. The user (or application) that created the group. NOTE: This is not set if the user is an administrator. Read-only.

memberOf

@Nullable
public DirectoryObjectCollectionPage memberOf

The Member Of. Groups that this group is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable.

members

@Nullable
public DirectoryObjectCollectionPage members

The Members. Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for Microsoft 365 groups, security groups and mail-enabled security groups), DELETE (supported for Microsoft 365 groups and security groups). Nullable.

membersWithLicenseErrors

@Nullable
public DirectoryObjectCollectionPage membersWithLicenseErrors

The Members With License Errors. A list of group members with license errors from this group-based license assignment. Read-only.

owners

@Nullable
public DirectoryObjectCollectionPage owners

The Owners. The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. Limited to 100 owners. HTTP Methods: GET (supported for all groups), POST (supported for Microsoft 365 groups, security groups and mail-enabled security groups), DELETE (supported for Microsoft 365 groups and security groups). Nullable.

permissionGrants

@SerializedName(value="permissionGrants",
                alternate="PermissionGrants")
 @Expose
 @Nullable
public ResourceSpecificPermissionGrantCollectionPage permissionGrants

The Permission Grants.

settings

@SerializedName(value="settings",
                alternate="Settings")
 @Expose
 @Nullable
public GroupSettingCollectionPage settings

The Settings. Read-only. Nullable.

transitiveMemberOf

@Nullable
public DirectoryObjectCollectionPage transitiveMemberOf

The Transitive Member Of.

transitiveMembers

@Nullable
public DirectoryObjectCollectionPage transitiveMembers

The Transitive Members.

acceptedSenders

@Nullable
public DirectoryObjectCollectionPage acceptedSenders

The Accepted Senders. The list of users or groups that are allowed to create post's or calendar events in this group. If this list is non-empty then only users or groups listed here are allowed to post.

calendar

@SerializedName(value="calendar",
                alternate="Calendar")
 @Expose
 @Nullable
public Calendar calendar

The Calendar. The group's calendar. Read-only.

calendarView

@SerializedName(value="calendarView",
                alternate="CalendarView")
 @Expose
 @Nullable
public EventCollectionPage calendarView

The Calendar View. The calendar view for the calendar. Read-only.

conversations

@SerializedName(value="conversations",
                alternate="Conversations")
 @Expose
 @Nullable
public ConversationCollectionPage conversations

The Conversations. The group's conversations.

events

@SerializedName(value="events",
                alternate="Events")
 @Expose
 @Nullable
public EventCollectionPage events

The Events. The group's calendar events.

photo

@SerializedName(value="photo",
                alternate="Photo")
 @Expose
 @Nullable
public ProfilePhoto photo

The Photo. The group's profile photo

photos

@SerializedName(value="photos",
                alternate="Photos")
 @Expose
 @Nullable
public ProfilePhotoCollectionPage photos

The Photos. The profile photos owned by the group. Read-only. Nullable.

rejectedSenders

@Nullable
public DirectoryObjectCollectionPage rejectedSenders

The Rejected Senders. The list of users or groups that are not allowed to create posts or calendar events in this group. Nullable

threads

@SerializedName(value="threads",
                alternate="Threads")
 @Expose
 @Nullable
public ConversationThreadCollectionPage threads

The Threads. The group's conversation threads. Nullable.

drive

@SerializedName(value="drive",
                alternate="Drive")
 @Expose
 @Nullable
public Drive drive

The Drive. The group's default drive. Read-only.

drives

@SerializedName(value="drives",
                alternate="Drives")
 @Expose
 @Nullable
public DriveCollectionPage drives

The Drives. The group's drives. Read-only.

sites

@SerializedName(value="sites",
                alternate="Sites")
 @Expose
 @Nullable
public SiteCollectionPage sites

The Sites. The list of SharePoint sites in this group. Access the default site with /sites/root.

extensions

@SerializedName(value="extensions",
                alternate="Extensions")
 @Expose
 @Nullable
public ExtensionCollectionPage extensions

The Extensions. The collection of open extensions defined for the group. Read-only. Nullable.

groupLifecyclePolicies

@SerializedName(value="groupLifecyclePolicies",
                alternate="GroupLifecyclePolicies")
 @Expose
 @Nullable
public GroupLifecyclePolicyCollectionPage groupLifecyclePolicies

The Group Lifecycle Policies. The collection of lifecycle policies for this group. Read-only. Nullable.

planner

@SerializedName(value="planner",
                alternate="Planner")
 @Expose
 @Nullable
public PlannerGroup planner

The Planner. Entry-point to Planner resource that might exist for a Unified Group.

onenote

@SerializedName(value="onenote",
                alternate="Onenote")
 @Expose
 @Nullable
public Onenote onenote

The Onenote. Read-only.

team

@SerializedName(value="team",
                alternate="Team")
 @Expose
 @Nullable
public Team team

The Team.

Constructor Detail

Group

public Group()

Method Detail

setRawObject

public void setRawObject(@Nonnull
                         com.microsoft.graph.serializer.ISerializer serializer,
                         @Nonnull
                         com.google.gson.JsonObject json)

Sets the raw JSON object

Specified by:

setRawObject in interface com.microsoft.graph.serializer.IJsonBackedObject

Overrides:

setRawObject in class DirectoryObject

Parameters:

serializer - the serializer

json - the JSON object to set this object to