CData Cloud offers access to Microsoft Teams across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Microsoft Teams through CData Cloud.
CData Cloud allows you to standardize and configure connections to Microsoft Teams as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Microsoft Teams in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Microsoft Teams and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Microsoft Teams through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Microsoft Teams by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Entra ID is a multi-tenant, cloud-based identity and access management platform. It supports OAuth-based authentication flows that enable the driver to access Microsoft Teams endpoints securely.
Authentication to Entra ID via a web application always requires that you first create and register a custom OAuth application. This enables your application to define its own redirect URI, manage credential scope, and comply with organization-specific security policies.
For full instructions on how to create and register a custom OAuth application, see Creating an Entra ID (Azure AD) Application.
After setting AuthScheme to AzureAD, the steps to authenticate vary, depending on the environment. For details on how to connect from desktop applications, web-based workflows, or headless systems, see the following sections.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user.
All tasks taken on by the application are executed without a default user context, but based on the assigned roles.
The application access to the resources is controlled through the assigned roles' permissions.
For information about how to set up Azure Service Principal authentication, see Creating a Service Principal App in Entra ID (Azure AD).
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.
If your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Teams supports OAuth-based authentication using Microsoft Entra ID. If you will connect via a web application and want to authenticate via Entra ID, you must first register a custom OAuth application in the Entra Admin Center, as described below.
If you will connect via a desktop application or headless machine, you can authenticate using Microsoft Teams's built-in embedded application credentials, which use CData branding. However, custom OAuth applications are also compatible with desktop and headless authentication flows, and may be preferable for production deployments or environments requiring strict policy control.
To register an OAuth application in Microsoft Entra ID, follow these steps:
Note: If you select Accounts in this organizational directory only, when you connect with CData Cloud, you must set AzureTenant to the tenant's ID (either GUID or verified domain). Otherwise, authentication will fail.
Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the following permissions:
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Teams supports OAuth-based authentication using Microsoft Entra ID. If you will connect via a web application and want to authenticate via Entra ID, you must first register a custom OAuth application in the Entra Admin Center, as described below.
If you will connect via a desktop application or headless machine, you can authenticate using Microsoft Teams's built-in embedded application credentials, which use CData branding. However, custom OAuth applications are also compatible with desktop and headless authentication flows, and may be preferable for production deployments or environments requiring strict policy control.
To register an OAuth application in Microsoft Entra ID, follow these steps:
Note: If you select Accounts in this organizational directory only, when you connect with CData Cloud, you must set AzureTenant to the tenant's ID (either GUID or verified domain). Otherwise, authentication will fail.
Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the following permissions:
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Teams supports Service Principal-based authentication, which is role-based. This means that the Service Principal's permissions are determined by the roles assigned to it. The roles specify what resources the Service Principal can access and which operations it can perform.
If you want to use a Service Principal to authenticate to Microsoft Teams, you must create a custom application in Microsoft Entra ID.
To enable Service Principal authentication:
Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the following permissions:
These permissions must be granted by an admin. To grant admin consent:
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 OAuth application to use client credentials.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Teams supports Service Principal-based authentication, which is role-based. This means that the Service Principal's permissions are determined by the roles assigned to it. The roles specify what resources the Service Principal can access and which operations it can perform.
If you want to use a Service Principal to authenticate to Microsoft Teams, you must create a custom application in Microsoft Entra ID.
To enable Service Principal authentication:
Select Required Permissions and then click Add. Under Select an API, select the Microsoft Graph and specifically select the following permissions:
These permissions must be granted by an admin. To grant admin consent:
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 OAuth application to use client credentials.
By default, the Cloud 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud models Microsoft Teams objects as an easy-to-use SQL database, using tables, views, and stored procedures. These are defined in schema files, which are simple, easy-to-read text files that define the structure and organization of data.
A Microsoft Teams object has relationships to other objects; in the tables, these relationships are expressed through foreign keys.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Microsoft Teams account.
Common tables include:
| Table | Description |
| Teams | Maintains records of Microsoft Teams instances, including team names, visibility settings, and associated group metadata. |
| Channels | Tracks Microsoft Teams channel instances, capturing names, privacy settings, types (standard, private), and team associations. |
| Users | Contains detailed profile, organizational, and directory synchronization information for users in Microsoft Teams, including contact details, licensing, job roles, and Active Directory mappings. |
| Groups | Holds core metadata about Microsoft 365 Groups, including properties required for provisioning and maintaining Teams. |
| GroupMembers | Represents the relationship between Microsoft 365 Groups and their members, including user identifiers and membership roles. |
| GroupOwners | Identifies users assigned as owners of Microsoft 365 Groups that support Teams functionality, enabling management actions. |
| TeamMembers | Retrieves the list of users who are members of a specific Microsoft Teams team. |
| ChannelMembers | Retrieves a list of members belonging to a specific Microsoft Teams channel. |
| Chats | Provides a list of chat threads within Microsoft Teams, including group and one-on-one chats. |
| ChatMessages | Returns messages sent and received in Microsoft Teams chat threads. |
| ChannelMessages | Returns messages and replies exchanged within a Microsoft Teams channel. |
| ChatMembers | Retrieves details of participants in Microsoft Teams chat conversations. |
| TeamsInstalledApps | Maintains records of Microsoft Teams instances, including team names, visibility settings, and associated group metadata. |
| Apps | Contains metadata for third-party and internal apps integrated into Microsoft Teams, including installation details, permissions, and usage metrics. |
| TeamTabs | Documents tabs added to Teams channels, including tab type (Planner, Website, custom app) and configuration data. |
| Schedules | Defines the overarching containers used in Teams Shifts for organizing shifts, time-off requests, and schedule groups. |
| Shifts | Captures detailed shift assignments, including assigned user, start and end times, and optional shift notes. |
| OpenShifts | Stores reusable shift templates created by managers in the Teams Shifts app, used to build individual shift schedules. |
| TimesOff | Logs time-off entries requested by users through the Microsoft Teams Shifts interface, with reason codes and date ranges. |
| TimeOffReasons | Contains predefined labels for time-off requests in Teams Shifts, such as vacation, sick leave, or training. |
Stored Procedures are SQL scripts that extend beyond standard CRUD operations. They accept parameters, execute functions, manage OAuth authentication tokens, and return data from the service, indicating success or failure.
The Cloud models the data in Microsoft Teams as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Apps | Contains metadata for third-party and internal apps integrated into Microsoft Teams, including installation details, permissions, and usage metrics. |
| Channels | Tracks Microsoft Teams channel instances, capturing names, privacy settings, types (standard, private), and team associations. |
| GroupMembers | Represents the relationship between Microsoft 365 Groups and their members, including user identifiers and membership roles. |
| GroupOwners | Identifies users assigned as owners of Microsoft 365 Groups that support Teams functionality, enabling management actions. |
| Groups | Holds core metadata about Microsoft 365 Groups, including properties required for provisioning and maintaining Teams. |
| OpenShifts | Stores reusable shift templates created by managers in the Teams Shifts app, used to build individual shift schedules. |
| Schedules | Defines the overarching containers used in Teams Shifts for organizing shifts, time-off requests, and schedule groups. |
| SchedulingGroups | Segments users into groups within a Teams schedule to streamline shift assignments and reporting. |
| Shifts | Captures detailed shift assignments, including assigned user, start and end times, and optional shift notes. |
| Teams | Maintains records of Microsoft Teams instances, including team names, visibility settings, and associated group metadata. |
| TeamsInstalledApps | Tracks which apps are installed in each Microsoft Team, detailing installation context such as user, group, or channel level. |
| TeamTabs | Documents tabs added to Teams channels, including tab type (Planner, Website, custom app) and configuration data. |
| TimeOffReasons | Contains predefined labels for time-off requests in Teams Shifts, such as vacation, sick leave, or training. |
| TimesOff | Logs time-off entries requested by users through the Microsoft Teams Shifts interface, with reason codes and date ranges. |
Contains metadata for third-party and internal apps integrated into Microsoft Teams, including installation details, permissions, and usage metrics.
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 Cloud 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 Cloud.
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)
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier automatically assigned to the app when it is added to the Teams app catalog. |
| displayName | String | False |
The human-readable name of the app as defined by the app developer for display in Microsoft Teams. |
| distributionMethod | String | False |
Specifies how the app is made available to users, such as via store listing, side-loading, or organization-wide deployment. |
| externalId | String | False |
The custom identifier defined by the app developer within the Teams app package, used for linking or internal tracking. |
Tracks Microsoft Teams channel instances, capturing names, privacy settings, types (standard, private), and team associations.
Query the Channels table by retrieving all channels in all teams or by specifying TeamId. The Cloud uses 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 Cloud
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.
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')
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier assigned to the channel by Microsoft Teams. |
| TeamId | String | False |
The identifier of the Team to which this channel belongs, used to associate the channel with its parent Team. |
| CreatedDateTime | Datetime | False |
The date and time when the channel was initially created, in UTC format. |
| Description | String | False |
An optional user-defined description that provides context or purpose for the channel. |
| DisplayName | String | False |
The name of the channel as shown in the Microsoft Teams interface to users. |
| String | False |
The email address assigned to the channel for message forwarding, available in channels with email integration. Read-only. | |
| IsArchived | Bool | False |
Indicates whether the channel is currently in a read-only, archived state. |
| IsFavoriteByDefault | Bool | False |
Specifies whether the channel is automatically pinned as a favorite for all team members upon creation. Only configurable via API during team creation. |
| MembershipType | String | False |
Defines the access type of the channel, such as standard, private, or shared. Set at creation time and cannot be changed later. |
| WebUrl | String | False |
The deep link URL to access the channel in Microsoft Teams. This link is generated via the 'Get link to channel' option and should be treated as an opaque identifier. |
Represents the relationship between Microsoft 365 Groups and their members, including user identifiers and membership roles.
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 Cloud 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 Cloud.
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'
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')
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'
| Name | Type | ReadOnly | Description |
| GroupId [KEY] | String | False |
The unique identifier of the Microsoft 365 Group to which the member belongs. Used to link the member to a specific group. |
| MemberId [KEY] | String | False |
The unique identifier of the user who is a member of the specified group. Represents the user's presence in the group membership list. |
Identifies users assigned as owners of Microsoft 365 Groups that support Teams functionality, enabling management actions.
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 Cloud 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 Cloud.
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'
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')
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'
| Name | Type | ReadOnly | Description |
| GroupId [KEY] | String | False |
The unique identifier of the Microsoft 365 Group for which the user has ownership responsibilities. |
| OwnerId [KEY] | String | False |
The unique identifier of the user who is designated as an owner of the specified group. Owners have elevated permissions such as managing membership and settings. |
Holds core metadata about Microsoft 365 Groups, including properties required for provisioning and maintaining Teams.
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 Cloud 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 Cloud.
For example, the following query is processed server side:
SELECT * FROM Groups WHERE Id = 'aee54826-eedb-4145-8e6b-4ec1ac4d82c6'
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)
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'
To delete a group record, you need to specify the Id in WHERE clause.
DELETE FROM Groups WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A globally unique identifier for the Microsoft 365 group. |
| DeletedDateTime | Datetime | False |
The date and time when the group was deleted, if applicable. |
| AllowExternalSenders | Bool | False |
Indicates whether users outside the organization are allowed to send emails to the group. Default is false. |
| AssignedLabels | String | False |
A list of sensitivity labels assigned to the group, shown as pairs of label ID and label name. |
| AssignedLicenses | String | False |
The licenses that are currently assigned to the group, used for managing feature availability. |
| AutoSubscribeNewMembers | Bool | False |
Specifies whether newly added members will automatically receive email notifications for group conversations. Settable only via PATCH requests. Default is false. |
| Classification | String | False |
A business impact level label such as low, medium, or high, used to describe the group's sensitivity classification. |
| CreatedDateTime | Datetime | False |
The timestamp representing when the group was originally created. |
| Description | String | False |
A text field to describe the group's purpose or usage within the organization. |
| DisplayName | String | False |
The user-friendly name shown in interfaces like Outlook and Teams for the group. |
| ExpirationDateTime | Datetime | False |
The date and time when the group is scheduled to expire, if expiration policies are applied. |
| GroupTypes | String | False |
Indicates the type of group (such as unified or dynamic) and how its membership is managed. |
| HideFromAddressLists | Bool | False |
If true, hides the group from address books, recipient pickers, and search dialogs in Outlook. |
| HideFromOutlookClients | Bool | False |
If true, hides the group from appearing in Outlook clients like Outlook for Windows and Outlook on the web. |
| IsSubscribedByMail | Bool | False |
Indicates whether the currently signed-in user is subscribed to receive group emails. |
| LicenseProcessingState_state | String | False |
The current state of license processing for group members. Reflects how licensing is being applied. |
| String | False |
The primary SMTP email address associated with the group's shared mailbox. | |
| MailEnabled | Bool | False |
Indicates whether the group supports mail functionality and has an associated mailbox. |
| MailNickname | String | False |
The email alias for the group, unique within the organization's namespace. |
| MembershipRule | String | False |
For dynamic groups, this contains the rule used to determine membership automatically. |
| MembershipRuleProcessingState | String | False |
Shows whether the membership rule engine is actively processing (On) or paused (Paused). |
| OnPremisesDomainName | String | False |
The fully qualified domain name (FQDN) from on-premises directory, if synchronized via Azure AD Connect. |
| OnPremisesLastSyncDateTime | Datetime | False |
The timestamp of the last successful synchronization of the group from on-premises to Azure Active Directory. |
| OnPremisesNetBiosName | String | False |
The NetBIOS name for the group, synchronized from the on-premises directory. |
| OnPremisesProvisioningErrors | String | False |
Describes any synchronization errors that occurred during on-premises provisioning. |
| OnPremisesSamAccountName | String | False |
The SAM account name from on-premises directory. Available only when directory sync is configured. |
| OnPremisesSecurityIdentifier | String | False |
The security identifier (SID) from on-premises directory, used to represent the group in Windows security models. |
| OnPremisesSyncEnabled | Bool | False |
Indicates whether the group is currently being synchronized from on-premises Active Directory. Null means it has never been synced. |
| PreferredDataLocation | String | False |
Specifies the desired Microsoft data center region for storing this group's content. |
| PreferredLanguage | String | False |
The default language preference for the group's communications and user interface. |
| ProxyAddresses | String | False |
A list of proxy email addresses that route messages to the group mailbox. |
| RenewedDateTime | Datetime | False |
The last time the group's expiration policy was renewed, either manually or automatically. |
| SecurityEnabled | Bool | False |
Indicates whether the group functions as a security group for controlling access to resources. |
| SecurityIdentifier | String | False |
The Windows security identifier for the group, used in authorization checks. |
| Theme | String | False |
The color theme assigned to the group in Microsoft 365. Possible values include Teal, Purple, Green, Blue, Pink, Orange, or Red. |
| UnseenCount | Int | False |
The number of group conversations with new posts since the user last viewed the group. |
| UniqueName | String | False |
An alternate, organization-wide unique name used to reference the group. |
| Visibility | String | False |
Defines whether the group is public, private, or hidden, affecting how users can discover and join it. |
| Members | String | False |
A list of unique identifiers representing the users who are members of the group. |
| Owners | String | False |
A list of user IDs representing the individuals who manage the group and have administrative permissions. |
| UserId | String | False |
The unique identifier of a user related to this group record, typically for context-specific queries. |
Stores reusable shift templates created by managers in the Teams Shifts app, used to build individual shift schedules.
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 Cloud 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 Cloud.
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'
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')
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'
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the scheduling group that this open shift is associated with. |
| CreatedDateTime | Datetime | False |
The date and time when the open shift was initially created. |
| IsStagedForDeletion | Bool | False |
Indicates whether the open shift is marked for future deletion but has not yet been removed. |
| LastModifiedBy_application_displayName | String | False |
The name of the application that most recently modified the open shift record. |
| LastModifiedBy_application_id | String | False |
The unique application ID of the system or app that last updated the open shift. |
| LastModifiedDateTime | Datetime | False |
The timestamp of the most recent update to the open shift. |
| DraftOpenShift_openSlotCount | Int | False |
The number of available slots for the draft version of the open shift, which has not yet been shared with the team. |
| SchedulingGroupId | String | False |
The unique identifier for the scheduling group under which this open shift is organized. |
| SharedOpenShift_openSlotCount | Int | False |
The number of available slots in the shared version of the open shift, visible to team members. |
| TeamId | String | False |
The identifier of the Microsoft Team where the open shift is being managed. |
| DraftOpenShift_displayName | String | False |
The label or title assigned to the draft version of the open shift for display purposes. |
| DraftOpenShift_notes | String | False |
Optional notes associated with the draft open shift, such as instructions or shift context. |
| DraftOpenShift_StartDateTime | Datetime | False |
The start time of the draft open shift, before it has been published. |
| DraftOpenShift_EndDateTime | Datetime | False |
The end time of the draft open shift, before it has been published. |
| SharedOpenShift_displayName | String | False |
The label or title assigned to the shared version of the open shift for display to users. |
| SharedOpenShift_notes | String | False |
Optional notes for the shared open shift, visible to team members when selecting shifts. |
| SharedOpenShift_StartDateTime | Datetime | False |
The start time of the shared open shift, which is published and available for team use. |
| SharedOpenShift_EndDateTime | Datetime | False |
The end time of the shared open shift, which is published and available for team use. |
Defines the overarching containers used in Teams Shifts for organizing shifts, time-off requests, and schedule groups.
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 Cloud 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 Cloud.
For example, the following query is processed server side:
SELECT * FROM Schedules WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511'
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier representing the schedule instance within Microsoft Teams. |
| TeamId [KEY] | String | False |
The identifier of the Microsoft Team that this schedule is associated with. |
| Enabled | Bool | False |
Specifies whether the schedule is currently active and usable by the associated team. |
| OfferShiftRequestsEnabled | Bool | False |
Indicates whether team members are allowed to offer their scheduled shifts to others. |
| OpenShiftsEnabled | Bool | False |
Indicates whether open shifts are supported, allowing managers to post available shifts for pickup. |
| ProvisionStatus | String | False |
Shows the current state of schedule provisioning. Valid values include notStarted, running, completed, and failed. |
| ProvisionStatusCode | String | False |
Provides additional details explaining why the schedule provisioning could have failed. |
| SwapShiftsRequestsEnabled | Bool | False |
Indicates whether team members are permitted to request a shift swap with another member. |
| TimeClockEnabled | Bool | False |
Specifies whether the time clock feature is enabled, allowing users to clock in and out through Teams. |
| TimeOffRequestsEnabled | Bool | False |
Indicates whether team members are allowed to submit time off requests through the schedule. |
| TimeZone | String | False |
Defines the time zone for the schedule, using IANA tz database format (for example, America/New_York). |
| WorkforceIntegrationIds | String | False |
A comma-separated list of integration identifiers linked to external workforce systems that sync with this schedule. |
Segments users into groups within a Teams schedule to streamline shift assignments and reporting.
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 Cloud 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 Cloud.
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'
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')
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'
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the scheduling group within the team. |
| TeamId | String | False |
The identifier of the Microsoft Team to which this scheduling group belongs. |
| CreatedDateTime | Datetime | False |
The date and time when the scheduling group was initially created. |
| LastModifiedBy_application_displayName | String | False |
The display name of the application that most recently modified the scheduling group. |
| LastModifiedBy_application_id | String | False |
The application ID of the app that last updated the scheduling group. |
| LastModifiedDateTime | Datetime | False |
The date and time when the scheduling group was last modified. |
| DisplayName | String | False |
The name displayed for the scheduling group in Microsoft Teams. |
| IsActive | Bool | False |
Indicates whether the scheduling group is currently active and available for use when creating or modifying shifts and schedules. |
| UserIds | String | False |
A comma-separated list of user IDs who are members of this scheduling group. Each ID represents a user assigned to this group. |
Captures detailed shift assignments, including assigned user, start and end times, and optional shift notes.
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 Cloud 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 Cloud.
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'
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')
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'
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for the shift record. |
| TeamId | String | False |
The identifier of the Microsoft Team to which this shift belongs. |
| UserId | String | False |
The unique identifier of the user assigned to this shift. |
| CreatedDateTime | Datetime | False |
The date and time when the shift was first created. |
| IsStagedForDeletion | Bool | False |
Indicates whether the shift is marked for deletion but has not yet been removed. |
| LastModifiedBy_application_displayName | String | False |
The name of the application that most recently modified the shift. |
| LastModifiedBy_application_id | String | False |
The unique application ID of the system or app that last updated the shift. |
| LastModifiedDateTime | Datetime | False |
The date and time of the last update to the shift. |
| DraftShift_activities | String | False |
A list of segments in the draft version of the shift, such as work assignments, breaks, or lunches, specifying what the employee is doing and when. |
| DraftShift_displayName | String | False |
A label assigned to the draft version of the shift for easier identification in the schedule. |
| DraftShift_notes | String | False |
Optional notes added to the draft shift, such as instructions or important reminders. |
| DraftShift_startDateTime | Datetime | False |
The scheduled start time of the draft shift. |
| DraftShift_endDateTime | Datetime | False |
The scheduled end time of the draft shift. |
| SchedulingGroupId | String | False |
The identifier of the scheduling group to which this shift is assigned. |
| SharedShift_activities | String | False |
A list of activities in the published (shared) version of the shift, such as assignments, breaks, or other scheduled duties. |
| SharedShift_displayName | String | False |
A label assigned to the shared version of the shift for users to see on the calendar. |
| SharedShift_notes | String | False |
Optional notes attached to the shared version of the shift for team member reference. |
| SharedShift_startDateTime | Datetime | False |
The published start time of the shift that is visible to the user. |
| SharedShift_endDateTime | Datetime | False |
The published end time of the shift that is visible to the user. |
Maintains records of Microsoft Teams instances, including team names, visibility settings, and associated group metadata.
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 Cloud 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 Cloud.
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'
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)
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the Microsoft Team. |
| GroupId | String | False |
The unique identifier for the Microsoft 365 Group backing the Team. |
| DisplayName | String | False |
The user-friendly name of the Team as shown in Microsoft Teams. |
| Description | String | False |
An optional description providing context or purpose for the Team. |
| Classification | String | False |
An optional label that describes the data or business sensitivity level of the Team, based on predefined classifications in the organization's directory. |
| CreatedDateTime | Datetime | False |
The date and time when the Team was created. |
| FunSettings_allowCustomMemes | Bool | False |
Indicates whether users are allowed to upload and use custom memes in the Team chat. |
| FunSettings_allowGiphy | Bool | False |
Indicates whether users are allowed to search and share Giphy images within the Team. |
| FunSettings_allowStickersAndMemes | Bool | False |
Indicates whether users can use pre-built stickers and memes in the Team. |
| FunSettings_giphyContentRating | String | False |
Specifies the Giphy content rating for the Team. Acceptable values include moderate and strict. |
| GuestSettings_allowCreateUpdateChannels | Bool | False |
Indicates whether guest users are allowed to create and update channels within the Team. |
| GuestSettings_allowDeleteChannels | Bool | False |
Indicates whether guest users are allowed to delete channels within the Team. |
| InternalId | String | False |
A system-level internal identifier used for auditing and integrations such as Office 365 Management Activity API. |
| IsArchived | Bool | False |
Indicates whether the Team is archived, meaning it is in read-only mode and no changes can be made. |
| MemberSettings_allowAddRemoveApps | Bool | False |
If true, Team members are allowed to install or remove apps within the Team. |
| MemberSettings_allowCreatePrivateChannels | Bool | False |
If true, Team members can create and manage private channels. |
| MemberSettings_allowCreateUpdateChannels | Bool | False |
If true, Team members are permitted to create new channels or update existing ones. |
| MemberSettings_allowCreateUpdateRemoveConnectors | Bool | False |
If true, Team members can configure connectors, including creating, updating, or removing them. |
| MemberSettings_allowCreateUpdateRemoveTabs | Bool | False |
If true, Team members can add, update, or remove tabs in Team channels. |
| MemberSettings_allowDeleteChannels | Bool | False |
If true, Team members have permission to delete channels. |
| MessagingSettings_allowChannelMentions | Bool | False |
If true, allows users to use @channel mentions to notify all members of a channel. |
| MessagingSettings_allowOwnerDeleteMessages | Bool | False |
If true, allows Team owners to delete any message posted in the Team. |
| MessagingSettings_allowTeamMentions | Bool | False |
If true, allows users to use @team mentions to notify all members of the Team. |
| MessagingSettings_allowUserDeleteMessages | Bool | False |
If true, allows users to delete their own messages. |
| MessagingSettings_allowUserEditMessages | Bool | False |
If true, allows users to edit their own messages after sending. |
| Specialization | String | False |
Indicates whether the Team is configured for a special use case (such as education or healthcare), which affects available features. |
| Visibility | String | False |
Specifies whether the Team is public or private. Public teams can be discovered and joined by anyone in the organization. |
| WebUrl | String | False |
A deep link to open the Team directly in the Microsoft Teams client. This link should not be parsed or altered. |
| summary_guestsCount | Integer | True |
The number of guest users who are part of the Team. |
| summary_membersCount | Integer | True |
The number of members in the Team, excluding guests and owners. |
| summary_ownersCount | Integer | True |
The number of users who have owner-level permissions in the Team. |
Tracks which apps are installed in each Microsoft Team, detailing installation context such as user, group, or channel level.
| Name | Type | ReadOnly | Description |
| TeamId | String | False |
The unique identifier of the Microsoft Team where the app is installed. |
| TeamsAppId | String | False |
The identifier of the Teams app instance installed in the Team. |
| TeamsAppDefinitionDescription | String | False |
A detailed description of the app as defined in the app's manifest or Teams App Catalog. |
| TeamsAppDefinitionDisplayName | String | False |
The name of the Teams app as shown to users in the Microsoft Teams client. |
| TeamsAppDefinitionLastModifiedDateTime | Datetime | False |
The timestamp indicating when the app definition was last updated in the Teams App Catalog. |
| TeamsAppDefinitionPublishingState | String | False |
The current publishing state of the app definition, such as submitted, published, or rejected. |
| TeamsAppDefinitionShortDescription | String | False |
A brief summary of the app's functionality or purpose, taken from the app manifest. |
| TeamsAppDefinitionVersion | String | False |
The version number of the app definition currently installed in the Team. |
Documents tabs added to Teams channels, including tab type (Planner, Website, custom app) and configuration data.
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 Cloud 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 Cloud.
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
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')
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'
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'
| Name | Type | ReadOnly | Description |
| id [KEY] | String | False |
A unique identifier for the specific tab instance within a channel. |
| AppId | String | False |
The identifier of the app associated with the tab. |
| ChannelId | String | False |
The identifier of the channel where the tab is located. |
| Configuration_contentUrl | String | False |
The URL used by Teams to render the tab content inside the Teams client. This is required for the tab to function. |
| Configuration_entityId | String | False |
A custom identifier for the entity represented by the tab, used by the app to load specific data or context. |
| Configuration_removeUrl | String | False |
The callback URL invoked by the Teams client when a tab is removed. Used for cleanup or telemetry. |
| Configuration_websiteUrl | String | False |
A publicly accessible URL used to view the tab's contents outside of Microsoft Teams. |
| DisplayName | String | False |
The display name of the tab, shown in the channel tab navigation. |
| WebUrl | String | False |
A deep link URL that opens the tab instance directly in the Teams client. |
| TeamsApp_id | String | True |
The unique identifier for the Teams app definition used by the tab. |
| TeamId | String | False |
The identifier of the Team that contains the tab and its associated channel. |
Contains predefined labels for time-off requests in Teams Shifts, such as vacation, sick leave, or training.
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 Cloud 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 Cloud.
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'
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')
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the time off reason entry. |
| TeamId | String | False |
The identifier of the Microsoft Team that this time off reason is associated with. |
| CreatedDateTime | Datetime | False |
The date and time when the time off reason was initially created. |
| LastModifiedBy_application_displayName | String | False |
The name of the application that most recently modified this time off reason. |
| LastModifiedBy_application_id | String | False |
The application ID of the service or app that last updated this time off reason. |
| LastModifiedDateTime | Datetime | False |
The timestamp of the most recent update to the time off reason entry. |
| DisplayName | String | False |
The display name for the time off reason, such as Vacation, Sick Leave, or Jury Duty. Required field. |
| IconType | String | False |
The icon representing the time off reason. Supported values: 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 this time off reason is currently active and available for use in new or updated time off requests. |
Logs time-off entries requested by users through the Microsoft Teams Shifts interface, with reason codes and date ranges.
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 Cloud 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 Cloud.
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'
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')
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'
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'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for the time off entry. |
| UserId | String | False |
The unique identifier of the user who submitted or was assigned this time off request. |
| TeamId | String | False |
The identifier of the Microsoft Team associated with the time off request. |
| CreatedDateTime | Datetime | False |
The date and time when the time off request was first created. |
| IsStagedForDeletion | Bool | False |
Indicates whether the time off entry is marked for deletion but has not yet been removed. |
| LastModifiedBy_application_displayName | String | False |
The name of the application that most recently modified the time off entry. |
| LastModifiedBy_application_id | String | False |
The unique application ID of the system or service that last modified the entry. |
| LastModifiedDateTime | Datetime | False |
The date and time when the time off entry was last updated. |
| DraftTimeOff_timeOffReasonId | String | False |
The identifier for the reason associated with the draft version of the time off request. |
| SharedTimeOff_timeOffReasonId | String | False |
The identifier for the reason associated with the shared (published) version of the time off request. |
| DraftTimeOff_StartDateTime | Datetime | False |
The scheduled start date and time for the draft version of the time off. |
| DraftTimeOff_EndDateTime | Datetime | False |
The scheduled end date and time for the draft version of the time off. |
| SharedTimeOff_StartDateTime | Datetime | False |
The scheduled start date and time for the published version of the time off. |
| SharedTimeOfft_EndDateTime | Datetime | False |
The scheduled end date and time for the published version of the time off. |
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.
| Name | Description |
| CallRecordParticipants | Details of call sessions on MS Teams. |
| CallRecords | Provides an overview of call activity in Microsoft Teams, including metadata such as call duration and type. |
| CallRecordSessions | Lists sessions within Microsoft Teams calls, with details on session start and end times. |
| CallRecordSessionSegments | Breaks down call sessions in Microsoft Teams into smaller segments for granular tracking of media streams. |
| ChannelMembers | Retrieves a list of members belonging to a specific Microsoft Teams channel. |
| ChannelMessages | Returns messages and replies exchanged within a Microsoft Teams channel. |
| ChatMembers | Retrieves details of participants in Microsoft Teams chat conversations. |
| ChatMessageAttachments | Get Chat Message Attachments. |
| ChatMessageMentions | Get Chat Message Mentions. |
| ChatMessages | Returns messages sent and received in Microsoft Teams chat threads. |
| Chats | Provides a list of chat threads within Microsoft Teams, including group and one-on-one chats. |
| DirectRoutingCalls | Displays direct routing call records in Microsoft Teams for telephony integration analysis. |
| PstnCalls | Displays Public Switched Telephone Network (PSTN) call records in Microsoft Teams. |
| TeamMembers | Retrieves the list of users who are members of a specific Microsoft Teams team. |
| UserPresence | Stores real-time presence information for Microsoft Teams users. |
| Users | Contains detailed profile, organizational, and directory synchronization information for users in Microsoft Teams, including contact details, licensing, job roles, and Active Directory mappings. |
Details of call sessions on MS Teams.
Query the CallRecordParticipants 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 Entra ID (Azure AD) Application
The following is an example query:
SELECT * FROM CallRecordParticipants WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
| Name | Type | Description |
| Id [KEY] | String | Call record Id |
| CallRecordsId | String | Call record Id. Mandatory internal column to be used in WHERE clause |
| displayName | String | |
| userId | String | |
| tenantId | String | |
| userPrincipalName | String |
Provides an overview of call activity in Microsoft Teams, including metadata such as call duration and type.
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 Entra ID (Azure AD) Application.
The following is an example query:
SELECT * FROM CallRecords WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the call record in Microsoft Teams. |
| EndDateTime | Datetime | Timestamp indicating when the call ended. |
| JoinWebUrl | String | Web URL that participants used to join the meeting. |
| LastModifiedDateTime | Datetime | Timestamp of the most recent modification to this call record. |
| Modalities | String | Communication modes used during the call, which can include audio, video, videoBasedScreenSharing, data, and screenSharing. |
| StartDateTime | Datetime | Timestamp indicating when the call or meeting started. |
| Type | String | Specifies whether the call was peerToPeer or groupCall. |
| Version | Long | Version number of the call record for internal tracking. |
| organizer_v2_id | String | Unique identifier for the meeting organizer in Microsoft Teams. |
| organizer_v2_displayName | String | Full display name of the user who organized the meeting. |
| organizer_v2_userId | String | User ID of the meeting organizer within Microsoft Teams. |
| organizer_v2_tenantId | String | Tenant ID associated with the meeting organizer's Microsoft 365 account. |
| organizer_v2_userPrincipalName | String | User Principal Name (UPN) of the meeting organizer. |
| CallRecordsId | String | Mandatory internal column representing the call record ID, used in WHERE clauses to filter records. |
Lists sessions within Microsoft Teams calls, with details on session start and end times.
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 Entra ID (Azure AD) Application
The following is an example query:
SELECT * FROM CallRecordSessions WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the call record session in Microsoft Teams. |
| Callee_UserAgent_ApplicationVersion | String | Version of the application used by the callee's user agent during the session. |
| Callee_UserAgent_HeaderValue | String | Header value from the callee's user agent during the session. |
| Caller_UserAgent_ApplicationVersion | String | Version of the application used by the caller's user agent during the session. |
| Caller_UserAgent_HeaderValue | String | Header value from the caller's user agent during the session. |
| EndDateTime | Datetime | Timestamp indicating when the call session ended. |
| FailureInfo_Reason | String | Reason for the call session failure, if applicable. |
| FailureInfo_Stage | String | Stage at which the call session failure occurred, if applicable. |
| Modalities | String | Communication modes used in the session, which can include audio, video, videoBasedScreenSharing, data, and screenSharing. |
| StartDateTime | Datetime | Timestamp indicating when the call session started. |
| CallRecordsId | String | Mandatory internal column representing the call record ID, used in WHERE clauses to filter records. |
Breaks down call sessions in Microsoft Teams into smaller segments for granular tracking of media streams.
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 Entra ID (Azure AD) Application
The following is an example query:
SELECT * FROM CallRecordSessionSegments WHERE CallRecordsId = 'b6ee7caa-f730-451f-b6bd-24592a3429a7'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the call record session segment in Microsoft Teams. |
| Callee_UserAgent_ApplicationVersion | String | Version of the application used by the callee's user agent during this session segment. |
| Callee_UserAgent_HeaderValue | String | Header value from the callee's user agent during this session segment. |
| Caller_UserAgent_ApplicationVersion | String | Version of the application used by the caller's user agent during this session segment. |
| Caller_UserAgent_HeaderValue | String | Header value from the caller's user agent during this session segment. |
| EndDateTime | Datetime | Timestamp indicating when the session segment ended. |
| FailureInfo_Reason | String | Reason for failure during the session segment, if applicable. |
| FailureInfo_Stage | String | Stage of the call session where the failure occurred, if applicable. |
| Media | String | Details about media streams used during the session segment, such as audio or video. |
| StartDateTime | Datetime | Timestamp indicating when the session segment started. |
| CallRecordsId | String | Mandatory internal column representing the call record ID, used in WHERE clauses to filter records. |
Retrieves a list of members belonging to a specific Microsoft Teams channel.
The Cloud uses the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators:
Note: ChannelId and TeamId must be included in the WHERE clause to retrieve any data from the ChannelMembers view. These filters are required by the API and are evaluated server-side.
The rest of the filter is executed client-side within the Cloud.
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')
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the channel member in Microsoft Teams. |
| TeamId | String | Identifier of the team to which the channel belongs. |
| DisplayName | String | Full display name of the channel member. |
| String | Email address of the channel member. | |
| Roles | String | Roles assigned to the channel member, such as owner or member. |
| TenantId | String | Identifier of the Microsoft 365 tenant associated with the member. |
| UserId | String | Unique user identifier for the channel member. |
| StartDateTime | Datetime | Timestamp indicating when the membership history for the channel started. |
| ChannelId | String | Identifier of the Microsoft Teams channel where the member is assigned. |
Returns messages and replies exchanged within a Microsoft Teams channel.
The Cloud 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 Cloud.
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 Cloud using ChannelId alone.
Example Queries
The Cloud 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'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the channel message in Microsoft Teams. |
| BodyContent | String | Plaintext or rich text content of the message body. |
| BodyContentType | String | Specifies the format of the message body content, such as text or HTML. |
| ChannelId | String | Identifier of the Microsoft Teams channel where the message was posted. |
| TeamId | String | Identifier of the team associated with the channel. |
| Mentions | String | List of entities mentioned in the message. Supported entities include user, bot, team, and channel. |
| Reactions | String | List of reactions applied to the channel message, such as like or heart. |
| Attachments | String | References to objects attached to the message, such as files, tabs, or meetings. |
| Importance | String | Priority level of the message, such as normal, high, or urgent. |
| CreatedDateTime | Datetime | Timestamp indicating when the message was created. |
| LastEditedDateTime | Datetime | Timestamp indicating when the message was last edited. |
| LastModifiedDateTime | Datetime | Timestamp indicating when the message was last updated. |
| DeletedDateTime | Datetime | Timestamp indicating when the message was deleted, or null if it has not been deleted. |
| MessageType | String | Type of message, such as standard or system notification. |
| ChatId | String | Identifier of the chat thread when the message is part of a threaded conversation. |
| Etag | String | Version identifier for the message used for concurrency control. |
| FromUserDisplayName | String | Display name of the user who sent the message. |
| FromUserId | String | Unique identifier of the user who sent the message. |
| FromUserUserIdentityType | String | Specifies the identity type of the user who sent the message. |
| FromApplication | String | Name of the application that sent the message, if applicable. |
| FromDevice | String | Name of the device used to send the message, if available. |
| Locale | String | Locale setting of the message as defined by the client application, typically en-us. |
| PolicyViolation | String | Details about any policy violations associated with the message. |
| ReplyToId | String | Identifier of the parent message when the current message is part of a reply thread. |
| Subject | String | Subject line of the message in plaintext, if provided. |
| Summary | String | Summary text of the message for use in notifications, previews, or fallback views. Applies only to channel messages. |
| WebUrl | String | Direct link to view the message in Microsoft Teams. |
| EventDetail | String | Details about the event associated with the message, if applicable. |
Retrieves details of participants in Microsoft Teams chat conversations.
The Cloud use the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators:
Note: UserId and ChatId must be included in the WHERE clause to retrieve any data from the ChatMembers view. These filters are required by the API and are evaluated server-side.
The rest of the filter is executed client-side within the Cloud.
For example, the following queries are processed server-side:
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')
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the chat member in Microsoft Teams. |
| ChatId | String | Identifier of the chat to which the member belongs. |
| DisplayName | String | Full display name of the chat member. |
| String | Email address of the chat member. | |
| Roles | String | Roles assigned to the chat member, such as owner or participant. |
| TenantId | String | Identifier of the Microsoft 365 tenant associated with the chat member. |
| UserId | String | Unique user identifier for the chat member. |
| StartDateTime | Datetime | Timestamp indicating when the membership history for the chat started. |
Get Chat Message Attachments.
The Cloud uses 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 Cloud.
The following is an example query:
SELECT * FROM ChatMessageAttachments WHERE ChatId = '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_e4ea490e-b30c-4b1e-92b0-337117920315@unq.gbl.spaces'
| Name | Type | Description |
| Id | String | The Chat Messages Id. |
| ChatId | String | The Chat Id. |
| Attachments_Id | String | The Id of the attachment. |
| Content | String | The Content of the attachment. |
| ContentType | String | The ContentType of the attachment. |
| ContentUrl | String | The ContentUrl of the attachment. |
| Name | String | The Name of the attachment. |
| TeamsAppId | String | The TeamsAppId of the attachment. |
| ThumbnailUrl | String | The ThumbnailUrl of the attachment. |
Get Chat Message Mentions.
The Cloud uses 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 Cloud.
The following is an example query:
SELECT * FROM ChatMessageMentions WHERE ChatId = '19:92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe_e4ea490e-b30c-4b1e-92b0-337117920315@unq.gbl.spaces'
| Name | Type | Description |
| Id | String | The Chat Messages Id. |
| ChatId | String | The Chat Id. |
| Mentions_Id | Int | The Id of the mention. |
| MentionText | String | The MentionText of the mention. |
| User_Id | String | The User_Id of the mention. |
| User_DisplayName | String | The User_DisplayName of the mention. |
| User_TenantId | String | The User_TenantId of the mention. |
| Application_Id | String | The Application_Id of the mention. |
| Application_DisplayName | String | The Application_DisplayName of the mention. |
| Application_TenantId | String | The Application_TenantId of the mention. |
| Device_Id | String | The Device_Id of the mention. |
| Device_DisplayName | String | The Device_DisplayName of the mention. |
| Device_TenantId | String | The Device_TenantId of the mention. |
| Conversation_Id | String | The Conversation_Id of the mention. |
| Conversation_DisplayName | String | The Conversation_DisplayName of the mention. |
| Conversation_ConversationIdentityType | String | The Conversation_ConversationIdentityType of the mention. |
Returns messages sent and received in Microsoft Teams chat threads.
The Cloud uses 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 Cloud.
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'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the chat message in Microsoft Teams. |
| ChatId | String | Identifier of the chat thread containing the message. |
| BodyContent | String | Plaintext or rich text content of the chat message body. |
| BodyContentType | String | Specifies the format of the message body content, such as text or HTML. |
| MessageType | String | Type of chat message, such as standard or system notification. |
| CreatedDateTime | Datetime | Timestamp indicating when the chat message was created. |
| LastEditedDateTime | Datetime | Timestamp indicating when the chat message was last edited. |
| LastModifiedDateTime | Datetime | Timestamp indicating when the chat message was last updated. |
| DeletedDateTime | Datetime | Timestamp indicating when the chat message was deleted, or null if it has not been deleted. |
| Reactions | String | List of reactions applied to the chat message, such as like or heart. |
| Mentions | String | List of entities mentioned in the chat message. Supported entities include user, bot, team, and channel. |
| Attachments | String | References to objects attached to the message, such as files, tabs, or meetings. |
| Importance | String | Priority level of the chat message, such as normal, high, or urgent. |
| FromUserDisplayName | String | Display name of the user who sent the message. |
| FromUserId | String | Unique identifier of the user who sent the message. |
| FromUserIdentityType | String | Specifies the identity type of the user who sent the message. |
| ChannelIdentity | String | Identifier of the Microsoft Teams channel associated with the message, if applicable. |
| Locale | String | Locale setting of the message as defined by the client application, typically en-us. |
| ReplyToId | String | Identifier of the parent chat message if this message is part of a reply thread. |
| Subject | String | Subject line of the chat message, in plaintext. |
| Summary | String | Summary text of the chat message for use in notifications, previews, or fallback views. Applies only to channel chat messages. |
| PolicyViolation | String | Details about any policy violations associated with the chat message. |
| Etag | String | Version identifier for the chat message used for concurrency control. |
| FromApplication | String | Name of the application that sent the message, if applicable. |
| FromDevice | String | Name of the device used to send the message, if available. |
| WebUrl | String | Direct link to view the message in Microsoft Teams. |
| EventDetail | String | Details about the event associated with the chat message, if applicable. |
Provides a list of chat threads within Microsoft Teams, including group and one-on-one chats.
The Cloud 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 Cloud.
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'
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the chat in Microsoft Teams. |
| ChatType | String | Specifies the type of chat, such as one-on-one, group, or meeting chat. |
| UserId | String | Identifier of the user associated with the chat. |
| CreatedDateTime | Datetime | Timestamp indicating when the chat was created. |
| LastUpdatedDateTime | Datetime | Timestamp indicating when the chat was last updated. |
| Topic | String | Subject or topic of the chat, if specified. |
| IsHiddenForAllMembers | Bool | Indicates whether the chat is hidden for all members. |
Displays direct routing call records in Microsoft Teams for telephony integration analysis.
Custom App and Client Credentials should be used. See Creating an Entra ID (Azure AD) Application The Cloud 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 Cloud.
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.
| Name | Type | Description |
| Id | String | Unique identifier for the direct routing call in Microsoft Teams. |
| CorrelationId | String | Correlation identifier used to track related call and session data. |
| UserId | String | Unique identifier of the user associated with the call. |
| UserPrincipalName | String | User Principal Name (UPN) of the user who participated in the call. |
| UserDisplayName | String | Display name of the user who participated in the call. |
| StartDateTime | Edm.DateTimeOffset | Timestamp indicating when the call started. |
| InviteDateTime | Edm.DateTimeOffset | Timestamp indicating when the call invitation was sent. |
| FailureDateTime | Edm.DateTimeOffset | Timestamp indicating when the call failed, if applicable. |
| EndDateTime | Edm.DateTimeOffset | Timestamp indicating when the call ended. |
| Duration | Integer | Duration of the call in seconds. |
| CallType | String | Type of call, such as inbound or outbound. |
| SuccessfulCall | String | Indicates whether the call was successfully completed. |
| CallerNumber | String | Phone number of the caller. |
| CalleeNumber | String | Phone number of the callee. |
| MediaPathLocation | String | Location of the media path used during the call. |
| SignalingLocation | String | Location of the signaling server handling the call. |
| FinalSipCode | Integer | Final SIP (Session Initiation Protocol) response code for the call. |
| CallEndSubReason | Integer | Detailed subreason code explaining why the call ended. |
| FinalSipCodePhrase | String | Description of the final SIP code. |
| MediaBypassEnabled | Boolean | Indicates whether Media Bypass was enabled for the call. |
| FromDate | Edm.Date | Start date for filtering calls to retrieve. |
| ToDate | Edm.Date | End date for filtering calls to retrieve. |
Displays Public Switched Telephone Network (PSTN) call records in Microsoft Teams.
Custom App and Client Credentials should be used. See Creating an Entra ID (Azure AD) Application The Cloud 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 Cloud.
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.
| Name | Type | Description |
| Id | String | Unique identifier for the PSTN (Public Switched Telephone Network) call record. |
| CallId | String | Identifier for the specific call within Microsoft Teams. |
| UserId | String | Unique identifier of the user associated with the call. |
| UserPrincipalName | String | User Principal Name (UPN) of the user who made or received the call. |
| UserDisplayName | String | Display name of the user involved in the call. |
| StartDateTime | Edm.DateTimeOffset | Timestamp indicating when the PSTN call started. |
| EndDateTime | Edm.DateTimeOffset | Timestamp indicating when the PSTN call ended. |
| Duration | Integer | Total duration of the call in seconds. |
| Charge | Edm.Double | Monetary charge for the PSTN call. |
| CallType | String | Type of call, such as inbound or outbound. |
| Currency | String | Currency in which the charge is calculated. |
| CallerNumber | String | Phone number of the caller. |
| CalleeNumber | String | Phone number of the callee. |
| UsageCountryCode | String | Country code representing where the PSTN usage occurred. |
| TenantCountryCode | String | Country code for the Microsoft 365 tenant associated with the call. |
| ConnectionCharge | Edm.Double | One-time connection charge for the PSTN call. |
| DestinationName | String | Name of the call destination, such as a city or region. |
| ConferenceId | String | Identifier for the conference when the call is part of a conference session. |
| LicenseCapability | String | License capability of the user at the time of the call. |
| InventoryType | String | Type of inventory resource used for the call, such as service numbers or user numbers. |
| FromDate | Edm.Date | Start date for filtering PSTN call records to retrieve. |
| ToDate | Edm.Date | End date for filtering PSTN call records to retrieve. |
Retrieves the list of users who are members of a specific Microsoft Teams team.
The Cloud 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 Cloud.
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')
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the team member in Microsoft Teams. |
| TeamId | String | Identifier of the team to which the member belongs. |
| DisplayName | String | Full display name of the team member. |
| String | Email address of the team member. | |
| Roles | String | Roles assigned to the team member, such as owner or member. |
| TenantId | String | Identifier of the Microsoft 365 tenant associated with the team member. |
| UserId | String | Unique user identifier for the team member. |
| StartDateTime | Datetime | Timestamp indicating when the membership history for the team started. |
Stores real-time presence information for Microsoft Teams users.
The Cloud 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 Cloud.
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')
| Name | Type | Description |
| Id | String | Unique identifier for the Microsoft Teams user. |
| Availability | String | The user's current availability status, such as Available, Away, Busy, or Do Not Disturb. |
| Activity | String | The user's current activity state in Microsoft Teams, such as In a call, In a meeting, or Presenting. |
| StatusMessage_ExpiryDateTime_DateTime | String | The date and time when the user's custom status message is set to expire. |
| StatusMessage_ExpiryDateTime_TimeZone | String | The time zone associated with the expiration date and time of the user's status message. |
| StatusMessage_Message_Content | String | The text content of the user's custom status message in Microsoft Teams. |
| StatusMessage_PublishedDateTime | Datetime | The date and time when the user's custom status message was published. |
Contains detailed profile, organizational, and directory synchronization information for users in Microsoft Teams, including contact details, licensing, job roles, and Active Directory mappings.
Query the Users table. The Cloud 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 Cloud.
For example, the following query is processed server side:
SELECT * FROM Users WHERE Id = '08d30c14-2775-45c9-8809-3eca47340959'
| Name | Type | Description |
| id [KEY] | String | Unique identifier for the user in Microsoft Teams. |
| deletedDateTime | Datetime | Timestamp indicating when the user account was deleted, if applicable. |
| accountEnabled | Bool | Indicates whether the user's account is currently enabled. |
| assignedLicenses | String | List of product licenses currently assigned to the user. |
| businessPhones | String | Collection of the user's business phone numbers. |
| city | String | City listed in the user's organizational profile. |
| companyName | String | Name of the company the user is associated with. |
| country | String | Country or region specified in the user's profile. |
| createdDateTime | Datetime | Timestamp when the user account was created. |
| department | String | Department name listed in the user's organizational information. |
| displayName | String | Full name displayed for the user in Teams and other services. |
| employeeHireDate | Datetime | Date the user was hired, according to their employee record. |
| employeeId | String | Identifier assigned to the user in the employee directory. |
| employeeOrgData_costCenter | String | Cost center code associated with the user's organizational unit. |
| employeeOrgData_division | String | Division in which the user is employed within the organization. |
| employeeType | String | Classification of the user's employment, such as Full-time or Contractor. |
| givenName | String | The user's first name. |
| identities | String | Collection of identity records used for sign-in and directory purposes. |
| imAddresses | String | List of Instant Messaging (IM) addresses associated with the user. |
| isManagementRestricted | Bool | Indicates whether the user is restricted from being managed by others. |
| isResourceAccount | Bool | Specifies whether the user account is a resource account. |
| jobTitle | String | Job title listed in the user's profile. |
| lastPasswordChangeDateTime | Datetime | Timestamp of the user's most recent password change. |
| String | Primary email address associated with the user. | |
| mailNickname | String | Nickname used to generate the user's email address. |
| mobilePhone | String | User's mobile phone number. |
| officeLocation | String | Office building or physical location assigned to the user. |
| onPremisesDistinguishedName | String | User's distinguished name in the on-premises Active Directory. |
| onPremisesDomainName | String | Name of the on-premises domain the user is associated with. |
| onPremisesExtensionAttributes_extensionAttribute1 | String | Custom extension attribute 1 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute10 | String | Custom extension attribute 10 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute11 | String | Custom extension attribute 11 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute12 | String | Custom extension attribute 12 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute13 | String | Custom extension attribute 13 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute14 | String | Custom extension attribute 14 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute15 | String | Custom extension attribute 15 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute2 | String | Custom extension attribute 2 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute3 | String | Custom extension attribute 3 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute4 | String | Custom extension attribute 4 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute5 | String | Custom extension attribute 5 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute6 | String | Custom extension attribute 6 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute7 | String | Custom extension attribute 7 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute8 | String | Custom extension attribute 8 from the on-premises Active Directory for the user. |
| onPremisesExtensionAttributes_extensionAttribute9 | String | Custom extension attribute 9 from the on-premises Active Directory for the user. |
| onPremisesImmutableId | String | Unique, immutable identifier used to map the user to an on-premises Active Directory object. |
| onPremisesLastSyncDateTime | Datetime | Timestamp of the last directory synchronization from on-premises Active Directory to Microsoft 365. |
| onPremisesProvisioningErrors | String | Collection of errors encountered during the on-premises provisioning process for the user. |
| onPremisesSamAccountName | String | Security Account Manager (SAM) account name of the user in the on-premises Active Directory. |
| onPremisesSecurityIdentifier | String | Security Identifier (SID) associated with the user's on-premises Active Directory account. |
| onPremisesSyncEnabled | Bool | Indicates whether synchronization with the on-premises directory is enabled for the user. |
| onPremisesUserPrincipalName | String | User Principal Name (UPN) of the user in the on-premises environment. |
| otherMails | String | Collection of additional email addresses associated with the user. |
| passwordProfile_forceChangePasswordNextSignIn | Bool | Indicates whether the user must change their password at the next sign-in. |
| passwordProfile_forceChangePasswordNextSignInWithMfa | Bool | Indicates whether the user must change their password at the next sign-in using multi-factor authentication. |
| passwordProfile_password | String | Password value to set during user creation. |
| postalCode | String | Postal code or ZIP code listed in the user's address information. |
| preferredLanguage | String | The user's preferred language, typically used for localization and communication settings. |
| serviceProvisioningErrors | String | List of errors encountered during the provisioning of services for the user. |
| state | String | State or province listed in the user's address details. |
| streetAddress | String | Street-level address of the user's physical or mailing location. |
| surname | String | User's family name or last name. |
| userPrincipalName | String | The user's sign-in name, usually formatted as an email address. |
| userType | String | |
| Authentication_id | String | Unique identifier for the user's authentication container. |
| Calendar_id | String | Unique identifier for the user's calendar. |
| Drive_id | String | Unique identifier for the user's OneDrive drive. |
| InferenceClassification_id | String | Unique identifier for the user's email classification preferences. |
| Insights_id | String | Unique identifier for insights related to the user, such as activity and collaboration data. |
| Manager_id | String | Identifier for the user's manager in the organizational directory. |
| Onenote_id | String | Unique identifier for the user's OneNote data container. |
| Outlook_id | String | Unique identifier for the user's Outlook data container. |
| Photo_id | String | Identifier for the user's profile photo resource. |
| Planner_id | String | Identifier for the user's Microsoft Planner resource. |
| Presence_id | String | Identifier for the user's presence data in Microsoft Teams. |
| Settings_id | String | Identifier for the user's settings container. |
| Teamwork_id | String | Identifier for the user's Microsoft Teams collaboration container. |
| Todo_id | String | Identifier for the user's Microsoft To Do task list. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft Teams.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft Teams, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| ArchiveTeam | Archives a specified Microsoft Team, preserving content in read-only mode while preventing further edits or changes. |
| CreateChat | Initiates a one-on-one or group chat in Teams by specifying participants and chat metadata. |
| DeleteChat | Permanently removes a Teams chat thread, including all associated messages and metadata. |
| DeleteChatMessage | Deletes a specific message from a Teams chat, identified by message ID and chat context. |
| DeleteMessage | Removes a message from a Teams channel conversation, typically used for moderation or compliance. |
| FetchAdditionalUserFields | Pulls extended profile data (T1, T2, T3 fields) for a specific Teams user for reporting or personalization. |
| GetAdminConsentURL | Creates a secure admin authorization link for granting delegated or application permissions to Teams-based apps. |
| GetAttachmentContentUrl | Retrieves a direct-access URL for a file attachment from a Teams chat message for downloading or embedding. |
| GetUserActivityCount | Returns statistics on user engagement in Teams, broken down by activities like chat messages, meeting participation, and calls. |
| SendChatMessage | Sends a new message to a specified chat thread in Microsoft Teams, supporting text and rich content. |
| SendMessage | Posts a message to a Teams channel, optionally including formatting, mentions, and embedded content. |
| ShareSchedule | Publishes pending changes in a Teams schedule, such as shifts or time-off entries, making them visible to team members. |
| UnArchiveTeam | Reactivates an archived Microsoft Team, restoring full editing capabilities and collaboration access. |
| UpdateChat | Modifies properties of a Teams chat, such as adding participants or changing the topic name. |
| UpdateChatMessage | Updates the content of an existing Teams chat message, allowing corrections or content changes. |
| UpdateMessage | Revises an existing message in a Teams channel to reflect new information or correct errors. |
Archives a specified Microsoft Team, preserving content in read-only mode while preventing further edits or changes.
| Name | Type | Required | Description |
| TeamId | String | True | Unique identifier of the Microsoft Team that will be archived. |
| ShouldSetSPOSiteReadOnlyForMembers | String | False | Optional flag indicating whether to restrict team members' access to read-only on the associated SharePoint Online site. If set to false or omitted, permissions remain unchanged. |
| Name | Type | Description |
| Status | String | Indicates the result of the archive operation, such as success or failure. |
Initiates a one-on-one or group chat in Teams by specifying participants and chat metadata.
| Name | Type | Required | Description |
| ChatType | String | True | Defines the type of chat to create. Valid values are group for multi-user conversations and oneOnOne for direct messages between two users. |
| Members | String | True | Comma-separated list of user IDs to include in the chat. Ensure each user ID is valid and separated by a comma and a space. |
| Topic | String | False | Optional title for the chat. Only applicable if the chat type is group; ignored for oneOnOne chats. |
| Name | Type | Description |
| Success | String | Indicates whether the chat creation process completed successfully. |
Permanently removes a Teams chat thread, including all associated messages and metadata.
| Name | Type | Required | Description |
| ChatId | String | True | Unique identifier of the chat to be deleted. This must reference an existing oneOnOne or group chat. |
| Name | Type | Description |
| Success | String | Indicates whether the chat deletion was completed successfully. |
Deletes a specific message from a Teams chat, identified by message ID and chat context.
| Name | Type | Required | Description |
| UserId | String | True | Unique identifier of the user attempting to delete the message. Used to verify permissions and track audit logs. |
| ChatId | String | True | Unique identifier of the chat where the message was posted. Helps locate the message within the correct conversation. |
| MessageId | String | True | Unique identifier of the message to be deleted. Required to accurately target the message within the chat. |
| Name | Type | Description |
| Success | String | Indicates whether the message was successfully deleted from the chat. Returns true if successful, false otherwise. |
Removes a message from a Teams channel conversation, typically used for moderation or compliance.
| Name | Type | Required | Description |
| TeamId | String | True | Unique identifier of the team where the message exists. Used to ensure the operation targets the correct Microsoft Teams environment. |
| ChannelId | String | True | Unique identifier of the channel within the team where the message is posted. Required to locate the message contextually. |
| MessageId | String | True | Unique identifier of the message to be deleted. Ensures precise targeting of the message in the specified channel. |
| Name | Type | Description |
| Success | String | Indicates whether the message was successfully deleted. Returns true if the deletion was successful, otherwise false. |
Pulls extended profile data (T1, T2, T3 fields) for a specific Teams user for reporting or personalization.
| Name | Type | Required | Description |
| UserId | String | True | Unique identifier of the user whose additional information is being requested. Required to scope the data fetch. |
| IncludeFields | String | False | Comma-separated list of specific user fields to include in the result. Example: jobTitle, department, location. |
| ExcludeFields | String | False | Comma-separated list of specific user fields to exclude from the result. Example: mobilePhone, officeLocation. |
| Name | Type | Description |
| * | String | Complete set of user data returned by the query, shaped according to the include and exclude filters applied. |
Creates a secure admin authorization link for granting delegated or application permissions to Teams-based apps.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL to which the user is redirected after granting admin consent. This must exactly match the Reply URL configured in the Azure Active Directory app registration. |
| State | String | False | Opaque string value used to maintain state between the request and callback. Useful for preventing cross-site request forgery attacks and preserving user session. |
| Scope | String | False | Space-separated list of permissions the application is requesting admin consent for. Example: User.Read Group.ReadWrite.All Directory.Read.All.
The default value is https://graph.microsoft.com/group.read.all https://graph.microsoft.com/group.readwrite.all https://graph.microsoft.com/user.read.all https://graph.microsoft.com/appcatalog.readwrite.all https://graph.microsoft.com/presence.read.all https://graph.microsoft.com/chat.read https://graph.microsoft.com/channelmessage.read.all https://graph.microsoft.com/chat.readbasic https://graph.microsoft.com/chat.readwrite. |
| Name | Type | Description |
| URL | String | Generated authorization URL that must be opened in a browser to prompt the admin for consent and obtain the verifier token. |
Retrieves a direct-access URL for a file attachment from a Teams chat message for downloading or embedding.
| Name | Type | Required | Description |
| ChatId | String | True | Unique identifier of the chat that contains the message with the attachment. Used to locate the context of the request. |
| AttachmentId | String | False | Unique identifier of the attachment whose content URL is being retrieved. This field is not server-side filterable. |
| Name | Type | Description |
| ContentUrl | String | Direct URL to access the attachment content that was shared in the specified chat. |
| Success | String | Indicates whether the operation to retrieve the attachment content URL was successful. Returns true if successful, false otherwise. |
Returns statistics on user engagement in Teams, broken down by activities like chat messages, meeting participation, and calls.
| Name | Type | Required | Description |
| Duration | String | True | Number of days to include in the user activity report. Determines the reporting period for activity data.
The allowed values are D7, D30, D90, D180. |
| FileLocation | String | False | Full path where the downloaded CSV report should be saved. Used when writing the report directly to disk. |
| Encoding | String | False | Text encoding format used for the output report file. Examples include UTF-8, ASCII, or UTF-16.
The allowed values are NONE, BASE64. The default value is BASE64. |
| Name | Type | Description |
| Success | String | Indicates whether the report was generated successfully. Returns true if successful, false otherwise. |
| FileData | String | Contains the full contents of the generated report file if FileLocation and FileStream are not provided. |
Sends a new message to a specified chat thread in Microsoft Teams, supporting text and rich content.
| Name | Type | Required | Description |
| ChatId | String | True | Unique identifier of the chat where the message is sent. Required to route the message to the correct conversation. |
| ContentType | String | False | Format of the message content to be sent. Common values include text, html, and markdown. |
| Content | String | True | Main body of the message to be sent in the chat, formatted according to the specified ContentType. |
| Importance | String | False | Priority level of the message. Supported values include low, normal, and high. Default is normal.
The allowed values are normal, high, urgent. |
| Mention | String | False | Comma-separated MentionText and MentionUserId pairs. For multiple mentions, use semicolons to separate pairs. Example: MentionText1, MentionUserId1; MentionText2, MentionUserId2. |
| Attachment | String | False | Comma-separated AttachmentContentType and AttachmentContentUrl pairs. For multiple attachments, use semicolons to separate pairs. Example: AttachmentContentType1, AttachmentContentUrl1; AttachmentContentType2, AttachmentContentUrl2. |
| Name | Type | Description |
| Success | String | Indicates whether the message was successfully sent to the chat. Returns true if successful, false otherwise. |
Posts a message to a Teams channel, optionally including formatting, mentions, and embedded content.
| Name | Type | Required | Description |
| TeamId | String | True | Unique identifier of the team where the message is sent. Required to route the message to the correct Microsoft Teams group. |
| ChannelId | String | True | Unique identifier of the channel within the team where the message is posted. |
| MessageId | String | False | Unique identifier of the message to be updated. Used when modifying an existing message. |
| ContentType | String | False | Format of the message content. Common values include text, html, and markdown. |
| Content | String | True | Body of the message to be sent or updated in the specified channel, formatted according to the ContentType. |
| Importance | String | False | Priority level of the message. Accepted values include low, normal, and high. The default value is normal.
The allowed values are normal, high, urgent. |
| Mention | String | False | Comma-separated MentionText and MentionUserId pairs. For multiple mentions, use semicolons to separate each pair. Example: MentionText1, MentionUserId1; MentionText2, MentionUserId2. |
| Attachment | String | False | Comma-separated AttachmentContentType and AttachmentContentUrl pairs. For multiple attachments, use semicolons to separate each pair. Example: AttachmentContentType1, AttachmentContentUrl1; AttachmentContentType2, AttachmentContentUrl2. |
| Name | Type | Description |
| Success | String | Indicates whether the message was successfully sent or updated. Returns true if the operation completed successfully, otherwise false. |
Reactivates an archived Microsoft Team, restoring full editing capabilities and collaboration access.
| Name | Type | Required | Description |
| TeamId | String | True | Unique identifier of the Microsoft Teams team that should be restored from an archived state. |
| Name | Type | Description |
| Status | String | Indicates whether the unarchive operation was successful. Returns a status message or code reflecting the result. |
Modifies properties of a Teams chat, such as adding participants or changing the topic name.
| Name | Type | Required | Description |
| ChatId | String | True | Unique identifier of the chat to be updated. Required to locate the chat instance. |
| Topic | String | True | New title for the chat. This value can only be set if the chat is a group chat, not a one-on-one conversation. |
| Name | Type | Description |
| Success | String | Indicates whether the chat update operation was successful. Returns true if the update completed without errors. |
Updates the content of an existing Teams chat message, allowing corrections or content changes.
| Name | Type | Required | Description |
| ChatId | String | True | Unique identifier of the chat that contains the message to be updated. Required to locate the correct conversation. |
| MessageId | String | True | Unique identifier of the message to be updated within the specified chat. |
| ContentType | String | False | Format of the message content. Supported values include text, html, and markdown. |
| Content | String | False | New content to replace the existing message body. Must match the specified ContentType. |
| Importance | String | False | Priority level of the message. Accepted values include low, normal, and high. |
| Mention | String | False | Comma-separated MentionText and MentionUserId pairs. For multiple mentions, use semicolons to separate pairs. Example: MentionText1, MentionUserId1; MentionText2, MentionUserId2. |
| PolicyViolation | String | False | JSON object defining the properties of a policy violation. Only applicable when the update is performed using application permissions. |
| Name | Type | Description |
| Success | String | Indicates whether the message update operation was successful. Returns true if completed without errors. |
Revises an existing message in a Teams channel to reflect new information or correct errors.
| Name | Type | Required | Description |
| TeamId | String | True | Unique identifier of the Microsoft Teams team that contains the message to be updated. |
| ChannelId | String | True | Unique identifier of the channel within the specified team where the message is located. |
| MessageId | String | True | Unique identifier of the message to be updated within the specified channel. |
| ContentType | String | False | Format of the message content. Accepted values include text, html, and markdown. |
| Content | String | False | New content that replaces the current message body. Must be compatible with the specified ContentType. |
| Importance | String | False | Priority level of the message. Valid values include low, normal, and high. |
| Mention | String | False | Comma-separated MentionText and MentionUserId pairs. For multiple mentions, use semicolons to separate pairs. Example: MentionText1, MentionUserId1; MentionText2, MentionUserId2. |
| PolicyViolation | String | False | JSON object describing the properties of a policy violation. Required only when using application permissions and enforcing compliance rules. |
| Name | Type | Description |
| Success | String | Indicates whether the message update operation completed successfully. Returns true if the update was successful, otherwise false. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Microsoft Teams:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Teams table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Teams'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SendMail stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SendMail' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SendMail' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Microsoft Teams procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Teams table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Teams'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
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.
| 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. |
| DefaultGroups | Determines whether to use the /me/memberOf or /groups endpoint for user authentication. |
| DefaultUser | Determines whether to use the /me or /users endpoint for user authentication. |
| MsAppActsAsUserId | Specifies the Microsoft Entra ID (GUID) of the user the application should impersonate when authenticating with a service principal. |
| Property | Description |
| AzureTenant | Identifies the Microsoft Teams tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureEnvironment | Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies 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. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| GroupId | Specify a default GroupId. |
| IncludeAllGroups | Specifies whether the provider returns all Microsoft 365 Groups in your organization or only those the authenticated user is a member of. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records the provider retrieves per page when querying Microsoft Teams data. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserId | Specify a default UserId. |
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. |
| DefaultGroups | Determines whether to use the /me/memberOf or /groups endpoint for user authentication. |
| DefaultUser | Determines whether to use the /me or /users endpoint for user authentication. |
| MsAppActsAsUserId | Specifies the Microsoft Entra ID (GUID) of the user the application should impersonate when authenticating with a service principal. |
Specifies the type of authentication to use when connecting to Microsoft Teams. If this property is left blank, the default authentication is used.
string
"AzureAD"
AuthScheme values include:
For information about creating a custom application to authenticate with Azure AD, see Creating an Entra ID (Azure AD) Application.
For information about creating a custom application to authenticate with Azure AD Service Principal, see Creating a Service Principal App in Entra ID (Azure AD).
Determines whether to use the /me/memberOf or /groups endpoint for user authentication.
string
"CurrentUser"
Determines whether to use the /me/memberOf or /groups endpoint for user authentication.
Supported values are:
Determines whether to use the /me or /users endpoint for user authentication.
string
"AllUsers"
Determines whether to use the /me or /users endpoint for user authentication.
Supported values are:
Specifies the Microsoft Entra ID (GUID) of the user the application should impersonate when authenticating with a service principal.
string
""
This property is required when using the AzureServicePrincipal or AzureServicePrincipalCert authentication schemes and the Cloud needs to act on behalf of a specific user.
Set this property to the Microsoft Entra ID object ID (GUID) of the user whose schedule data the application needs to access.
You must specify this property when querying the following tables:
You must also specify this property when executing the ShareSchedule stored procedure.
Use this property when your application requires delegated access to user-specific Teams scheduling data in an Azure service principal authentication context.
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. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| 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. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
string
""
A tenant is a digital container for your organization's users and resources, managed through Microsoft Entra ID (formerly Azure AD). Each tenant is associated with a unique directory ID, and often with a custom domain (for example, microsoft.com or contoso.onmicrosoft.com).
To find the directory (tenant) ID in the Microsoft Entra Admin Center, navigate to Microsoft Entra ID > Properties and copy the value labeled "Directory (tenant) ID".
This property is required in the following cases:
You can provide the tenant value in one of two formats:
Specifying the tenant explicitly ensures that the authentication request is routed to the correct directory, which is especially important when a user belongs to multiple tenants or when using service principal–based authentication.
If this value is omitted when required, authentication may fail or connect to the wrong tenant. This can result in errors such as unauthorized or resource not found.
Specifies the Azure network environment to which you will connect. Must be the same network to which your Azure account was added.
string
"GLOBAL"
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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
string
""
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies 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. |
Supplies the name of the client certificate's JWT Certificate store.
string
""
The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Cloud initiates a search for a certificate. For further information, see OAuthJWTCertSubject.
Designations of certificate stores are platform-dependent.
Notes
Identifies the type of key store containing the JWT Certificate.
string
"PEMKEY_BLOB"
| Value | Description | Notes |
| USER | A certificate store owned by the current user. | Only available in Windows. |
| MACHINE | A machine store. | Not available in Java or other non-Windows environments. |
| PFXFILE | A PFX (PKCS12) file containing certificates. | |
| PFXBLOB | A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. | |
| JKSFILE | A Java key store (JKS) file containing certificates. | Only available in Java. |
| JKSBLOB | A string (base-64-encoded) representing a certificate store in Java key store (JKS) format. | Only available in Java. |
| PEMKEY_FILE | A PEM-encoded file that contains a private key and an optional certificate. | |
| PEMKEY_BLOB | A string (base64-encoded) that contains a private key and an optional certificate. | |
| PUBLIC_KEY_FILE | A file that contains a PEM- or DER-encoded public key certificate. | |
| PUBLIC_KEY_BLOB | A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. | |
| SSHPUBLIC_KEY_FILE | A file that contains an SSH-style public key. | |
| SSHPUBLIC_KEY_BLOB | A string (base-64-encoded) that contains an SSH-style public key. | |
| P7BFILE | A PKCS7 file containing certificates. | |
| PPKFILE | A file that contains a PPK (PuTTY Private Key). | |
| XMLFILE | A file that contains a certificate in XML format. | |
| XMLBLOB | Astring that contains a certificate in XML format. | |
| BCFKSFILE | A file that contains an Bouncy Castle keystore. | |
| BCFKSBLOB | A string (base-64-encoded) that contains a Bouncy Castle keystore. |
Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
string
""
This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.
Identifies 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.
string
"*"
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
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.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| GroupId | Specify a default GroupId. |
| IncludeAllGroups | Specifies whether the provider returns all Microsoft 365 Groups in your organization or only those the authenticated user is a member of. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records the provider retrieves per page when querying Microsoft Teams data. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserId | Specify a default UserId. |
Specify a default GroupId.
string
""
Specify a default GroupId.
Specifies whether the provider returns all Microsoft 365 Groups in your organization or only those the authenticated user is a member of.
bool
false
This property determines whether the Cloud lists all Microsoft 365 Groups in your organization or only the groups the authenticated user belongs to.
If set to true, the Cloud includes all groups in the result.
If set to false, only groups associated with the logged-in user are returned.
Use this property when your integration or reporting workflow requires access to all groups across your Microsoft 365 tenant.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the maximum number of records the provider retrieves per page when querying Microsoft Teams data.
string
""
This property sets the number of records returned per page when the Cloud retrieves data from Microsoft Teams.
It only applies to the Users view and Groups table.
Set this property if you need to control client-side paging behavior. On fast servers, increasing the page size can improve performance by reducing the number of requests sent to the API.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud 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.
int
60
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.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows 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.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specify a default UserId.
string
""
Specify a default UserId.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.