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.

Authentication to Azure AD over a Web application always requires the creation of a custom OAuth application .

For details about creating a custom OAuth application, see Creating an Azure AD Application.

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 an Azure AD App with Service Principal.

Managed Service Identity (MSI)

If you are running Microsoft Teams on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials 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.

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

Creating an Azure AD Application

Microsoft Teams supports user-based authentication using Azure AD. This authentication is OAuth-based.

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Microsoft Teams via a desktop application or a headless machine. To connect to Microsoft Teams via the Web, you must always create a custom application, as described here.

However, since custom Azure AD applications seamlessly support all three commonly-used authentication flows, you might want to create a custom application (use your own Azure AD Applications Credentials) for those other authentication flows.

Custom OAuth applications are useful if you want to:

• Control branding of the authentication dialog.
• Control the redirect URI that the application redirects the user to after the user authenticates.
• Customize the permissions that you are requesting from the user.

Authenticating With Azure AD

In https://portal.azure.com:

1. In the left-hand navigation pane, select Azure Active Directory > App registrations.
2. Click New registration.
3. Enter a name for the application.

4. Specify the types of accounts this application should support:

   • For private use applications, select Accounts in this organization directory only.
   • For distributed applications, select one of the multi-tenant options.

   Note: If you select Accounts in this organizational directory only (default), when you establish a connection with CData Sync App you must set AzureTenant to the Id of the Azure AD Tenant. Otherwise, the authentication attempt fails.

5. Set the redirect URI to http://localhost:33333 (default) OR, if you want to specify a different port, specify the desired port and set CallbackURL to the exact reply URL you just defined.
6. To register the new application, click Register. An application management screen displays. Record these values for later use. (You will use the Application (client) ID value to set the OAuthClientId parameter, and the Directory (tenant) ID value to set the AzureTenant parameter.)
7. Navigate to Certificates & Secrets. Select New Client Secret for this application and specify the desired duration. After the client secret is saved, the Azure App Registration displays the key value. This value is displayed only once, so record it for future use. (You will use it to set the OAuthClientSecret.)
8. Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the Group.ReadWrite.All, AppCatalog.ReadWrite.All, and User.Read.All permissions.
9. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

Creating an Azure AD Application

Microsoft Teams supports user-based authentication using Azure AD. This authentication is OAuth-based.

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Microsoft Teams via a desktop application or a headless machine. To connect to Microsoft Teams via the Web, you must always create a custom application, as described here.

However, since custom Azure AD applications seamlessly support all three commonly-used authentication flows, you might want to create a custom application (use your own Azure AD Applications Credentials) for those other authentication flows.

Custom OAuth applications are useful if you want to:

• Control branding of the authentication dialog.
• Control the redirect URI that the application redirects the user to after the user authenticates.
• Customize the permissions that you are requesting from the user.

Authenticating With Azure AD

In https://portal.azure.com:

1. In the left-hand navigation pane, select Azure Active Directory > App registrations.
2. Click New registration.
3. Enter a name for the application.

4. Specify the types of accounts this application should support:

   • For private use applications, select Accounts in this organization directory only.
   • For distributed applications, select one of the multi-tenant options.

   Note: If you select Accounts in this organizational directory only (default), when you establish a connection with CData Sync App you must set AzureTenant to the Id of the Azure AD Tenant. Otherwise, the authentication attempt fails.

5. Set the redirect URI to http://localhost:33333 (default) OR, if you want to specify a different port, specify the desired port and set CallbackURL to the exact reply URL you just defined.
6. To register the new application, click Register. An application management screen displays. Record these values for later use. (You will use the Application (client) ID value to set the OAuthClientId parameter, and the Directory (tenant) ID value to set the AzureTenant parameter.)
7. Navigate to Certificates & Secrets. Select New Client Secret for this application and specify the desired duration. After the client secret is saved, the Azure App Registration displays the key value. This value is displayed only once, so record it for future use. (You will use it to set the OAuthClientSecret.)
8. Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the Group.ReadWrite.All, AppCatalog.ReadWrite.All, and User.Read.All permissions.
9. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

Creating an Azure AD App with Service Principal

Microsoft Teams supports Service Principal-based authentication, which is role-based. If you wish to use a Service Principal to authenticate to Microsoft Teams you must create a custom Azure AD application as described here.

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access control to access resources in your subscription.

