Read Group

Read information about an Office 365 group.

Unless otherwise indicated, field types are text.

Input

  • Group

    • Id: Unique identifier for the group

Output

  • Group

    • Allow External Senders (true/false): Indicates if people external to the organization can send messages to the group. Default value is false.

    • Assigned Licenses (list of objects): Licenses that are assigned to the group

    • Auto Subscribe New Members (true/false): 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.

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

    • Created Date Time: When the group was created. This value is automatically populated when the group is created and cannot 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.

    • Description: Optional description for the group

    • Display Name: Display name for the group. This property is required when a group is created and cannot be cleared during updates.

    • Group Types (dropdown):

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

    • Id: The unique identifier for the group

    • Is Subscribed By Mail (true/false): true if the the signed-in user is subscribed to receive email conversations; false, otherwise. The default value is true.

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

    • Mail: The SMTP address for the group, for example, serviceadmins@contoso.onmicrosoft.com.

    • Mail Enabled (true/false): true: the group is mail-enabled. false: the group is not mail-enabled.

    • Mail Nickname: The unique mail alias for the group in the organization.

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

    • On Premises Provisioning Errors (list of objects): Errors when using Microsoft synchronization product during provisioning.

    • On Premises Security Identifier: Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.

    • On Premises Sync Enabled (true/false): 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).

    • Preferred Data Location: The preferred data location for the group. See OneDrive Online Multi-Geo.

    • Proxy Addresses (list of text): 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.

    • Renewed Date Time: When the group was last 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.

    • Security Enabled (true/false): true: the group is a security group; false, otherwise.

    • Unseen Count (number): The number of conversations that have received new posts since the signed-in user last visited the group.

    • Visibility: Specifies the visibility of an Office 365 group. See group visibility options.

      • Public: Anyone can join the group without needing owner permission. Anyone can view the contents of the group.

      • Private: Owner permission is needed to join the group. Non-members cannot view the contents of the group.

      • Hiddenmembership: Owner permission is needed to join the group. Non-members cannot view the contents of the group. Non-members cannot see the members of the group. Administrators (global, company, user, and helpdesk) can view the membership of the group. The group appears in the global address book (GAL).

See also