Adding a Connection to Microsoft Teams

To add a connection to Microsoft Teams:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Microsoft Teams icon is not available, click the Add More icon to download and install the Microsoft Teams connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Microsoft Teams

Microsoft Teams supports the following authentication methods:

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

OAuth

CData provides an embedded OAuth application that simplifies authentication. You can, however, create a custom application for authentication. For information about creating a custom application and reasons for doing so, see Creating a Custom OAuth Application.

For authentication, the only difference between using the CData-provided (embedded) application and creating your own custom application is that you must set two additional connection properties in the Advanced Tab when using custom OAuth applications.

Before you connect, for Custom Azure AD applications only, set the following variables:

• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Microsoft Teams to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values so that they persist across connections.

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see Creating a Custom OAuth Application.

Managed Service Identity (MSI)

If you are running Microsoft Teams on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

This section details a selection of advanced features of the Microsoft Teams Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Microsoft Teams and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models Microsoft Teams objects as relational tables and views. A Microsoft Teams object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Microsoft Teams APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

The Sync App models the data in Microsoft Teams as a list of tables in a relational database that can be queried using standard SQL statements.

Microsoft Teams Connector for CData Sync Tables

Name	Description
Apps	Apps table for MSTeams data provider.
Channels	Channels table for MSTeams data provider.
GroupMembers	GroupMembers table for MSTeams data provider.
GroupOwners	GroupOwners table for MSTeams data provider.
Groups	Groups table for MSTeams data provider.
OpenShifts	Shifts table for MSTeams data provider.
Schedules	Schedules table for MSTeams data provider.
SchedulingGroups	SchedulingGroups table for MSTeams data provider.
Shifts	Shifts table for MSTeams data provider.
Teams	Teams table for MSTeams data provider.
TeamsInstalledApps	TeamsInstalledApps table for MSTeams data provider.
TeamTabs	TeamTabs table for MSTeams data provider.
TimeOffReasons	TimesOffReasons table for MSTeams data provider.
TimesOff	TimesOff table for MSTeams data provider.

Apps table for MSTeams data provider.

Table Specific Information

Select

This includes apps from the Microsoft Teams store, as well as apps from your organization's app catalog (the tenant app catalog). To get apps from your organization's app catalog only, specify Organization as the distributionMethod. The Sync App 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 Sync App.

• displayName, Id, externalId support the '=', '!=', IN, LIKE, IS, IS NOT operator.

For example, the following queries are processed server side:

SELECT * FROM Apps WHERE DisplayName = 'MailChimp'

SELECT * FROM Apps WHERE DisplayName IN ('OneNote', 'Teams')

SELECT * FROM Apps WHERE Id LIKE '%-3b58-%'

SELECT * FROM Apps WHERE externalId IN (123, 156)

Delete

You can only remove the app from your organization's app catalog (the tenant app catalog). To remove an app record you need to specify the Id in WHERE clause.

DELETE FROM Apps WHERE Id = 'ffdb7239-3b58-46ba-b108-7f90a6d8799b'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The catalog app's generated app ID.
displayName	String	False	The name of the catalog app provided by the app developer.
distributionMethod	String	False	The method of distribution for the app.
externalId	String	False	The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.

Channels table for MSTeams data provider.

Table Specific Information

Select

Query the Channels table by retrieving all channels in all teams or by specifying TeamId. The Sync App uses the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators:

• TeamId supports the '=' and IN operators. The rest of the columns support the '=', '!=', IN, LIKE, IS, IS NOT operator.

The rest of the filter is executed client side within the Sync App

For example, the following queries are processed server side:

SELECT * FROM Channels WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da838338-4e77-4c05-82a6-79d9f0274555')

SELECT * FROM Channels WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = '19:[email protected]'

SELECT * FROM Channels WHERE description != 'desc'

SELECT * FROM Channels WHERE webUrl LIKE '%teams.microsoft.com/l/channel/%'

Insert

At least TeamId and DisplayName are required to insert a new channel to a team. You can specify any other field as well.

INSERT INTO Channels (displayName, description, TeamId) VALUES ('a new channel', 'top tasks channel', 'da838338-4e77-4c05-82a6-79d9f0274511')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The channel's unique identifier.
TeamId	String	False	The Team Id.
CreatedDateTime	Datetime	False	Timestamp at which the channel was created.
Description	String	False	Optional textual description for the channel.
DisplayName	String	False	Channel name as it will appear to the user in Microsoft Teams.
Email	String	False	The email address for sending messages to the channel. Read-only.
IsFavoriteByDefault	Bool	False	Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: false.
MembershipType	String	False	The type of the channel. Can be set during creation and cannot be changed. Default: standard.
WebUrl	String	False	A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed.
FilesFolder_id	String	True	The FilesFolder Id.

GroupMembers table for MSTeams data provider.

Table Specific Information

Select

Query the GroupMembers table by retrieving everything from teams or by specifying GroupId with = and IN operators. By default only the members of the groups you are a member of will be returned. To retreive members for all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• GroupId supports the '=' and IN operator.

For example, the following queries are processed server side:

SELECT * FROM GroupMembers WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1')

SELECT * FROM GroupMembers WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Insert

GroupId and MemberId fields are required to insert a new member to a group. MemberId correspond to the Id of the User, you can query the Users table to get the Id of the User you want to add as a member.

INSERT INTO GroupMembers (GroupId, MemberId) VALUES ('acabe397-8370-4c31-aeb7-2d7ae6b8cda1', 'ad9de185-a7af-4ae5-946e-17fc1bf596f0')

Delete

You can delete a group member by specifying GroupId and MemberId.

DELETE FROM GroupMembers WHERE GroupId = 'e557c6d9-3d9a-4658-b51a-4f242c2f8ec8' AND MemberId = 'ba074a2a-69be-45d2-8519-2cc5688bca1e'

Columns

Name	Type	ReadOnly	Description
GroupId [KEY]	String	False	The Id of the Group.
MemberId [KEY]	String	False	The User Id of the member listed.

GroupOwners table for MSTeams data provider.

Table Specific Information

Select

Query the GroupOwners table by retrieving everything from teams or by specifying GroupId with = and IN operators. By default only the owners of the groups you are a member of will be returned. To retreive owners for all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• GroupId supports the '=' and IN operator.

For example, the following queries are processed server side:

SELECT * FROM GroupOwners WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1')

SELECT * FROM GroupOwners WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Insert

You can add a user to the group's owners. The owners are a set of non-admin users who are allowed to modify the group object. GroupId and OwnerId fields are required to insert a new member to a group. OwnerId correspond to the Id of the User, you can query the Users table to get the Id of the User you want to add as an onwer.

INSERT INTO GroupOwners (GroupId, OwnerId) VALUES ('acabe397-8370-4c31-aeb7-2d7ae6b8cda1', 'ad9de185-a7af-4ae5-946e-17fc1bf596f0')