Authenticating with an Azure Service Principal

In https://portal.azure.com:

1. In the left-hand navigation pane, select Azure Active Directory > App registrations.
2. Click New registration.
3. Enter a name for the application.
4. Select the desired tenant setup. Since this custom application is for Azure Service Principal, choose Any Microsoft Entra ID tenant - Multi Tenant.
5. To register the new application, click Register. An application management screen displays.
   Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
6. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
   • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine. For an example of how to create this certificate, see https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-self-signed-certificate.
   • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Microsoft Teams displays the key value. This value is displayed only once, so record it for future use. (This value becomes the OAuthClientSecret.)

7. Navigate to the Authentication tab and select the Access tokens option.
8. Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the Group.ReadWrite.All, AppCatalog.ReadWrite.All, and User.Read.All permissions.
9. Save your changes.

Consent for Client Credentials

OAuth supports the use of client credentials to authenticate. In a client credentials authentication flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow, except that there is no prompt for an associated user to provide credentials. All tasks accepted by the application are executed outside of the context of a default user.

Note: Since the embedded OAuth credentials authenticate on a per-user basis, you cannot use them in a client authentication flow. You must always create a custom Azure AD application to use client credentials.

In https://portal.azure.com:

1. Create a custom Azure AD application, as described above.
2. Navigate to App Registrations.
3. Find the application you just created, and open API Permissions.
4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
5. For use with Service Principal, specify Application permissions.
6. Select the permissions you require for your integration.

Creating an Azure AD App with Service Principal

Microsoft Teams supports Service Principal-based authentication, which is role-based. If you wish to use a Service Principal to authenticate to Microsoft Teams you must create a custom Azure AD application as described here.

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application, then register an application with the Azure AD tenant to create a new Service Principal. That new Service Principal can then leverage the assigned role-based access control to access resources in your subscription.

Authenticating with an Azure Service Principal

In https://portal.azure.com:

1. In the left-hand navigation pane, select Azure Active Directory > App registrations.
2. Click New registration.
3. Enter a name for the application.
4. Select the desired tenant setup. Since this custom application is for Azure Service Principal, choose Any Microsoft Entra ID tenant - Multi Tenant.
5. To register the new application, click Register. An application management screen displays.
   Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.
6. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.
   • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine. For an example of how to create this certificate, see https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-self-signed-certificate.
   • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Microsoft Teams displays the key value. This value is displayed only once, so record it for future use. (This value becomes the OAuthClientSecret.)

7. Navigate to the Authentication tab and select the Access tokens option.
8. Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the Group.ReadWrite.All, AppCatalog.ReadWrite.All, and User.Read.All permissions.
9. Save your changes.

Consent for Client Credentials

OAuth supports the use of client credentials to authenticate. In a client credentials authentication flow, credentials are created for the authenticating application itself. The auth flow acts just like the usual auth flow, except that there is no prompt for an associated user to provide credentials. All tasks accepted by the application are executed outside of the context of a default user.

Note: Since the embedded OAuth credentials authenticate on a per-user basis, you cannot use them in a client authentication flow. You must always create a custom Azure AD application to use client credentials.

In https://portal.azure.com:

1. Create a custom Azure AD application, as described above.
2. Navigate to App Registrations.
3. Find the application you just created, and open API Permissions.
4. Select the Microsoft Graph permissions. There are two distinct sets of permissions: Delegated and Application.
5. For use with Service Principal, specify Application permissions.
6. Select the permissions you require for your integration.

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

User Defined Views

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

SSL Configuration

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

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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'

