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.graph.serializer.IJsonBackedObject
public class Group extends DirectoryObject implements com.microsoft.graph.serializer.IJsonBackedObject
The class for the Group.

  • Field Details

    • assignedLabels

      @SerializedName(value="assignedLabels", alternate="AssignedLabels") @Expose @Nullable public List<AssignedLabel> assignedLabels
      The Assigned Labels. The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group. Returned only on $select.

    • assignedLicenses

      @SerializedName(value="assignedLicenses", alternate="AssignedLicenses") @Expose @Nullable public List<AssignedLicense> assignedLicenses
      The Assigned Licenses. The licenses that are assigned to the group. Returned only on $select. Supports $filter (eq).Read-only.

    • classification

      @SerializedName(value="classification", alternate="Classification") @Expose @Nullable public 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. Supports $filter (eq, ne, not, ge, le, startsWith).

    • createdDateTime

      @SerializedName(value="createdDateTime", alternate="CreatedDateTime") @Expose @Nullable public 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 String description
      The Description. An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search.

    • displayName

      @SerializedName(value="displayName", alternate="DisplayName") @Expose @Nullable public 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. 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.

    • expirationDateTime

      @SerializedName(value="expirationDateTime", alternate="ExpirationDateTime") @Expose @Nullable public 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. Supports $filter (eq, ne, not, ge, le, in). Read-only.

    • groupTypes

      @SerializedName(value="groupTypes", alternate="GroupTypes") @Expose @Nullable public List<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 (eq, not).

    • hasMembersWithLicenseErrors

      @SerializedName(value="hasMembersWithLicenseErrors", alternate="HasMembersWithLicenseErrors") @Expose @Nullable public 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. Supports $filter (eq).

    • isAssignableToRole

      @SerializedName(value="isAssignableToRole", alternate="IsAssignableToRole") @Expose @Nullable public Boolean isAssignableToRole
      The Is Assignable To Role. Indicates whether this group can be assigned to an Azure Active Directory role or not. 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 cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global Administrator and Privileged Role Administrator roles 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 Azure AD role assignmentsUsing this feature requires a Azure AD Premium P1 license. Returned by default. Supports $filter (eq, ne, not).

    • 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 String mail
      The Mail. The SMTP address for the group, for example, '[email protected]'. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

    • mailEnabled

      @SerializedName(value="mailEnabled", alternate="MailEnabled") @Expose @Nullable public Boolean mailEnabled
      The Mail Enabled. Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not).

    • mailNickname

      @SerializedName(value="mailNickname", alternate="MailNickname") @Expose @Nullable public String mailNickname
      The Mail Nickname. 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: @ () / [] ' ; : &lt;&gt; , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).

    • membershipRule

      @SerializedName(value="membershipRule", alternate="MembershipRule") @Expose @Nullable public 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. Supports $filter (eq, ne, not, ge, le, startsWith).

    • membershipRuleProcessingState

      @SerializedName(value="membershipRuleProcessingState", alternate="MembershipRuleProcessingState") @Expose @Nullable public 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. Supports $filter (eq, ne, not, in).

    • onPremisesDomainName

      @SerializedName(value="onPremisesDomainName", alternate="OnPremisesDomainName") @Expose @Nullable public String onPremisesDomainName
      The On Premises Domain Name.

    • onPremisesLastSyncDateTime

      @SerializedName(value="onPremisesLastSyncDateTime", alternate="OnPremisesLastSyncDateTime") @Expose @Nullable public 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 (eq, ne, not, ge, le, in).

    • onPremisesNetBiosName

      @SerializedName(value="onPremisesNetBiosName", alternate="OnPremisesNetBiosName") @Expose @Nullable public String onPremisesNetBiosName
      The On Premises Net Bios Name.

    • onPremisesProvisioningErrors

      @SerializedName(value="onPremisesProvisioningErrors", alternate="OnPremisesProvisioningErrors") @Expose @Nullable public List<OnPremisesProvisioningError> onPremisesProvisioningErrors
      The On Premises Provisioning Errors. Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not).

    • onPremisesSamAccountName

      @SerializedName(value="onPremisesSamAccountName", alternate="OnPremisesSamAccountName") @Expose @Nullable public 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. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only.

    • onPremisesSecurityIdentifier

      @SerializedName(value="onPremisesSecurityIdentifier", alternate="OnPremisesSecurityIdentifier") @Expose @Nullable public 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. Supports $filter (eq including on null values). Read-only.

    • onPremisesSyncEnabled

      @SerializedName(value="onPremisesSyncEnabled", alternate="OnPremisesSyncEnabled") @Expose @Nullable public 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 (eq, ne, not, in, and eq on null values).

    • preferredDataLocation

      @SerializedName(value="preferredDataLocation", alternate="PreferredDataLocation") @Expose @Nullable public String preferredDataLocation
      The Preferred Data Location. 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 user must be assigned one of the following Azure AD roles: Global Administrator User Account Administrator Directory Writer Exchange Administrator SharePoint Administrator For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default.

    • preferredLanguage

      @SerializedName(value="preferredLanguage", alternate="PreferredLanguage") @Expose @Nullable public String preferredLanguage
      The Preferred Language. 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).

    • proxyAddresses

      @SerializedName(value="proxyAddresses", alternate="ProxyAddresses") @Expose @Nullable public List<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 (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).

    • renewedDateTime

      @SerializedName(value="renewedDateTime", alternate="RenewedDateTime") @Expose @Nullable public 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. Supports $filter (eq, ne, not, ge, le, in). Read-only.

    • securityEnabled

      @SerializedName(value="securityEnabled", alternate="SecurityEnabled") @Expose @Nullable public Boolean securityEnabled
      The Security Enabled. Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in).

    • securityIdentifier

      @SerializedName(value="securityIdentifier", alternate="SecurityIdentifier") @Expose @Nullable public 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 String theme
      The Theme. Specifies a 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 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. Groups assignable to roles are always Private. See group visibility options to learn more. Returned by default. Nullable.

    • allowExternalSenders

      @SerializedName(value="allowExternalSenders", alternate="AllowExternalSenders") @Expose @Nullable public 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 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 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 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 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 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 Boolean isArchived
      The Is Archived. 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.

    • 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. Supports $expand.

    • 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. Supports $expand.

    • members

      @Nullable public DirectoryObjectCollectionPage members
      The Members. 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).

    • 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. Limited to 100 owners. Nullable. If this property is not specified when creating a Microsoft 365 group, the calling user is automatically assigned as the group owner. 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).

    • permissionGrants

      @SerializedName(value="permissionGrants", alternate="PermissionGrants") @Expose @Nullable public ResourceSpecificPermissionGrantCollectionPage permissionGrants
      The Permission Grants. The permission that has been granted for a group to a specific application. Supports $expand.

    • settings

      @SerializedName(value="settings", alternate="Settings") @Expose @Nullable public GroupSettingCollectionPage settings
      The Settings. Settings that can govern this group's behavior, like whether members can invite guest users to the group. Nullable.

    • transitiveMemberOf

      @Nullable public DirectoryObjectCollectionPage transitiveMemberOf
      The Transitive Member Of. The groups that a group is a member of, either directly and through nested membership. Nullable.

    • transitiveMembers

      @Nullable public DirectoryObjectCollectionPage transitiveMembers
      The Transitive Members. The direct and transitive members of a group. Nullable.

    • 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.

    • 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.

    • 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.

    • team

      @SerializedName(value="team", alternate="Team") @Expose @Nullable public Team team
      The Team. The team associated with this group.

  • Constructor Details

    • Group

      public Group()

  • Method Details

    • 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