Delete

You can delete a group member by specifying GroupId and OwnerId.

DELETE FROM GroupOwners WHERE GroupId = 'e557c6d9-3d9a-4658-b51a-4f242c2f8ec8' AND OwnerId = 'ba074a2a-69be-45d2-8519-2cc5688bca1e'

Columns

Name	Type	ReadOnly	Description
GroupId [KEY]	String	False	The Id of the Group.
OwnerId [KEY]	String	False	The User Id of the owner listed.

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 Sync App 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 Sync App.

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

Shifts table for MSTeams data provider.

Table Specific Information

Select

Query the OpenShifts table by retrieving everything from teams or by specifying TeamId with = and IN operators. By default only the open shifts for teams of the groups you are a member of will be returned. To retreive open shift items for teams of all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• TeamId supports the '=' and IN operators.
• Id supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM OpenShifts WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515')
SELECT * FROM OpenShifts WHERE Id = 'OPNSHFT_2d49e6dd-d965-4ea2-a399-37f2a082852c' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Insert

To insert an open shift into the team schedule, you need to specify TeamId, at least one of the DraftOpenShift or SharedOpenShift information including the startDateTime and endDateTime.

INSERT INTO OpenShifts (TeamId, draftopenshift_openslotcount, draftopenshift_startDateTime, draftopenshift_endDateTime) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', 4, '2020-09-16T10:00:00.000Z', '2020-09-16T18:00:00.000Z')

Update

To update an open shift record Id and TeamId are required in WHERE clause. You can update any other field other than TeamId, Id and CreatedDateTime.

UPDATE OpenShifts SET draftOpenShift_theme = 'blue' WHERE Id = 'OPNSHFT_2d49e6dd-d965-4ea2-a399-37f2a082852c' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Delete

To delete a shift record Id and TeamId are required in WHERE clause.

DELETE FROM OpenShifts WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'OPNSHFT_2d49e6dd-d965-4ea2-a399-37f2a082852c'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	ID for the scheduling group that the open shift belongs to.
CreatedDateTime	Datetime	False	Timestamp at which the openshift was created.
LastModifiedBy_application_displayName	String	False	The display name of the application that last modified.
LastModifiedBy_application_id	String	False	The id of the application that last modified.
LastModifiedDateTime	Datetime	False	The timestamp on which this openshift was last updated.
DraftOpenShift_openSlotCount	Int	False	OpenSlotCount of DraftOpenShift
SchedulingGroupId	String	False	The SchedulingGroupId.
SharedOpenShift_openSlotCount	Int	False	OpenSlotCount of SharedOpenShift
TeamId	String	False	The Team Id.
DraftOpenShift_displayName	String	False	The shift label of the shiftItem..
DraftOpenShift_notes	String	False	The shift notes for the shiftItem..
DraftOpenShift_StartDateTime	Datetime	False	StartDateTime of DraftOpenShift
DraftOpenShift_EndDateTime	Datetime	False	EndDateTime of DraftOpenShift
SharedOpenShift_displayName	String	False	The shift label of the shiftItem..
SharedOpenShift_notes	String	False	The shift notes for the shiftItem..
SharedOpenShift_StartDateTime	Datetime	False	StartDateTime of SharedOpenShift
SharedOpenShift_EndDateTime	Datetime	False	EndDateTime of SharedOpenShift

Schedules table for MSTeams data provider.

Table Specific Information

Select

Query the Schedules table by retrieving everything from teams or by specifying TeamId with = and IN operators. By default only the schedule items for teams of the groups you are a member of will be returned. To retreive schedules for teams of all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• TeamId supports the '=' and IN operators.

For example, the following query is processed server side:

SELECT * FROM Schedules WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Update

To update a schedule record Id and TeamId are required in WHERE clause.

UPDATE Schedules SET timeZone = 'Africa/Casablanca', enabled = true WHERE Id = '4729c5e5-f923-4435-8a41-44423d42ea79' AND TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	ID of the schedule.
TeamId [KEY]	String	False	The Team Id.
Enabled	Bool	False	Indicates whether the schedule is enabled for the team.
OfferShiftRequestsEnabled	Bool	False	Indicates whether offer shift requests are enabled for the schedule.
OpenShiftsEnabled	Bool	False	Indicates whether open shifts are enabled for the schedule.
ProvisionStatus	String	False	The status of the schedule provisioning. The possible values are notStarted, running, completed, failed.
ProvisionStatusCode	String	False	Additional information about why schedule provisioning failed.
SwapShiftsRequestsEnabled	Bool	False	Indicates whether swap shifts requests are enabled for the schedule.
TimeClockEnabled	Bool	False	Indicates whether time clock is enabled for the schedule.
TimeOffRequestsEnabled	Bool	False	Indicates whether time off requests are enabled for the schedule.
TimeZone	String	False	Indicates the time zone of the schedule team using tz database format.
WorkforceIntegrationIds	String	False	The WorkforceIntegration Ids.

SchedulingGroups table for MSTeams data provider.

Table Specific Information

Select

Query the SchedulingGroups table by retrieving everything from teams or by specifying TeamId with = and IN operators. By default only the scheduling groups for teams of the groups you are a member of will be returned. To retreive scheduling groups for teams of all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• TeamId supports the '=' and IN operators.
• Id supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM SchedulingGroups WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'TAG_357350ce-2fa2-498d-9967-494296509c32'

Insert

To insert a scheduling group for a team, you need to specify TeamId and at least one another field among DisplayName, IsActive, iconType.

INSERT INTO SchedulingGroups (TeamId, DisplayName, IsActive) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', 'Cashiers', 'true')

Update

To update a scheduling group Id and TeamId are required in WHERE clause. You can update DisplayName and IsActive fields.

UPDATE SchedulingGroups SET DisplayName = 'Supervisors' WHERE Id = 'TAG_357350ce-2fa2-498d-9967-494296509c32' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Delete

To delete a scheduling group Id and TeamId are required in WHERE clause.

DELETE FROM SchedulingGroups WHERE TeamId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1' AND Id = 'TAG_101f11df-e7c0-49f2-8d5c-a9ad085c97aa'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	ID of the schedulingGroup.
TeamId	String	False	The Team Id.
CreatedDateTime	Datetime	False	The time stamp in which this schedulingGroup was first created.
LastModifiedBy_application_displayName	String	False	The display name of the application that last modified.
LastModifiedBy_application_id	String	False	The id of the application that last modified.
LastModifiedDateTime	Datetime	False	The time stamp in which this schedulingGroup was last updated.
DisplayName	String	False	The display name for the schedulingGroup.
IsActive	Bool	False	Indicates whether the schedulingGroup can be used when creating new entities or updating existing ones.
UserIds	String	False	The list of user IDs that are a member of the schedulingGroup.

