Groups

Holds core metadata about Microsoft 365 Groups, including properties required for provisioning and maintaining Teams.

Table Specific Information

Select

By default only the groups you are a member of will be returned. To retreive all groups in your organization, set IncludeAllGroups property to true. The provider will use the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the provider.

Id supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Groups WHERE Id = 'aee54826-eedb-4145-8e6b-4ec1ac4d82c6'

Insert

At least DisplayName, MailEnabled, MailNickname and SecurityEnabled are required to insert a new group. You can specify any other field as well.

INSERT INTO Groups (DisplayName, Description, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test Group', 'Group created from Api', false, 'test123', true)

Update

To update a group record you need to specify the Id in WHERE clause.

UPDATE Groups SET Description = 'updated description from api' WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

Delete

To delete a group record, you need to specify the Id in WHERE clause.

DELETE FROM Groups WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	A globally unique identifier for the Microsoft 365 group.
DeletedDateTime	Datetime	False	The date and time when the group was deleted, if applicable.
AllowExternalSenders	Bool	False	Indicates whether users outside the organization are allowed to send emails to the group. Default is false.
AssignedLabels	String	False	A list of sensitivity labels assigned to the group, shown as pairs of label ID and label name.
AssignedLicenses	String	False	The licenses that are currently assigned to the group, used for managing feature availability.
AutoSubscribeNewMembers	Bool	False	Specifies whether newly added members will automatically receive email notifications for group conversations. Settable only via PATCH requests. Default is false.
Classification	String	False	A business impact level label such as low, medium, or high, used to describe the group's sensitivity classification.
CreatedDateTime	Datetime	False	The timestamp representing when the group was originally created.
Description	String	False	A text field to describe the group's purpose or usage within the organization.
DisplayName	String	False	The user-friendly name shown in interfaces like Outlook and Teams for the group.
ExpirationDateTime	Datetime	False	The date and time when the group is scheduled to expire, if expiration policies are applied.
GroupTypes	String	False	Indicates the type of group (such as unified or dynamic) and how its membership is managed.
HideFromAddressLists	Bool	False	If true, hides the group from address books, recipient pickers, and search dialogs in Outlook.
HideFromOutlookClients	Bool	False	If true, hides the group from appearing in Outlook clients like Outlook for Windows and Outlook on the web.
IsSubscribedByMail	Bool	False	Indicates whether the currently signed-in user is subscribed to receive group emails.
LicenseProcessingState_state	String	False	The current state of license processing for group members. Reflects how licensing is being applied.
Mail	String	False	The primary SMTP email address associated with the group's shared mailbox.
MailEnabled	Bool	False	Indicates whether the group supports mail functionality and has an associated mailbox.
MailNickname	String	False	The email alias for the group, unique within the organization's namespace.
MembershipRule	String	False	For dynamic groups, this contains the rule used to determine membership automatically.
MembershipRuleProcessingState	String	False	Shows whether the membership rule engine is actively processing (On) or paused (Paused).
OnPremisesDomainName	String	False	The fully qualified domain name (FQDN) from on-premises directory, if synchronized via Azure AD Connect.
OnPremisesLastSyncDateTime	Datetime	False	The timestamp of the last successful synchronization of the group from on-premises to Azure Active Directory.
OnPremisesNetBiosName	String	False	The NetBIOS name for the group, synchronized from the on-premises directory.
OnPremisesProvisioningErrors	String	False	Describes any synchronization errors that occurred during on-premises provisioning.
OnPremisesSamAccountName	String	False	The SAM account name from on-premises directory. Available only when directory sync is configured.
OnPremisesSecurityIdentifier	String	False	The security identifier (SID) from on-premises directory, used to represent the group in Windows security models.
OnPremisesSyncEnabled	Bool	False	Indicates whether the group is currently being synchronized from on-premises Active Directory. Null means it has never been synced.
PreferredDataLocation	String	False	Specifies the desired Microsoft data center region for storing this group's content.
PreferredLanguage	String	False	The default language preference for the group's communications and user interface.
ProxyAddresses	String	False	A list of proxy email addresses that route messages to the group mailbox.
RenewedDateTime	Datetime	False	The last time the group's expiration policy was renewed, either manually or automatically.
SecurityEnabled	Bool	False	Indicates whether the group functions as a security group for controlling access to resources.
SecurityIdentifier	String	False	The Windows security identifier for the group, used in authorization checks.
Theme	String	False	The color theme assigned to the group in Microsoft 365. Possible values include Teal, Purple, Green, Blue, Pink, Orange, or Red.
UnseenCount	Int	False	The number of group conversations with new posts since the user last viewed the group.
UniqueName	String	False	An alternate, organization-wide unique name used to reference the group.
Visibility	String	False	Defines whether the group is public, private, or hidden, affecting how users can discover and join it.
Members	String	False	A list of unique identifiers representing the users who are members of the group.
Owners	String	False	A list of user IDs representing the individuals who manage the group and have administrative permissions.
UserId	String	False	The unique identifier of a user related to this group record, typically for context-specific queries.