Read Group

Read information about an Office 365 group.

Input

Field Definition Type Required
Group
Id Unique identifier for the group. String FALSE

Output

Field Definition Type
Group
Allow External Senders Indicates if people external to the organization can send messages to the group. Default value is false. Boolean
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. Default value is false. Boolean
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. String
Created Date Time Creation time and date for the group. This value is automatically populated when the group is created and can't be modified. This is a timestamp 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.

 String
Description Optional description for the group. String
Display Name Display name for the group. This property is required when a group is created and can't be cleared during updates. String
Group Types

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

 Dropdown
Id Unique identifier for the group. String
Is Subscribed By Mail

  • true if the signed-in user is subscribed to receive email conversations

  • false otherwise.

The default value is true.

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

 String
Mail The SMTP address for the group.

For example, serviceadmins@contoso.onmicrosoft.com.

 String
Mail Enabled

  • true: the group is mail-enabled.

  • false: the group isn't mail-enabled.

 Boolean
Mail Nickname Unique mail alias for the group in the organization. String
On Premises Last Sync Date Time This is when the group was last synced with the on-premises directory. This is a timestamp 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.

 String
On Premises Provisioning Errors Errors when using 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. String
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).

 Boolean
Preferred Data Location The preferred data location for the group. See OneDrive Online Multi-Geo. String
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 on multi-valued properties.

 List of text
Renewed Date Time Most recent date and time when the group was renewed. This is updated using the renew service action, and can't be directly modified. This is a timestamp 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.

 String
Security Enabled

  • true if the group is a security group

  • false otherwise.

 Boolean
Unseen Count The number of conversations that have received new posts since the signed-in user last visited the group. Number
Visibility Specifies the visibility of an Office 365 group. See group visibility options. String
Public Anyone can join the group without needing owner permission. Anyone can view the contents of the group. String
Private Owner permission is needed to join the group. Non-members can't view the contents of the group. String
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). String

Related topics

Azure Active Directory connector

Workflow elements

Guidance for Azure Active Directory connector

Azure Active Directory Management API overview