Shifts table for MSTeams data provider.

Table Specific Information

Select

Query the Shifts table by retrieving everything from teams or by specifying TeamId with = and IN operators. By default only the shifts for teams of the groups you are a member of will be returned. To retreive shift items for teams of all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• TeamId supports the '=' and IN operators.
• Id supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Shifts WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515')
SELECT * FROM Shifts WHERE Id = 'SHFT_aac21ce9-82b3-4ad1-a841-dadb570c8ebf' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Insert

To insert a shift into the team schedule, you need to specify TeamId, UserId to whom this timeoff is assigned and at least one of the DraftShift or SharedShift information including the startDateTime and endDateTime of the timeoff.

INSERT INTO Shifts (TeamId, UserId, draftShift_startDateTime, draftShift_endDateTime) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', '0409f710-2aa9-4f05-8944-ef382160f1d1', '2019-07-17T07:00:00Z', '2019-07-17T15:00:00Z')
INSERT INTO Shifts (TeamId, UserId, sharedShift_startDateTime, sharedShift_endDateTime) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', '0409f710-2aa9-4f05-8944-ef382160f1d1', '2019-07-17T07:00:00Z', '2019-07-17T15:00:00Z')

Update

To update a shift record Id and TeamId are required in WHERE clause. You can update any other field other than TeamId, Id and CreatedDateTime.

UPDATE Shifts SET draftShift_theme = 'blue', draftShift_displayname = 'somename' WHERE Id = 'SHFT_aac21ce9-82b3-4ad1-a841-dadb570c8ebf' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Delete

To delete a shift record Id and TeamId are required in WHERE clause.

DELETE FROM Shifts WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'SHFT_aac21ce9-82b3-4ad1-a841-dadb570c8ebf'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	ID of the shift.
TeamId	String	False	The Team Id.
UserId	String	False	ID of the user assigned to the shift.
CreatedDateTime	Datetime	False	The timestamp on which this shift was first created.
LastModifiedBy_application_displayName	String	False	The display name of the application that last modified.
LastModifiedBy_application_id	String	False	The id of the application that last modified.
LastModifiedDateTime	Datetime	False	The timestamp on which this shift was last updated.
DraftShift_activities	String	False	An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch.
DraftShift_displayName	String	False	The shift label of the shiftItem.
DraftShift_notes	String	False	The shift notes for the shiftItem.
DraftShift_startDateTime	Datetime	False	The start date and time for the Draftshift
DraftShift_endDateTime	Datetime	False	The end date and time for the Draftshift
SchedulingGroupId	String	False	ID of the scheduling group the shift is part of.
SharedShift_activities	String	False	An incremental part of a shift which can cover details of when and where an employee is during their shift. For example, an assignment or a scheduled break or lunch.
SharedShift_displayName	String	False	The shift label of the shiftItem.
SharedShift_notes	String	False	The shift notes for the shiftItem.
SharedShift_startDateTime	Datetime	False	The start date and time for the Sharedshift
SharedShift_endDateTime	Datetime	False	The end date and time for the Sharedshift

Teams table for MSTeams data provider.

Table Specific Information

Select

Query the Teams table by retrieving everything from teams or by specifying GroupId with = and IN operators. By default only the teams of the groups you are a member of will be returned. To retreive teams for all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• GroupId supports the '=' and IN operator.

For example, the following query is processed server side:

SELECT * FROM Teams WHERE GroupId IN ('4729c5e5-f923-4435-8a41-44423d42ea79', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1')

SELECT * FROM Teams WHERE GroupId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Insert

At least GroupId and DisplayName are required to insert a new team to a group. You can specify any other field as well.

INSERT INTO Teams (DisplayName, GroupId, funSettings_allowGiphy) VALUES ('Cool team', 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1', false)

Update

To update a team record you need to specify the Id in WHERE clause. Only unarchived teams can be updated.

UPDATE Teams SET DisplayName = 'My Team', funSettings_allowGiphy = false, funSettings_allowGiphy = true, funSettings_allowStickersAndMemes = true, funSettings_allowCustomMemes = false, guestSettings_allowCreateUpdateChannels = true, guestSettings_allowDeleteChannels = false, memberSettings_allowCreateUpdateChannels = false, memberSettings_allowDeleteChannels = true, Description = 'some desc' WHERE Id = '4729c5e5-f923-4435-8a41-44423d42ea79'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Team Id.
GroupId	String	False	The Group Id.
DisplayName	String	False	The name of the team.
Description	String	False	An optional description for the team.
Classification	String	False	An optional label. Typically describes the data or business sensitivity of the team. Must match one of a pre-configured set in the tenant's directory.
CreatedDateTime	Datetime	False	Timestamp at which the team was created.
FunSettings_allowCustomMemes	Bool	False	If set to true, enables users to include custom memes.
FunSettings_allowGiphy	Bool	False	If set to true, enables Giphy use.
FunSettings_allowStickersAndMemes	Bool	False	If set to true, enables users to include stickers and memes.
FunSettings_giphyContentRating	String	False	Giphy content rating. Possible values are: moderate, strict.
GuestSettings_allowCreateUpdateChannels	Bool	False	If set to true, guests can add and update channels.
GuestSettings_allowDeleteChannels	Bool	False	If set to true, guests can delete channels.
InternalId	String	False	A unique ID for the team that has been used in a few places such as the audit log/Office 365 Management Activity API.
IsArchived	Bool	False	Whether this team is in read-only mode.
MemberSettings_allowAddRemoveApps	Bool	False	If set to true, members can add and remove apps.
MemberSettings_allowCreatePrivateChannels	Bool	False	If set to true, members can add and update private channels.
MemberSettings_allowCreateUpdateChannels	Bool	False	If set to true, members can add and update any channels.
MemberSettings_allowCreateUpdateRemoveConnectors	Bool	False	If set to true, members can add, update, and remove connectors.
MemberSettings_allowCreateUpdateRemoveTabs	Bool	False	If set to true, members can add, update, and remove tabs.
MemberSettings_allowDeleteChannels	Bool	False	If set to true, members can delete channels.
MessagingSettings_allowChannelMentions	Bool	False	If set to true, @channel mentions are allowed.
MessagingSettings_allowOwnerDeleteMessages	Bool	False	If set to true, owners can delete any message.
MessagingSettings_allowTeamMentions	Bool	False	If set to true, @team mentions are allowed.
MessagingSettings_allowUserDeleteMessages	Bool	False	If set to true, users can delete their messages.
MessagingSettings_allowUserEditMessages	Bool	False	If set to true, users can edit their messages.
Specialization	String	False	Optional. Indicates whether the team is intended for a particular use case. Each team specialization has access to unique behaviors and experiences targeted to its use case.
Visibility	String	False	The visibility of the group and team. Defaults to Public.
WebUrl	String	False	A hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. This URL should be treated as an opaque blob, and not parsed.
Group_id	String	True	The Group Id.
PrimaryChannel_id	String	True	The PrimaryChannel Id.
Schedule_id	String	True	The Schedule Id.
Template_id	String	True	The Template Id.
summary_guestsCount	Integer	True	Count of guests in a team.
summary_membersCount	Integer	True	Count of members in a team.
summary_ownersCount	Integer	True	Count of owners in a team.

TeamsInstalledApps table for MSTeams data provider.

Columns

Name	Type	ReadOnly	Description
TeamId	String	False	Id of Team.
TeamsAppId	String	False	Id of TeamsApp.
TeamsAppDefinitionDescription	String	False	Teams App Definition Description.
TeamsAppDefinitionDisplayName	String	False	Teams App Definition Display Name
TeamsAppDefinitionLastModifiedDateTime	Datetime	False	Teams App Definition Last Modified Date Time
TeamsAppDefinitionPublishingState	String	False	Teams App Definition Publishing State
TeamsAppDefinitionShortDescription	String	False	Teams App Definition Short Description
TeamsAppDefinitionVersion	String	False	Teams App Definition Version

TeamTabs table for MSTeams data provider.

Table Specific Information

Select

To query the TeamsTabs table you need to specify TeamId and ChannelId filters in order to retreive tabs for the specified channel which belongs to the specified team. The Sync App 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 Sync App.

• TeamId and ChannelId support the '=' and IN operators. All the other columns support the '=', IN, LIKE, !=, IS, IS NOT operators.

For example, the following queries are processed server side:

SELECT * FROM TeamsTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]'
SELECT * FROM TeamsTabs WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5' AND ChannelId IN (SELECT Id FROM Channels WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5') AND Id LIKE '%-ade1-400a-a82b-e7a435199b7a'
SELECT * FROM TeamsTabs WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5' AND ChannelId IN (SELECT Id FROM Channels WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5') AND configuration_entityId IS NOT NULL

