Read Group

Read information about an Office 365 group.

When reading a security group, avoid using the following Output properties:

Allow External Senders
Auto Subscribe New Members
Is Subscribed By Mail
Unseen Count

Input

Field	Definition	Type	Required
Group
Id	The unique identifier for the group.	Text	FALSE

Output

Field	Definition	Type
Group
Allow External Senders	Indicates if people external to the organization can send messages to the group. The default value is false.	True/False
Assigned Licenses	Licenses that are assigned to the group.	List of Objects
Auto Subscribe New Members	Indicates if new members added to the group get auto-subscribed 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. The default value is false.	True/False
Classification	Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating Classification List setting values, based on the groupSetting template definition. See the groupSetting and groupSettingtemplate resource types.	Text
Created Date Time	Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The timestamp represents date and time information using the ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is expressed as 2014-01-01T00:00:00Z.	Text
Description	An optional description for the group.	Text
Display Name	The display name for the group. The maximum length is 256 characters.	Text
Group Types	The type of group created. Office 365 - Assigned Membership: Office 365 group with assigned memberships. Office 365 - Dynamic Membership: Office 365 group with dynamically assigned memberships. Dynamic - Assigned Membership: Security group with assigned memberships. Dynamic - Dynamic Membership: Security group with dynamic memberships.	List of Text
Id	The unique identifier for the group.	Text
Is Subscribed By Mail	Indicates if users are subscribed to email conversations. true if the signed-in user is subscribed to receive email conversations false otherwise The default value is true.	True/False
License Processing State	Indicates the status of the group license assignment to all members of the group. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.	Text
Mail	The SMTP address for the group. For example, serviceadmins@contoso.onmicrosoft.com.	Text
Mail Enabled	Specifies whether the group is mail-enabled.	True/False
Mail Nickname	The mail alias for the group. This is unique for groups in the organization.	Text
On Premises Last Sync Date Time	This is when the group was last synced with the on-premises directory. This is a time stamp value that follows the ISO 8601 format and is in UTC time. For example, midnight UTC on January 1, 2014 is expressed as 2014-01-01T00:00:00Z.	Text
On Premises Provisioning Errors	Errors when using a Microsoft synchronization product during provisioning.	List of Objects
On Premises Security Identifier	Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.	Text
On Premises Sync Enabled	Specifies if the object is synced from on-premises directory. true: The object is synced from an on-premises directory false: The object was originally synced from an on-premises directory but is no longer synced null: This object has never been synced from an on-premises directory (default)	True/False
Preferred Data Location	The preferred data location for the group. See OneDrive Online Multi-Geo.	Text
Proxy Addresses	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 through multi-valued properties.	List of Text
Renewed Date Time	Timestamp of when the group was last renewed. The value can't be modified and is automatically populated through the renew service action. The timestamp represents date and time information using the ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is expressed as 2014-01-01T00:00:00Z.	Text
Security Enabled	Specifies whether the group is a security group.	True/False
Unseen Count	The number of conversations that have received new posts since the signed-in user last visited the group.	Number
Visibility	Specifies the group join policy and group content visibility for groups.	Text
Public	Anyone can join the group without needing owner permission. Anyone can view the contents of the group.	Text
Private	Owner permission is needed to join the group. Non-members can't view the contents of the group.	Text
Hiddenmembership	Owner permission is needed to join the group. Non-members can't view the contents of the group. Non-members can't see the members of the group. Administrators (global, company, user, and help desk) can view the membership of the group. The group appears in the global address book (GAL).	Text

Read Group

Input

Output

Related topics