Note: the summary columns are only populated when the table is filtered with the Id column. Additionally, there is no filtering allowed with the summary columns for this table.

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.

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.
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.
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.
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.
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 TeamTabs 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 TeamTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]'
SELECT * FROM TeamTabs 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 TeamTabs 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 TeamTabs (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 TeamTabs 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 TeamTabs 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 an Azure AD 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 an Azure AD 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 an Azure AD 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 an Azure AD 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 an Azure AD 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
StatusMessage_ExpiryDateTime_DateTime	String	StatusMessage_ExpiryDateTime_DateTime of user
StatusMessage_ExpiryDateTime_TimeZone	String	StatusMessage_ExpiryDateTime_TimeZone of user
StatusMessage_Message_Content	String	StatusMessage_Message_Content of user
StatusMessage_PublishedDateTime	Datetime	StatusMessage_PublishedDateTime 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 id of the user.
deletedDateTime	Datetime	The deletedDateTime of the user.
accountEnabled	Bool	Indicates if accountEnabled for the user.
assignedLicenses	String	The assignedLicenses of the user.
businessPhones	String	The businessPhones of the user.
city	String	The city of the user.
companyName	String	The companyName of the user.
country	String	The country of the user.
createdDateTime	Datetime	The createdDateTime of the user.
department	String	The department of the user.
displayName	String	The displayName of the user.
employeeHireDate	Datetime	The employeeHireDate of the user.
employeeId	String	The employeeId of the user.
employeeOrgData_costCenter	String	The employeeOrgData_costCenter of the user.
employeeOrgData_division	String	The employeeOrgData_division of the user.
employeeType	String	The employeeType of the user.
givenName	String	The givenName of the user.
identities	String	The identities of the user.
imAddresses	String	The imAddresses of the user.
isManagementRestricted	Bool	Indicator if user is management restricted.
isResourceAccount	Bool	Indicates if it isResourceAccount of the user.
jobTitle	String	The jobTitle of the user.
lastPasswordChangeDateTime	Datetime	The lastPasswordChangeDateTime of the user.
mail	String	The mail of the user.
mailNickname	String	The mailNickname of the user.
mobilePhone	String	The mobilePhone of the user.
officeLocation	String	The officeLocation of the user.
onPremisesDistinguishedName	String	The onPremisesDistinguishedName of the user.
onPremisesDomainName	String	The onPremisesDomainName of the user.
onPremisesExtensionAttributes_extensionAttribute1	String	The onPremisesExtensionAttributes_extensionAttribute1 of the user.
onPremisesExtensionAttributes_extensionAttribute10	String	The onPremisesExtensionAttributes_extensionAttribute10 of the user.
onPremisesExtensionAttributes_extensionAttribute11	String	The onPremisesExtensionAttributes_extensionAttribute11 of the user.
onPremisesExtensionAttributes_extensionAttribute12	String	The onPremisesExtensionAttributes_extensionAttribute12 of the user.
onPremisesExtensionAttributes_extensionAttribute13	String	The onPremisesExtensionAttributes_extensionAttribute13 of the user.
onPremisesExtensionAttributes_extensionAttribute14	String	The onPremisesExtensionAttributes_extensionAttribute14 of the user.
onPremisesExtensionAttributes_extensionAttribute15	String	The onPremisesExtensionAttributes_extensionAttribute15 of the user.
onPremisesExtensionAttributes_extensionAttribute2	String	The onPremisesExtensionAttributes_extensionAttribute2 of the user.
onPremisesExtensionAttributes_extensionAttribute3	String	The onPremisesExtensionAttributes_extensionAttribute3 of the user.
onPremisesExtensionAttributes_extensionAttribute4	String	The onPremisesExtensionAttributes_extensionAttribute4 of the user.
onPremisesExtensionAttributes_extensionAttribute5	String	The onPremisesExtensionAttributes_extensionAttribute5 of the user.
onPremisesExtensionAttributes_extensionAttribute6	String	The onPremisesExtensionAttributes_extensionAttribute6 of the user.
onPremisesExtensionAttributes_extensionAttribute7	String	The onPremisesExtensionAttributes_extensionAttribute7 of the user.
onPremisesExtensionAttributes_extensionAttribute8	String	The onPremisesExtensionAttributes_extensionAttribute8 of the user.
onPremisesExtensionAttributes_extensionAttribute9	String	The onPremisesExtensionAttributes_extensionAttribute9 of the user.
onPremisesImmutableId	String	The onPremisesImmutableId of the user.
onPremisesLastSyncDateTime	Datetime	The onPremisesLastSyncDateTime of the user.
onPremisesProvisioningErrors	String	The onPremisesProvisioningErrors of the user.
onPremisesSamAccountName	String	The onPremisesSamAccountName of the user.
onPremisesSecurityIdentifier	String	The onPremisesSecurityIdentifier of the user.
onPremisesSyncEnabled	Bool	Indicates onPremisesSyncEnabled for the user.
onPremisesUserPrincipalName	String	The onPremisesUserPrincipalName of the user.
otherMails	String	The otherMails of the user.
passwordProfile_forceChangePasswordNextSignIn	Bool	The passwordProfile_forceChangePasswordNextSignIn of the user.
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	The passwordProfile_forceChangePasswordNextSignInWithMfa of the user.
passwordProfile_password	String	The passwordProfile_password of the user.
postalCode	String	The postalCode of the user.
preferredLanguage	String	The preferredLanguage of the user.
serviceProvisioningErrors	String	The service provisioning errors of the user.
state	String	The state of the user.
streetAddress	String	The streetAddress of the user.
surname	String	The surname of the user.
userPrincipalName	String	The userPrincipalName of the user.
userType	String	The userType of the user.
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	Specifies the type of authentication to use when connecting to Microsoft Teams. If this property is left blank, the default authentication is used.
MsAppActsAsUserId	MsAppActsAsUserId is a user ID (GUID) required when querying certain tables or executing the ShareSchedule stored procedure if auth scheme is AzureServicePrincipal or AzureServicePrincipalCert.

Azure Authentication

---

Property	Description
AzureTenant	Identifies the Microsoft Teams tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

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 used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

SSL

---

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

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that 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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	The maximum number of results to return per page from MSTeams.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Microsoft Teams. If this property is left blank, the default authentication is used.
MsAppActsAsUserId	MsAppActsAsUserId is a user ID (GUID) required when querying certain tables or executing the ShareSchedule stored procedure if auth scheme is AzureServicePrincipal or AzureServicePrincipalCert.

Specifies the type of authentication to use when connecting to Microsoft Teams. If this property is left blank, the default authentication is used.

Remarks

• AzureAD: Perform Azure Active Directory (user-based) OAuth authentication.
• AzureMSI: Automatically obtain Azure AD Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Authenticate as an Azure Service Principal (role-based, application-based) using a Client Secret.
• AzureServicePrincipalCert: Authenticate as an Azure Service Principal (role-based, application-based) using a Certificate.

For information about creating a custom application to authenticate with Azure AD, see Creating an Azure AD Application.

For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating an Azure AD App with Service Principal.

MsAppActsAsUserId is a user ID (GUID) required when querying certain tables or executing the ShareSchedule stored procedure if auth scheme is AzureServicePrincipal or AzureServicePrincipalCert.

Remarks

MsAppActsAsUserId is required when querying the OpenShifts, SchedulingGroups, Shifts, Schedules, TimeOffReasons, TimesOff or executing the ShareSchedule stored procedure if the auth scheme is AzureServicePrincipal or AzureServicePrincipalCert.

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

---

Property	Description
AzureTenant	Identifies the Microsoft Teams tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).
AzureEnvironment	Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Identifies the Microsoft Teams tenant being used to access data, either by name (for example, contoso.omnicrosoft.com) or ID. (Conditional).