Insert

At least TeamId, ChannelId and AppID are required to insert a new tab in a channel. You can specify any other field as well.

INSERT INTO TeamsTabs (TeamId, ChannelId, DisplayName, AppID) VALUES ('4729c5e5-f923-4435-8a41-44423d42ea79', '19:[email protected]', 'new tab for test', '0d820ecd-def2-4297-adad-78056cde7c78')

Update

To update a tab record you need to specify the Id, ChannelId and TeamId in the WHERE clause.

UPDATE TeamsTabs SET DisplayName = 'updatetabname' WHERE Id = 'c41cbfe0-7713-44d6-96dd-b692569f1766' AND ChannelId = '19:[email protected]' AND TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Delete

To delete a tab record you need to specify the Id, ChannelId and TeamId in the WHERE clause.

DELETE FROM TeamsTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]' AND Id = '16ba49df-d7e1-4dc7-b6c3-ea721d327d38'

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	Identifier that uniquely identifies a specific instance of a channel tab.
AppId	String	False	The App Id.
ChannelId	String	False	The Channel Id.
Configuration_contentUrl	String	False	Url used for rendering tab contents in Teams. Required.
Configuration_entityId	String	False	Identifier for the entity hosted by the tab provider.
Configuration_removeUrl	String	False	Url called by Teams client when a Tab is removed using the Teams Client.
Configuration_websiteUrl	String	False	Url for showing tab contents outside of Teams.
DisplayName	String	False	Name of the tab.
WebUrl	String	False	Deep link URL of the tab instance.
TeamsApp_id	String	True	App definition identifier of the tab.
TeamId	String	False	The Team Id.

TimesOffReasons table for MSTeams data provider.

Table Specific Information

Select

Query the TimeOffReasons table by retrieving everything from teams or by specifying TeamId. By default only the timesoffreasons for teams of the groups you are a member of will be returned. To retrieve timesoffreasons for teams of all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• TeamId supports the '=' and IN operators.
• Id supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM TimeOffReasons WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515')
SELECT * FROM TimeOffReasons WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = 'SHFT_0aee55c3-2bac-4ede-9792-26838fc8bb01'

Insert

To insert a timeoff reason for a team, you need to specify TeamId and at least one another field among DisplayName, IsActive, iconType.

INSERT INTO TimeOffReasons (TeamId, DisplayName, IsActive) VALUES ('acabe397-8370-4c31-aeb7-2d7ae6b8cda1', 'a new reason', 'true')

Delete

To delete a timeoff reason record Id and TeamId are required in WHERE clause.

DELETE FROM TimeOffReasons WHERE Id = 'SHFT_dd50b99a-e2d8-44ad-a445-53ad58bfc37b' AND TeamId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	ID of the timeOffReason.
TeamId	String	False	The Team Id.
CreatedDateTime	Datetime	False	The time stamp on which this timeOffReason was first created.
LastModifiedBy_application_displayName	String	False	The display name of the application that last modified.
LastModifiedBy_application_id	String	False	The id of the application that last modified.
LastModifiedDateTime	Datetime	False	The time stamp on which this timeOffReason was last updated.
DisplayName	String	False	The name of the timeOffReason. Required.
IconType	String	False	Supported icon types: none; car; calendar; running; plane; firstAid; doctor; notWorking; clock; juryDuty; globe; cup; phone; weather; umbrella; piggyBank; dog; cake; trafficCone; pin; sunny.
IsActive	Bool	False	Indicates whether the timeOffReason can be used when creating new entities or updating existing ones.

TimesOff table for MSTeams data provider.

Table Specific Information

Select

Query the TimesOff table by retrieving everything from teams or by specifying TeamId. By default only the timesoff for teams of the groups you are a member of will be returned. To retreive timesoff for teams of all groups in your organization, set IncludeAllGroups property to true. The Sync App 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 Sync App.

• TeamId supports the IN and = operators.
• Id supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM TimesOff WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da834568-4df7-4c05-82a6-79d9f0274515')
SELECT * FROM TimesOff WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Insert

To insert a timeoff into the team schedule, you need to specify TeamId, UserId to whom this timeoff is assigned, and at least one of the DraftTimeOff or SharedTimeOff information including: the startDateTime, the endDateTime of the timeoff and a timeOff_ReasonId.

INSERT INTO TimesOff (TeamId, UserId, sharedTimeOff_startDateTime, sharedTimeOff_endDateTime, SharedTimeOff_TimeOffReasonId) VALUES ('da838338-4e77-4c05-82a6-79d9f0274511', '0409f710-2aa9-4f05-8944-ef382160f1d1', '2019-03-11T07:00:00Z', '2019-03-12T07:00:00Z', 'TOR_97de5f58-462b-4bde-8a95-038b4073bffb')

