TDV Adapter for Microsoft Teams

Build 22.0.8462

Groups

Groups table for MSTeams data provider.

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

  • 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

The unique identifier for the group.

DeletedDateTime Datetime False

Timestamp of when the group was deleted.

AllowExternalSenders Bool False

Indicates if people external to the organization can send messages to the group. Default value is false.

AssignedLabels String False

The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group.

AssignedLicenses String False

The licenses that are assigned to the group.

AutoSubscribeNewMembers Bool 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 String False

Describes a classification for the group (such as low, medium or high business impact).

CreatedDateTime Datetime False

Timestamp of when the group was created.

Description String False

An optional description for the group.

DisplayName String False

The display name for the group.

ExpirationDateTime Datetime False

Timestamp of when the group is set to expire.

GroupTypes String False

Specifies the group type and its membership.

HasMembersWithLicenseErrors Bool False

Indicates whether there are members in this group that have license errors from its group-based license assignment.

HideFromAddressLists Bool False

true if the group is not displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups; false otherwise. Default value is false.

HideFromOutlookClients Bool False

true if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web, false otherwise. Default value is false.

IsArchived Bool False

Indicated whether the Group is Archived.

IsSubscribedByMail Bool False

Indicates whether the signed-in user is subscribed to receive email conversations.

LicenseProcessingState_state String False

Indicates status of the group license assignment to all members of the group.

Mail String False

The SMTP address for the group

MailEnabled Bool False

Specifies whether the group is mail-enabled.

MailNickname String False

The mail alias for the group, unique in the organization.

MembershipRule String False

The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership).

MembershipRuleProcessingState String False

Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused.

OnPremisesDomainName String False

Contains the on-premises domain FQDN, also called dnsDomainName 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.

OnPremisesLastSyncDateTime Datetime False

Indicates the last time at which the group was synced with the on-premises directory.

OnPremisesNetBiosName String False

Contains the on-premises netBios name synchronized from the on-premises directory.

OnPremisesProvisioningErrors String False

Errors when using Microsoft synchronization product during provisioning.

OnPremisesSamAccountName String False

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.

OnPremisesSecurityIdentifier String False

Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.

OnPremisesSyncEnabled Bool 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).

PreferredDataLocation String False

The preferred data location for the group.

PreferredLanguage String False

The preferred language for a Microsoft 365 group.

ProxyAddresses String False

Email addresses for the group that direct to the same group mailbox.

RenewedDateTime Datetime False

Timestamp of when the group was last renewed.

SecurityEnabled Bool False

Specifies whether the group is a security group.

SecurityIdentifier String False

Security identifier of the group, used in Windows scenarios.

Theme String False

Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange or Red.

UnseenCount Int False

Count of conversations that have received new posts since the signed-in user last visited the group.

Visibility String False

Specifies the group join policy and group content visibility for groups.

Calendar_id String True

The Calendar Id.

CreatedOnBehalfOf_id String True

The CreatedOnBehalfOf Id.

Drive_id String True

The Drive Id.

Onenote_id String True

The Onenote Id.

Photo_id String True

The Photo Id.

Planner_id String True

The Planner Id.

Team_id String True

The Team Id.

Members String False

The Members Id.

Owners String False

The Owners Id.

UserId String False

The User Id.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462