Remarks

A tenant is a digital representation of your organization, primarily associated with a domain (for example, microsoft.com). The tenant is managed through a Tenant ID (also known as the directory ID), which is specified whenever you assign users permissions to access or manage Azure resources.

To locate the directory ID in the Azure Portal, navigate to Azure Active Directory > Properties.

Specifying AzureTenant is required when AuthScheme = either AzureServicePrincipal or AzureServicePrincipalCert, or if AuthScheme = AzureAD and the user belongs to more than one tenant.

Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.

Remarks

Required if your Azure account is part of a different network than the Global network, such as China, USGOVT, or USGOVTDOD.

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

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

Remarks

In most cases, the default grant type should not be modified. For information about the most common OAuth grant types and the trade-offs between them, see https://oauth.net/2/grant-types/.

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 used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first 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.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

• If an exact match for the subject is found, the corresponding certificate is selected.
• If no exact match is found, the store is searched for certificates whose subjects contain the property value.
• If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:

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, enclose it in quotes. For example: "O=ACME, Inc.".

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

---

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

Specifies 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	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: 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.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Microsoft Teams. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Microsoft Teams. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Microsoft Teams. If the SOCKS 5 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.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

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.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made 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 proxy server set in the ProxyServer connection property.

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, set ProxyAutoDetect to False.

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

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

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

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	The maximum number of results to return per page from MSTeams.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

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.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.