Update

To update a timeoff record Id and TeamId are required in WHERE clause. You can update any other field other than TeamId, Id and CreatedDateTime.

UPDATE Timesoff SET draftTimeOff_timeOffReasonId = 'TOR_97de5f58-462b-4bde-8a95-038b4073bffb' WHERE Id = 'SHFT_dd50b99a-e2d8-44ad-a445-53ad58bfc37b' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Delete

To delete a timesoff record Id and TeamId are required in WHERE clause.

DELETE FROM TimesOff WHERE Id = 'SHFT_dd50b99a-e2d8-44ad-a445-53ad58bfc37b' AND TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	ID of the timeOff.
UserId	String	False	ID of the user assigned to the timeOff.
TeamId	String	False	The Team Id.
CreatedDateTime	Datetime	False	The time stamp at which this timeOff was first created.
LastModifiedBy_application_displayName	String	False	The display name of the application that last modified.
LastModifiedBy_application_id	String	False	The id of the application that last modified.
LastModifiedDateTime	Datetime	False	The time stamp at which this timeOff was last updated.
DraftTimeOff_timeOffReasonId	String	False	DraftTimeOff's timeOffReasonId
SharedTimeOff_timeOffReasonId	String	False	SharedTimeOff's timeOffReasonId
DraftTimeOff_StartDateTime	Datetime	False	StartDateTime of DraftTimeOff
DraftTimeOff_EndDateTime	Datetime	False	EndDateTime of DraftTimeOff
SharedTimeOff_StartDateTime	Datetime	False	StartDateTime of DraftTimeOff
SharedTimeOfft_EndDateTime	Datetime	False	EndDateTime of DraftTimeOff

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Microsoft Teams Connector for CData Sync Views

Name	Description
CallRecords	Details of calls on MS Teams.
CallRecordSessions	Details of call sessions on MS Teams.
CallRecordSessionSegments	Details of call session segments on MS Teams.
ChannelMembers	Get members from channel.
ChannelMessages	Get Channel messages and its replies.
ChatMembers	Get members from chat.
ChatMessages	Get Chat Messages.
Chats	Get Chats.
DirectRoutingCalls	Retrieves a list of direct routing calls
PstnCalls	Retrieves a list of PSTN Calls
TeamMembers	Get members from team.
UserPresence	UserPresence table for MSTeams data provider.
Users	Users table for MSTeams data provider.

Details of calls on MS Teams.

Table Specific Information

Select

Query the CallRecords table to get details of PeerToPeer and Group Calls on Teams. The CallRecordsId should be acquired by following instructions in Get callRecord. Custom App and Client Credentials should be used. See Creating a Custom OAuth Application.

• CallRecordsId supports '=' operator.

The following is an example query:

SELECT * FROM CallRecords WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'

Columns

Name	Type	Description
Id [KEY]	String	Call record Id
EndDateTime	Datetime	Time the call ended
JoinWebUrl	String	URL used to join Meeting
LastModifiedDateTime	Datetime	Last Modified date of this call record
Modalities	String	Modalities which can be one or more of audio, video, videoBasedScreenSharing, data and screenSharing
Organizer	String	Details of the organizer of the meeting
Participants	String	Participants of the call.
StartDateTime	Datetime	Start time of the meeting
Type	String	Type of call peerToPeer or groupCall
Version	Long	Version
CallRecordsId	String	Call record Id. Mandatory internal column to be used in WHERE clause

Details of call sessions on MS Teams.

Table Specific Information

Select

Query the CallRecordSessions table to get details of PeerToPeer and Group Call session information on Teams. The CallRecordsId should be acquired by following instructions in Get callRecord. Custom App and Client Credentials should be used. See Creating a Custom OAuth Application

• CallRecordSessions supports '=' operator.

The following is an example query:

SELECT * FROM CallRecordSessions WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'

Columns

Name	Type	Description
Id [KEY]	String	Call record Id
Callee_UserAgent_ApplicationVersion	String	Callee UserAgent Application Version
Callee_UserAgent_HeaderValue	String	Callee UserAgent Header Value
Caller_UserAgent_ApplicationVersion	String	Caller UserAgent Application Version
Caller_UserAgent_HeaderValue	String	Caller UserAgent Header Value
EndDateTime	Datetime	Time the call ended
FailureInfo_Reason	String	Failure Information Reason
FailureInfo_Stage	String	Failure Information Stage
Modalities	String	Modalities which can be one or more of audio, video, videoBasedScreenSharing, data and screenSharing
StartDateTime	Datetime	Start time of the meeting
CallRecordsId	String	Call record Id. Mandatory internal column to be used in WHERE clause

Details of call session segments on MS Teams.

Table Specific Information

Select

Query the CallRecordSessionSegments table to get details of PeerToPeer and Group Call session segments information on Teams. The CallRecordsId should be acquired by following instructions in Get callRecord. Custom App and Client Credentials should be used. See Creating a Custom OAuth Application

• CallRecordSessionSegments supports '=' operator.

The following is an example query:

SELECT * FROM CallRecordSessionSegments WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'

Columns

Name	Type	Description
Id [KEY]	String	Call record Id
Callee_UserAgent_ApplicationVersion	String	Callee UserAgent Application Version
Callee_UserAgent_HeaderValue	String	Callee UserAgent Header Value
Caller_UserAgent_ApplicationVersion	String	Caller UserAgent Application Version
Caller_UserAgent_HeaderValue	String	Caller UserAgent Header Value
EndDateTime	Datetime	Time the call ended
FailureInfo_Reason	String	Failure Information Reason
FailureInfo_Stage	String	Failure Information Stage
Media	String	Call media details
StartDateTime	Datetime	Start time of the meeting
CallRecordsId	String	Call record Id. Mandatory internal column to be used in WHERE clause

Get members from channel.

Table Specific Information

SELECT

The Sync App uses the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators:

• ChannelId supports the '=' operator.
• TeamId supports the '=,IN' operators.

The rest of the filter is executed client side within the Sync App

For example, the following queries are processed server side:

SELECT * FROM ChannelMembers WHERE ChannelId = '19:[email protected]' AND TeamId = 'f7985bee-7fb4-404d-a954-5ba68ae7c8db'

SELECT * FROM ChannelMembers WHERE ChannelId = '19:[email protected]' AND TeamId IN ('f7985bee-7fb4-404d-a954-5ba68ae7c8db', 'da838338-4e77-4c05-82a6-79d9f0274511')

Columns

Name	Type	Description
Id [KEY]	String	Member Id.
TeamId	String	Team Id.
DisplayName	String	Display name.
email	String	Email of member.
Roles	String	Role of member.
TenantId	String	Tenant Id.
UserId	String	User Id.
StartDateTime	Datetime	History start date time.
ChannelId	String	The Channel Id.

Get Channel messages and its replies.

Table Specific Information

Select

The Sync App uses the Microsoft Teams API to process WHERE clause conditions built with the columns and operator shown below. The rest of the filter is executed client-side within the Sync App.

• TeamId supports '=' operator.
• ChannelId supports '=' operator.
• Id supports '=' operator.
• ReplyToId supports '=' operator.

Note: ChannelId and TeamId are required columns to get results from this view, and must both be specified in the WHERE clause. The data cannot be retrieved by the Sync App using ChannelId alone.

Example Queries

The Sync App executes this by fetching ChannelID and TeamId from Microsoft Teams API:

SELECT * FROM ChannelMessages

This query uses the TeamID from Microsoft Teams API to obtain the ChannelID:

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]'

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND Id='1688061957561'

To get all the replies in a message:

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND ReplyToId='1688061957561'

SELECT * FROM ChannelMessages WHERE TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79' AND ChannelId = '19:[email protected]' AND Id='1688061957562' AND ReplyToId='1688061957561'

Columns

Name	Type	Description
Id [KEY]	String	The Channel Messsages Id.
BodyContent	String	Content of the Body.
BodyContentType	String	Type of BodyContent.
ChannelId	String	The Channel Id.
TeamId	String	The Team Id.
Mentions	String	List of entities mentioned in the channel message. Supported entities are: user, bot, team, and channel.
Reactions	String	Reactions for the channel messages (for example, Like).
Attachments	String	References to attached objects like files, tabs, meetings etc.
Importance	String	Importance of the messages.
CreatedDateTime	Datetime	Timestamp of when the channel message was created.
LastEditedDateTime	Datetime	The timestamp on which this message was last edited.
LastModifiedDateTime	Datetime	The timestamp on which this message was last updated.
DeletedDateTime	Datetime	Timestamp at which the channel messages was deleted, or null if not deleted.
MessageType	String	Type of Channel message.
ChatId	String	The Chat Id.
Etag	String	Version number of the channel message.
FromUserDisplayName	String	From User Display Name.
FromUserId	String	From User Id.
FromUserUserIdentityType	String	From User UserIdentityType.
FromApplication	String	The From Application.
FromDevice	String	The From Device.
Locale	String	Locale of the channel message set by the client. Always set to en-us.
PolicyViolation	String	Channel Message Policy Violation.
ReplyToId	String	ID of the parent chat message or root chat message of the thread.
Subject	String	The subject of the channel message, in plaintext.
Summary	String	Summary text of the channel message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
WebUrl	String	Link to the message in Microsoft Teams.
EventDetail	String	The Event Message Detail.

Get members from chat.

Table Specific Information

SELECT

The Sync App use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator:

• UserId supports the '=' operator.
• ChatId supports the '=,IN' operators.

The rest of the filter is executed client side within the Sync App.

The following is an example query:

SELECT * FROM ChatMembers WHERE UserId = 'e4ea490e-b30c-4b1e-92b0-337117920315' AND ChatId = '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_90a27c51-5c74-453b-944a-134ba86da790@unq.gbl.spaces'

SELECT * FROM ChatMembers WHERE UserId = 'e4ea490e-b30c-4b1e-92b0-337117920315' AND ChatId IN ('19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_90a27c51-5c74-453b-944a-134ba86da790@unq.gbl.spaces', '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_b62067c0-8314-42f8-9d02-d1c2051dfcdc@unq.gbl.spaces')

Columns

Name	Type	Description
Id [KEY]	String	Member Id.
ChatId	String	Chat Id.
DisplayName	String	Display name.
email	String	Email of member.
Roles	String	Role of member.
TenantId	String	Tenant Id.
UserId	String	User Id.
StartDateTime	Datetime	History start date time.

Get Chat Messages.

Table Specific Information

Select

The Sync App uses the Microsoft Teams API to process WHERE clause conditions built with the following column and operator:

• ChatId supports '=' operator.

The rest of the filter is executed client side within the Sync App.

The following is an example query:

SELECT * FROM ChatMessages WHERE ChatId = '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_e4ea490e-b30c-4b1e-92b0-337117920315@unq.gbl.spaces'

Columns

Name	Type	Description
Id [KEY]	String	The Chat Messages Id.
ChatId	String	The Chat Id.
BodyContent	String	Content of the Body.
BodyContentType	String	Type of BodyContent.
MessageType	String	Type of chat message.
CreatedDateTime	Datetime	Timestamp of when the chat message was created.
LastEditedDateTime	Datetime	The timestamp on which this message was last edited.
LastModifiedDateTime	Datetime	The timestamp on which this message was last updated.
DeletedDateTime	Datetime	Timestamp at which the chat message was deleted, or null if not deleted.
Reactions	String	Reactions for the chat message (for example, Like).
Mentions	String	List of entities mentioned in the chat message. Supported entities are: user, bot, team, and channel.
Attachments	String	References to attached objects like files, tabs, meetings etc.
Importance	String	Importance of the messages.
FromUserDisplayName	String	From User Display Name.
FromUserId	String	From User Id.
FromUserIdentityType	String	From User UserIdentityType.
ChannelIdentity	String	Identity of the Channel.
Locale	String	Locale of the chat message set by the client. Always set to en-us.
ReplyToId	String	ID of the parent chat message or root chat message of the thread.
Subject	String	The subject of the chat message, in plaintext.
Summary	String	Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
PolicyViolation	String	Chat Message Policy Violation.
Etag	String	Version number of the chat message.
FromApplication	String	The From Application.
FromDevice	String	The From Device.
WebUrl	String	Link to the message in Microsoft Teams.
EventDetail	String	The Event Message Detail.

Get Chats.

Table Specific Information

Select

The Sync App use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator:

• Id supports '=' operator.

The rest of the filter is executed client side within the Sync App.

The following is an example query:

SELECT * FROM Chats WHERE Id = '19:32caef50-395c-425a-a994-e3fa4569b23b_92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe@unq.gbl.spaces'

Columns

Name	Type	Description
Id [KEY]	String	The Chat Id.
ChatType	String	The type of Chat.
UserId	String	The User Id.
CreatedDateTime	Datetime	Timestamp of when the message was created.
LastUpdatedDateTime	Datetime	The timestamp on which this message was last updated.
Topic	String	The Topic.

Retrieves a list of direct routing calls

Table Specific Information

Select

Custom App and Client Credentials should be used. See Creating a Custom OAuth Application The Sync App will use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• FromDate supports '=' operator.
• ToDate supports '=' operator.

Following is an example query:

SELECT * FROM DirectRoutingCalls WHERE FromDate = '2021-01-01'

SELECT * FROM DirectRoutingCalls WHERE FromDate = '2021-01-01' AND ToDate = '2021-02-09'

Note: FromDate and ToDate are required parameters , if they are not specified default dates will be taken with a date range of 90 days.

Columns

Name	Type	Description
Id	String	The Id of the Direct routing call
CorrelationId	String	The Correlation ID
UserId	String	The Id of the user
UserPrincipalName	String	The principal name of the user
UserDisplayName	String	The display name of the user
StartDateTime	Edm.DateTimeOffset	The start date time of the call
InviteDateTime	Edm.DateTimeOffset	The invite date time
FailureDateTime	Edm.DateTimeOffset	The failure date time
EndDateTime	Edm.DateTimeOffset	The end date time of the call
Duration	Integer	The duration of the call
CallType	String	The type of the call
SuccessfulCall	String	The successful call
CallerNumber	String	The caller number
CalleeNumber	String	The callee number
MediaPathLocation	String	The media path location
SignalingLocation	String	The signaling location
FinalSipCode	Integer	The final SIP Code
CallEndSubReason	Integer	The sub reason of the call end
FinalSipCodePhrase	String	The final SIP code phrase
MediaBypassEnabled	Boolean	Whether Media Bypass is enabled or not
FromDate	Edm.Date	The date from which calls to be fetched
ToDate	Edm.Date	the date till when calls to be fetched

Retrieves a list of PSTN Calls

Table Specific Information

Select

Custom App and Client Credentials should be used. See Creating a Custom OAuth Application The Sync App will use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• FromDate supports '=' operator.
• ToDate supports '=' operator.

Following is an example query:

SELECT * FROM PstnCalls WHERE FromDate = '2021-01-01'

SELECT * FROM PstnCalls WHERE FromDate = '2021-01-01' AND ToDate = '2021-02-09'

Note: FromDate and ToDate are required parameters , if they are not specified default dates will be taken with a date range of 90 days.

Columns

Name	Type	Description
Id	String	The Id of of the PSTN Call
CallId	String	The Id of the Call
UserId	String	The Id of the user
UserPrincipalName	String	The principal name of the user
UserDisplayName	String	The display name of the user
StartDateTime	Edm.DateTimeOffset	The datetime of the call when it was started
EndDateTime	Edm.DateTimeOffset	The datetime of the call when it was ended
Duration	Integer	The call duration
Charge	Edm.Double	The charge
CallType	String	The type of the call
Currency	String	Currency
CallerNumber	String	The number of the caller
CalleeNumber	String	The number of the callee
UsageCountryCode	String	The usage country code
TenantCountryCode	String	The tenant country code
ConnectionCharge	Edm.Double	The connection charge
DestinationName	String	The destination name
ConferenceId	String	The Id of the conference
LicenseCapability	String	The License Capability
InventoryType	String	The type of the inventory
FromDate	Edm.Date	The date from which calls to be fetched
ToDate	Edm.Date	the date till when calls to be fetched

Get members from team.

Table Specific Information

Select

The Sync App 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 Sync App.

• TeamId supports the '=,IN' operators.

For example, the following query is processed server side:

SELECT * FROM TeamMembers WHERE TeamId = 'f7985bee-7fb4-404d-a954-5ba68ae7c8db'

SELECT * FROM TeamMembers WHERE TeamId IN ('f7985bee-7fb4-404d-a954-5ba68ae7c8db', 'da838338-4e77-4c05-82a6-79d9f0274511')

Columns

Name	Type	Description
Id [KEY]	String	Member Id.
TeamId	String	Team Id.
DisplayName	String	Display name.
email	String	Email of member.
Roles	String	Role of member.
TenantId	String	Tenant Id.
UserId	String	User Id.
StartDateTime	Datetime	History start date time.

UserPresence table for MSTeams data provider.

Table Specific Information

Select

The Sync App will use the Microsoft Teams API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• Id supports '=' operator.

Following is an example query:

SELECT * FROM UserPresence WHERE Id = '142478877'

SELECT * FROM UserPresence WHERE Id IN ('0409f710-2aa9-4f05-8944-ef382160f1d1', '04a54c2f-2402-4cee-ac8e-9eee05d0dd30')

Columns

Name	Type	Description
Id	String	Id of the users.
Availability	String	Availbility of user
Activity	String	Activity of user

Users table for MSTeams data provider.

Table Specific Information

Select

Query the Users table. The Sync App 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 Sync App.

• Id supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = '08d30c14-2775-45c9-8809-3eca47340959'

Columns

Name	Type	Description
Id [KEY]	String	The unique identifier for the user.
DeletedDateTime	Datetime	The date and time when the user was deleted.
AboutMe	String	A freeform text entry field for the user to describe themselves.
AccountEnabled	Bool	true if the account is enabled; otherwise, false.
AgeGroup	String	Sets the age group of the user.
AssignedLicenses	String	The licenses that are assigned to the user.
AssignedPlans	String	The plans that are assigned to the user.
Birthday	Datetime	The birthday of the user.
BusinessPhones	String	The telephone numbers for the user.
City	String	The city in which the user is located.
CompanyName	String	The company name which the user is associated.
ConsentProvidedForMinor	String	Sets whether consent has been obtained for minors.
Country	String	The country/region in which the user is located
CreatedDateTime	Datetime	The date and time the user was created.
CreationType	String	Indicates whether the user account was created as a regular school or work account (null), an external account (Invitation), a local account for an Azure Active Directory B2C tenant (LocalAccount) or self-service sign-up using email verification (EmailVerified).
Department	String	The name for the department in which the user works.
DeviceEnrollmentLimit	Int	The Device Enrollment Limit.
DisplayName	String	The name displayed in the address book for the user.
EmployeeHireDate	Datetime	The date and time when the user was hired or will start work in case of a future hire.
EmployeeId	String	The employee identifier assigned to the user by the organization.
EmployeeOrgData_costCenter	String	The cost center associated with the user.
EmployeeOrgData_division	String	The name of the division in which the user works.
EmployeeType	String	Captures enterprise worker type.
ExternalUserState	String	For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.
ExternalUserStateChangeDateTime	Datetime	Shows the timestamp for the latest change to the externalUserState property.
FaxNumber	String	The fax number of the user.
GivenName	String	The given name (first name) of the user.
HireDate	Datetime	The hire date of the user.
Identities	String	Represents the identities that can be used to sign in to this user account.
ImAddresses	String	The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.
Interests	String	A list for the user to describe their interests.
IsResourceAccount	Bool	Do not use reserved for future use.
JobTitle	String	The user's job title.
LastPasswordChangeDateTime	Datetime	The time when this Azure AD user last changed their password.
LegalAgeGroupClassification	String	Used by enterprise applications to determine the legal age group of the user.
LicenseAssignmentStates	String	State of license assignments for this user.
Mail	String	The SMTP address for the user.
MailboxSettings_archiveFolder	String	Folder ID of an archive folder for the user.
MailboxSettings_automaticRepliesSetting_externalAudience	String	The set of audience external to the signed-in user's organization who will receive the ExternalReplyMessage, if Status is AlwaysEnabled or Scheduled. Possible values are: none, contactsOnly, all.
MailboxSettings_automaticRepliesSetting_externalReplyMessage	String	The automatic reply to send to the specified external audience, if Status is AlwaysEnabled or Scheduled.
MailboxSettings_automaticRepliesSetting_internalReplyMessage	String	The automatic reply to send to the audience internal to the signed-in user's organization, if Status is AlwaysEnabled or Scheduled.
MailboxSettings_automaticRepliesSetting_scheduledEndDateTime_dateTime	String	The date and time that automatic replies are set to end, if Status is set to Scheduled.
MailboxSettings_automaticRepliesSetting_scheduledEndDateTime_timeZone	String	The date and time that automatic replies are set to begin, if Status is set to Scheduled.
MailboxSettings_automaticRepliesSetting_status	String	Configurations status for automatic replies. Possible values are: disabled, alwaysEnabled, scheduled.
MailboxSettings_dateFormat	String	The date format for the user's mailbox.
MailboxSettings_delegateMeetingMessageDeliveryOptions	String	If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses.
MailboxSettings_language_displayName	String	The Language.
MailboxSettings_language_locale	String	The locale information for the user, including the preferred language and country/region.
MailboxSettings_timeFormat	String	The time format for the user's mailbox.
MailboxSettings_timeZone	String	The default time zone for the user's mailbox.
MailboxSettings_workingHours_daysOfWeek	String	The days of the week on which the user works.
MailboxSettings_workingHours_endTime	Time	The time of the day that the user starts working.
MailboxSettings_workingHours_startTime	Time	The time of the day that the user stops working.
MailboxSettings_workingHours_timeZone_name	String	The time zone to which the working hours apply.
MailNickname	String	The mail alias for the user.
MobilePhone	String	The primary cellular telephone number for the user.
MySite	String	The URL for the user's personal site.
OfficeLocation	String	The office location in the user's place of business.
OnPremisesDistinguishedName	String	Contains the on-premises Active Directory distinguished name or DN.
OnPremisesDomainName	String	Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory.
OnPremisesExtensionAttributes_extensionAttribute1	String	First customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute10	String	Tenth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute11	String	Eleventh customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute12	String	Twelfth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute13	String	Thirteenth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute14	String	Fourteenth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute15	String	Fifteenth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute2	String	Second customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute3	String	Third customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute4	String	Fourth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute5	String	Fifth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute6	String	Sixth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute7	String	Seventh customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute8	String	Eighth customizable extension attribute.
OnPremisesExtensionAttributes_extensionAttribute9	String	Ninth customizable extension attribute.
OnPremisesImmutableId	String	This property is used to associate an on-premises Active Directory user account to their Azure AD user object.
OnPremisesLastSyncDateTime	Datetime	Indicates the last time at which the object was synced with the on-premises directory
OnPremisesProvisioningErrors	String	Errors when using Microsoft synchronization product during provisioning.
OnPremisesSamAccountName	String	Contains the on-premises sAMAccountName synchronized from the on-premises directory.
OnPremisesSecurityIdentifier	String	Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud.
OnPremisesSyncEnabled	Bool	true if this object is synced from an on-premises directory; false if this object 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).
OnPremisesUserPrincipalName	String	Contains the on-premises userPrincipalName synchronized from the on-premises directory.
OtherMails	String	A list of additional email addresses for the user
PasswordPolicies	String	Specifies password policies for the user.
PasswordProfile_forceChangePasswordNextSignIn	Bool	If true, at next sign-in, the user must change their password. After a password change, this property will be automatically reset to *false. If not set, default is false.
PasswordProfile_forceChangePasswordNextSignInWithMfa	Bool	If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password.
PasswordProfile_password	String	The password for the user.
PastProjects	String	A list for the user to enumerate their past projects.
PostalCode	String	The postal code for the user's postal address.
PreferredLanguage	String	The preferred language for the user.
PreferredName	String	The preferred name for the user.
ProvisionedPlans	String	The plans that are provisioned for the user.
ProxyAddresses	String	The Proxy Address.
Responsibilities	String	A list for the user to enumerate their responsibilities.
Schools	String	A list for the user to enumerate the schools they have attended.
ShowInAddressList	Bool	true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false.
SignInSessionsValidFromDateTime	Datetime	Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph).
Skills	String	A list for the user to enumerate their skills.
State	String	The state or province in the user's address.
StreetAddress	String	The street address of the user's place of business.
Surname	String	The user's surname
UsageLocation	String	A two letter country code
UserPrincipalName	String	The user principal name (UPN) of the user.
UserType	String	UserType
Authentication_id	String	The Authentication Id
Calendar_id	String	The Calendar Id
Drive_id	String	The Drive Id
InferenceClassification_id	String	The InferenceClassification Id
Insights_id	String	The Insights Id
Manager_id	String	The Manager Id
Onenote_id	String	The Onenote Id
Outlook_id	String	The Outlook Id
Photo_id	String	The Photo Id
Planner_id	String	The Planner Id
Presence_id	String	The Presence Id
Settings_id	String	The Settings Id
Teamwork_id	String	The Teamwork Id
Todo_id	String	The Todo Id

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft Teams.

Azure Authentication

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
IncludeAllGroups	A boolean indicating if you would like to list all the groups in your organizations or only groups the logged in user is member of.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from MSTeams.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Microsoft Teams.

The type of authentication to use when connecting to Microsoft Teams.

Remarks

• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.
• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

This section provides a complete list of the Azure Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AzureTenant	The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureEnvironment	The Azure Environment to use when establishing a connection.

The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

The Azure Environment to use when establishing a connection.

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, CHINA, USGOVT, USGOVTDOD.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
OAuthGrantType	The grant type for the OAuth flow.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

The grant type for the OAuth flow.

Remarks

The following options are available: CODE,CLIENT

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the OAuth JWT certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The subject of the OAuth JWT certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Microsoft Teams and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\MSTeams Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
IncludeAllGroups	A boolean indicating if you would like to list all the groups in your organizations or only groups the logged in user is member of.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from MSTeams.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

A boolean indicating if you would like to list all the groups in your organizations or only groups the logged in user is member of.

Remarks

Setting this to true will list all the groups in your organization instead of only the groups the logged in user is member of.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from MSTeams.

Remarks

The Pagesize property affects the maximum number of results to return per page from MSTeams only for Users and Groups tables. If you must use client paging on your server and have a fast server, setting a higher Pagesize may be desireable. We recommend testing various sizes against a large resultset to determine what works best in your use case.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Teams WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.