Adding a Connection to Azure Active Directory

To add a connection to Azure Active Directory:

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

For required properties, see the Settings tab.

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

Authenticating to Azure Active Directory

Azure Active Directory supports authentication via Entra ID (Azure AD), Azure Service Principal, or Managed Service Identity (MSI).

Entra ID (Azure AD)

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 Azure Active Directory 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.

Azure Service Principal

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

Managed Service Identity (MSI)

If you are running Azure Active Directory on an Azure VM and want to automatically obtain Managed Service Identity (MSI) credentials to connect, set AuthScheme to AzureMSI.

User-Managed Identities

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

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

This section details a selection of advanced features of the Azure Active Directory Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

The CData Sync App models Azure Active Directory as an easy-to-use SQL database with tables, views, and stored procedures. Live connectivity to these objects means that any changes to your Azure Active Directory account are immediately reflected in the Sync App.

Tables

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 Azure Active Directory account.

Common tables include:

Table	Description
Users	Lists all Azure AD users, including their profile and directory information, within the authenticated permissions.
Groups	Lists all Azure AD groups, including Office 365 and security groups, accessible to the authenticated user.
Applications	Contains details of all registered applications within the organization for the authenticated user, including app-specific configurations.
Devices	Lists all devices registered within the organization that the authenticated user has access to, including device details.
DirectoryRoles	Contains a list of directory roles, detailing roles assigned to users and groups within the organization.
DirectoryRoleMembers	Identifies the members assigned to specific directory roles within the Azure AD environment.
GroupMembers	Provides a detailed view of group memberships, listing all members of each group within the organization.
SignIns	Tracks and lists all user sign-in activities for audit and monitoring purposes.
DirectoryAudits	Tracks and lists all directory audit events accessible to the authenticated user for compliance and monitoring.
Organization	Contains metadata and details about the organization accessible to the authenticated user.
RoleAssignments	Displays all role assignments configured within the Azure AD environment.
RoleDefinitions	Provides definitions for roles available in Azure AD, detailing their permissions and scope.
DeviceRegisteredOwners	Maps device objects to their registered owners for tracking and management purposes.
DeviceRegisteredUsers	Associates device objects with their registered users, facilitating detailed user-device relationship analysis.
AdministrativeUnits	Displays a comprehensive list of administrative units accessible to the authenticated user, enabling management of organizational structure.
AdministrativeUnitMembers	Lists all members of administrative units available to the authenticated user, providing details on their membership relationships.
Domains	Displays all domains registered and verified within the organization, along with their configurations.
PhoneAuthenticationMethods	Lists phone-based authentication methods configured for users within the organization.
UserManagers	Maps users to their assigned managers within the organization for reporting and hierarchy management.
SubscribedSKUs	Lists service subscriptions (SKUs) the organization is subscribed to, including details of usage and availability.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, such as retrieving and refreshing OAuth access tokens, and managing groups.

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

Azure Active Directory Connector for CData Sync Tables

Name	Description
Applications	Contains details of all registered applications within the organization for the authenticated user, including app-specific configurations.
Devices	Lists all devices registered within the organization that the authenticated user has access to, including device details.
Domains	Displays all domains registered and verified within the organization, along with their configurations.
Groups	Lists all Azure AD groups, including Office 365 and security groups, accessible to the authenticated user.
Users	Lists all Azure AD users, including their profile and directory information, within the authenticated permissions.

Contains details of all registered applications within the organization for the authenticated user, including app-specific configurations.

Table Specific Information

Select

You can query Applications by specifying an Id or selecting all:

SELECT * FROM Applications WHERE Id = '037c5534-1059-4c71-9f1c-a9b887e34b03'

Select a certain column from the entity and filter by that column:

SELECT Id FROM Applications WHERE Id LIKE '%037c5534-1059-4c71-9f1c-a9b887e34b03%'

Insert

Specify a displayName in order to create a new Application, the displayName should be the name of the new Application:

INSERT INTO Applications (displayName) VALUES ('TestApp')

Update

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

UPDATE Applications SET displayName = 'Test' WHERE Id = '037c5534-1059-4c71-9f1c-a9b887e34b03'

Delete

To delete an Application record, you need to specify the Id in WHERE clause.

DELETE FROM Applications WHERE Id = '480a2785-1c18-49ac-9a80-9dfc1b40e1f2'

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	The unique identifier of the application, used as the primary key.
addIns	String	False	A list of add-ins associated with the application, detailing additional functionalities.
api_acceptMappedClaims	Bool	False	Indicates whether the application accepts mapped claims in tokens.
api_knownClientApplications	String	False	A list of known client applications that this API trusts.
api_oauth2PermissionScopes	String	False	The OAuth2 permission scopes defined for the API of the application.
api_preAuthorizedApplications	String	False	Applications pre-authorized to call this application's API.
api_requestedAccessTokenVersion	Int	False	The version of access tokens requested by the application API.
appId	String	False	The globally unique application ID assigned to the application.
applicationTemplateId	String	False	The ID of the application template used during creation.
appRoles	String	False	Roles defined for the application that can be assigned to users or groups.
authenticationBehaviors_removeUnverifiedEmailClaim	Bool	False	Specifies if unverified email claims should be removed during authentication.
authenticationBehaviors_requireClientServicePrincipal	Bool	False	Indicates if a client service principal is required for authentication.
certification_certificationDetailsUrl	String	False	The URL providing details about the application's certification.
certification_certificationExpirationDateTime	Datetime	False	The date and time when the application's certification expires.
certification_isCertifiedByMicrosoft	Bool	False	Specifies if the application is certified by Microsoft.
certification_isPublisherAttested	Bool	False	Indicates if the application's publisher attested to its certification.
certification_lastCertificationDateTime	Datetime	False	The date and time of the application's last certification.
createdDateTime	Datetime	False	The date and time the application was created.
defaultRedirectUri	String	False	The default redirect URI used in the application's authentication flows.
description	String	False	A brief description of the application's purpose or functionality.
disabledByMicrosoftStatus	String	False	Indicates if the application is disabled by Microsoft and the reason for it.
displayName	String	False	The friendly name of the application, displayed in portals.
groupMembershipClaims	String	False	The claims related to group memberships that the application can receive.
identifierUris	String	False	The URIs that identify the application within its tenant.
info_logoUrl	String	False	The URL of the application's logo image.
info_marketingUrl	String	False	The URL of the application's marketing or promotional page.
info_privacyStatementUrl	String	False	The URL of the application's privacy policy.
info_supportUrl	String	False	The URL for the application's support page.
info_termsOfServiceUrl	String	False	The URL of the application's terms of service.
isDeviceOnlyAuthSupported	Bool	False	Indicates if the application supports authentication for devices only.
isFallbackPublicClient	Bool	False	Specifies if the application can fallback to public client behavior.
keyCredentials	String	False	The list of key credentials associated with the application for authentication.
logo	String	False	The binary data of the application's logo.
nativeAuthenticationApisEnabled	String	False	The native Authentication Apis Enabled of the application.
notes	String	False	Additional notes or metadata about the application.
oauth2RequirePostResponse	Bool	False	Indicates if the application requires a POST response for OAuth2 authorization.
optionalClaims_accessToken	String	False	Optional claims included in the application's access tokens.
optionalClaims_idToken	String	False	Optional claims included in the application's ID tokens.
optionalClaims_saml2Token	String	False	Optional claims included in the application's security assertion markup language 2.0 (SAML2) tokens.
parentalControlSettings_countriesBlockedForMinors	String	False	Countries where the application is blocked for minors, based on parental control settings.
parentalControlSettings_legalAgeGroupRule	String	False	Rules for age group restrictions applied to the application.
passwordCredentials	String	False	The list of password credentials associated with the application.
publicClient_redirectUris	String	False	Redirect URIs defined for public client flows of the application.
publisherDomain	String	False	The verified domain of the application publisher.
requiredResourceAccess	String	False	Resources and permissions the application requires for operation.
samlMetadataUrl	String	False	The metadata URL for security assertion markup language (SAML) integration with the application.
serviceManagementReference	String	False	A reference for managing the application's service configuration.
servicePrincipalLockConfiguration_isEnabled	Bool	False	Indicates if the service principal lock configuration is enabled.
servicePrincipalLockConfiguration_allProperties	Bool	False	Specifies if all properties of the service principal are locked.
servicePrincipalLockConfiguration_credentialsWithUsageVerify	Bool	False	Locks credentials used for verifying tokens in the application.
servicePrincipalLockConfiguration_credentialsWithUsageSign	Bool	False	Locks credentials used for signing tokens in the application.
servicePrincipalLockConfiguration_tokenEncryptionKeyId	Bool	False	Locks the token encryption key ID for the application.
signInAudience	String	False	Defines the audience that can sign in to the application.
spa_redirectUris	String	False	Redirect URIs defined for single-page applications.
tags	String	False	Custom tags associated with the application for organization.
tokenEncryptionKeyId	String	False	The ID of the token encryption key used by the application.
UniqueName	String	False	The unique name for the application.
verifiedPublisher_addedDateTime	Datetime	False	The date and time when the publisher was verified.
verifiedPublisher_displayName	String	False	The display name of the verified publisher.
verifiedPublisher_verifiedPublisherId	String	False	The ID of the verified publisher of the application.
web_homePageUrl	String	False	The URL of the application's web homepage.
web_implicitGrantSettings_enableAccessTokenIssuance	Bool	False	Specifies if implicit grant access tokens are enabled for web applications.
web_implicitGrantSettings_enableIdTokenIssuance	Bool	False	Specifies if implicit grant ID tokens are enabled for web applications.
web_logoutUrl	String	False	The URL for logout redirection in the application.
web_redirectUris	String	False	Redirect URIs defined for web applications.

Lists all devices registered within the organization that the authenticated user has access to, including device details.

Table Specific Information

Select

You can query Devices by specifying an Id or selecting all:

SELECT * FROM Devices WHERE Id = '2b9c0347-9640-4ba4-bd2d-50965fb026e7'

Select a certain column from the entity and filter by that column:

SELECT * FROM Devices WHERE DisplayName LIKE '%Desk%'

Insert

Specify deviceId, accountEnabled, displayName, operatingSystem, operatingSystemVersion, and alternativeSecurityIds values in order to create a new Device:

INSERT INTO Devices (deviceId, accountEnabled, displayName, operatingSystem, operatingSystemVersion, alternativeSecurityIds) VALUES ('4c299165-6e8f-4b45-a5ba-c5d250a707ff', false, 'JustinBTest', 'Windows', '15.1', '[{"type":2,"key":"101010101011"}]')

Update

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

UPDATE Devices SET OperatingSystemVersion = 10.0.13439.0 WHERE Id = '6c32edb5-7f28-41f8-9965-f3f9a1718fde'

Delete

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

DELETE FROM Devices WHERE Id = '6c32edb5-7f28-41f8-9965-f3f9a1718fde'

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	The unique identifier assigned to the device within Azure Active Directory.
deletedDateTime	Datetime	False	The date and time when the device was deleted, useful for tracking device lifecycle.
accountEnabled	Bool	False	Indicates whether the device's account is active and can be used for authentication.
alternativeSecurityIds	String	False	Alternate security identifiers associated with the device, used for authentication and management.
approximateLastSignInDateTime	Datetime	False	The estimated date and time of the device's most recent sign-in, useful for activity monitoring.
complianceExpirationDateTime	Datetime	False	The date and time when the device's compliance status is set to expire.
deviceCategory	String	False	The category assigned to the device, which can help with organization and policy application.
deviceId	String	False	The unique identifier for the device, often used for internal tracking and management.
deviceMetadata	String	False	Metadata associated with the device, containing additional contextual information.
deviceOwnership	String	False	Specifies whether the device is corporate-owned or personally owned, useful for applying policies.
deviceVersion	Int	False	The version number of the device, often used for managing updates and compatibility.
displayName	String	False	The user-friendly name assigned to the device for easier identification.
enrollmentProfileName	String	False	The name of the enrollment profile used to onboard the device into management.
enrollmentType	String	False	Enrollment type of the device.
isCompliant	Bool	False	Indicates whether the device meets the organization's compliance requirements.
isManaged	Bool	False	Indicates whether the device is being managed by the organization's IT policies.
isManagementRestricted	Bool	False	Specifies if the device has restrictions preventing certain management actions.
isRooted	Bool	False	Indicates whether the device is rooted or jail-broken.
managementType	String	False	The management channel of the device.
mdmAppId	String	False	The unique identifier of the Mobile Device Management (MDM) application associated with the device.
onPremisesLastSyncDateTime	Datetime	False	The last date and time when the device was synced with on-premises systems.
onPremisesSecurityIdentifier	String	False	The security identifier (SID) assigned to the device in on-premises systems.
onPremisesSyncEnabled	Bool	False	Indicates whether the device is enabled for synchronization with on-premises systems.
operatingSystem	String	False	The name of the operating system running on the device.
operatingSystemVersion	String	False	The version of the operating system running on the device.
physicalIds	String	False	A list of physical identifiers for the device, often used for inventory tracking.
profileType	String	False	The type of profile assigned to the device, determining its role and policies.
registrationDateTime	Datetime	False	The date and time when the device was registered in Azure Active Directory.
systemLabels	String	False	Labels assigned to the device, often used for grouping and applying policies.
trustType	String	False	The type of trust relationship established between the device and Azure Active Directory.

Displays all domains registered and verified within the organization, along with their configurations.

Table Specific Information

Select

You can query Domains by specifying an Id or selecting all:

SELECT * FROM Domains WHERE Id = 'rssbus.cn'

Select a certain column from the entity and filter by that column:

SELECT Id FROM Domains WHERE Id LIKE '%rssbus%'

Insert

Specify an Id in order to create a new Domain, the Id should be the name of the new Domain:

INSERT INTO Domains (Id) VALUES ('cdata.com')

Update

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

UPDATE Domains SET passwordNotificationWindowInDays = 14 WHERE Id = 'cdata.com'

Delete

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

DELETE FROM Domains WHERE Id = 'cdata.com'

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	The unique identifier of the domain, used to reference it in the directory.
authenticationType	String	False	Specifies whether the type of authentication supported by the domain, such as 'Managed' or 'Federated'.
availabilityStatus	String	False	Indicates whether the domain is available and properly configured within Azure Active Directory.
isAdminManaged	Bool	False	Indicates whether the domain is managed and controlled by an administrator.
isDefault	Bool	False	Specifies whether the domain is set as the default domain for the directory.
isInitial	Bool	False	Shows whether the domain was the initial domain created for the directory.
isRoot	Bool	False	Denotes whether the domain is a root domain within the directory hierarchy.
isVerified	Bool	False	Indicates whether the domain has been verified with Azure Active Directory.
passwordNotificationWindowInDays	Int	False	The number of days before password expiration when a notification is sent to users.
passwordValidityPeriodInDays	Int	False	The duration, in days, for which passwords associated with the domain remain valid.
state_lastActionDateTime	Datetime	False	The timestamp of the last action performed on the domain's state.
state_operation	String	False	Describes the most recent operation performed on the domain's state, such as 'Verify' or 'Update'.
state_status	String	False	The current status of the domain's state operation, such as 'InProgress', 'Completed', or 'Failed'.
supportedServices	String	False	A list of services supported by the domain, such as Exchange or SharePoint.

Lists all Azure AD groups, including Office 365 and security groups, accessible to the authenticated user.

Table Specific Information

Groups require Administrator permissions. To work with them, you must create your own custom OAuth App and set the appropriate OAuthClientId and OAuthClientSecret. In this app, you must configure it to request the Group.Read.All and the Group.ReadWrite.All permissions. This can be done at https://apps.dev.microsoft.com, or in the App Registrations panel at http://portal.azure.com. See Creating an Entra ID (Azure AD) Application for more details on creating a custom app.

To authorize Groups permissions, an administrator must grant the Groups permissions for your organization at large. This can be done via the administrator authorization endpoint. Simply have the administrator grant permissions. Then run the OAuth authorization as normal afterwards.

Note that if your organization has multiple tenants, you may replace the /common/ in the url with the tenant Id to indicate which tenant to grant permissions for.

Select

Retrieve all groups, specify a GroupId (Id), or simply filter by a certain column:

SELECT * FROM Groups WHERE Id = '029b15a8-dfd1-460e-83b6-262a75328c13'
SELECT Id, Description, DisplayName FROM Groups WHERE Name = 'test'

Insert

The following are required to create a new Security Group:

INSERT INTO Groups (DisplayName, MailEnabled, MailNickname, SecurityEnabled) VALUES ('Test group', false, 'test', true)

Update

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

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

Delete

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

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

GetDeleted

Retrieve recently deleted groups. Deleted groups remain available for up to 30 days.

GETDELETED FROM Groups

Columns

Name	Type	ReadOnly	Description
id [KEY]	String	False	The unique identifier for the group within Azure Active Directory.
deletedDateTime	Datetime	False	The date and time when the group was deleted, if applicable.
allowExternalSenders	Bool	False	Indicates whether the group allows emails from external senders.
assignedLabels	String	False	A collection of labels assigned to the group, often used for categorization or compliance.
assignedLicenses	String	False	A list of licenses that have been assigned to the group for service access.
autoSubscribeNewMembers	Bool	False	Indicates whether new members are automatically subscribed to group notifications.
classification	String	False	The classification assigned to the group, typically used for compliance or organizational purposes.
createdDateTime	Datetime	False	The date and time when the group was created in Azure Active Directory.
description	String	False	A brief description or summary of the group, providing context about its purpose or function.
displayName	String	False	The user-friendly name of the group, as shown in the Azure portal and directory.
expirationDateTime	Datetime	False	The date and time when the group is scheduled to expire, if applicable.
groupTypes	String	False	A list of group types, such as 'Unified' or 'Security', that define the group's functionality.
hasMembersWithLicenseErrors	Bool	False	Indicates if any group members have errors related to license assignments.
hideFromAddressLists	Bool	False	Specifies whether the group is hidden from address lists in the directory.
hideFromOutlookClients	Bool	False	Specifies whether the group is hidden from visibility in Outlook clients.
isArchived	Bool	False	Indicates if the group has been archived, meaning it is no longer active but retained for records.
isAssignableToRole	Bool	False	Indicates if the group can be assigned to Azure roles or permissions.
isManagementRestricted	Bool	False	Indicates whether management operations on the group are restricted.
isSubscribedByMail	Bool	False	Indicates if members of the group are subscribed to email notifications.
licenseProcessingState	String	False	The current processing state of the group's licenses, such as 'Enabled' or 'Disabled'.
mail	String	False	The primary email address associated with the group.
mailEnabled	Bool	False	Indicates if the group is configured to send and receive emails.
mailNickname	String	False	The alias for the group's email address, used as a shorthand identifier.
membershipRule	String	False	The rule that defines the criteria for group membership, typically for dynamic groups.
membershipRuleProcessingState	String	False	The current state of processing the membership rule, such as 'NotStarted' or 'Running'.
onPremisesDomainName	String	False	The domain name associated with the group for on-premises synchronization.
onPremisesLastSyncDateTime	Datetime	False	The date and time when the group was last synced with on-premises Active Directory.
onPremisesProvisioningErrors	String	False	Details about any provisioning errors encountered during on-premises synchronization.
onPremisesSamAccountName	String	False	The Security Account Manager (SAM) account name associated with the group for on-premises Active Directory.
onPremisesSecurityIdentifier	String	False	The security identifier (SID) of the group for on-premises synchronization.
onPremisesSyncEnabled	Bool	False	Indicates if the group is configured for synchronization with on-premises Active Directory.
preferredDataLocation	String	False	The preferred geographic location for the group's data, such as 'US' or 'Europe'.
preferredLanguage	String	False	The default language for the group, used for communications and notifications.
proxyAddresses	String	False	A collection of proxy addresses assigned to the group, used for email routing.
renewedDateTime	Datetime	False	The most recent date and time when the group was renewed, if applicable.
securityEnabled	Bool	False	Indicates if the group is a security-enabled group, allowing it to be used for access control.
securityIdentifier	String	False	The security identifier (SID) of the group in Azure Active Directory.
serviceProvisioningErrors	String	False	Details about any errors encountered during service provisioning for the group.
theme	String	False	The theme associated with the group, often used for branding or categorization.
UniqueName	String	False	The unique name for the group.
unseenCount	Int	False	The number of items, such as notifications or messages, that remain unseen by the group.
visibility	String	False	The visibility level of the group, such as 'Public', 'Private', or 'HiddenMembership'.

Lists all Azure AD users, including their profile and directory information, within the authenticated permissions.

Table Specific Information

Select

Query the Users table. The Sync App will use the Azure Active Directory API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Sync App.

• Id supports the '=' operator.

For example, the following query is processed server side:

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

Note: when querying the Users table with an asterik (*), only the default columns will be returned. (i.e. businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName)

To get the data for extra columns in the Users table, you must provide them in the query. For example:

SELECT id, department, officeLocation, state, displayName, mail FROM Users

Insert

The following are required to create a new organizational User:

INSERT INTO Users (AccountEnabled, DisplayName, MailNickname, UserPrincipalName, PasswordProfile_ForceChangePasswordNextSignIn, PasswordProfile_Password) VALUES (false, 'John Smith', 'JohnS', '[email protected]', true, '123password')

Update

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

UPDATE Users SET JobTitle = 'New Job Title' WHERE Id = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

Delete

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

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

GetDeleted

Retrieve recently deleted users. Deleted users remain available for up to 30 days.

GETDELETED FROM Users

Columns

Name	Type	ReadOnly	Description
Manager_Id	String	False	The unique identifier assigned to the manager of the user.
Manager_DisplayName	String	False	The display name of the user's manager, typically used for display purposes.
id [KEY]	String	False	The unique identifier of the user within the directory.
deletedDateTime	Datetime	False	The timestamp indicating when the user was deleted from the directory.
accountEnabled	Bool	False	A flag indicating whether the user's account is currently active.
assignedLicenses	String	False	A list of licenses assigned to the user, detailing their access to specific services.
businessPhones	String	False	The business phone numbers associated with the user.
city	String	False	The city specified in the user's profile.
companyName	String	False	The name of the company associated with the user.
country	String	False	The country or region where the user resides.
createdDateTime	Datetime	False	The date and time when the user account was created.
department	String	False	The department in which the user works.
displayName	String	False	The user's full name, commonly displayed in user interfaces.
employeeHireDate	Datetime	False	The date the user was hired by the organization.
employeeId	String	False	The unique employee ID assigned to the user by the organization.
employeeOrgData_costCenter	String	False	The cost center associated with the user's organizational data.
employeeOrgData_division	String	False	The division of the organization to which the user belongs.
employeeType	String	False	The employment type of the user, such as 'Full-Time' or 'Contractor'.
givenName	String	False	The user's first name or given name.
identities	String	False	A list of identity providers and identifiers associated with the user.
imAddresses	String	False	The instant messaging addresses associated with the user.
isManagementRestricted	Bool	False	Indicates whether the user has restrictions due to management policies.
isResourceAccount	Bool	False	Specifies if the user account is designated as a resource account.
jobTitle	String	False	The user's job title within the organization.
lastPasswordChangeDateTime	Datetime	False	The timestamp of the user's last password change.
mail	String	False	The primary email address of the user.
mailNickname	String	False	The mail alias or nickname for the user.
mobilePhone	String	False	The user's mobile phone number.
officeLocation	String	False	The location of the user's office, typically a building or room number.
onPremisesDistinguishedName	String	False	The distinguished name of the user in the on-premises directory.
onPremisesDomainName	String	False	The domain name associated with the user in the on-premises directory.
onPremisesExtensionAttributes_extensionAttribute1	String	False	Custom extension attribute 1 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute10	String	False	Custom extension attribute 10 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute11	String	False	Custom extension attribute 11 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute12	String	False	Custom extension attribute 12 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute13	String	False	Custom extension attribute 13 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute14	String	False	Custom extension attribute 14 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute15	String	False	Custom extension attribute 15 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute2	String	False	Custom extension attribute 2 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute3	String	False	Custom extension attribute 3 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute4	String	False	Custom extension attribute 4 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute5	String	False	Custom extension attribute 5 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute6	String	False	Custom extension attribute 6 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute7	String	False	Custom extension attribute 7 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute8	String	False	Custom extension attribute 8 defined in the on-premises directory for the user.
onPremisesExtensionAttributes_extensionAttribute9	String	False	Custom extension attribute 9 defined in the on-premises directory for the user.
onPremisesImmutableId	String	False	The immutable identifier assigned to the user in the on-premises directory.
onPremisesLastSyncDateTime	Datetime	False	The timestamp of the user's last synchronization with the on-premises directory.
onPremisesProvisioningErrors	String	False	Details of provisioning errors encountered during synchronization.
onPremisesSamAccountName	String	False	The Security Account Manager (SAM) account name of the user in the on-premises directory.
onPremisesSecurityIdentifier	String	False	The unique security identifier (SID) of the user in the on-premises directory.
onPremisesSyncEnabled	Bool	False	A flag indicating whether synchronization with the on-premises directory is enabled.
onPremisesUserPrincipalName	String	False	The User Principal Name (UPN) of the user in the on-premises directory.
otherMails	String	False	Additional email addresses associated with the user.
passwordProfile_forceChangePasswordNextSignIn	Bool	False	Indicates whether the user is required to change their password at the next sign-in.
passwordProfile_forceChangePasswordNextSignInWithMfa	Bool	False	Indicates if the user must change their password and complete MFA at the next sign-in.
passwordProfile_password	String	False	The password profile configured for the user account.
postalCode	String	False	The postal code of the user's address.
preferredLanguage	String	False	The language preference specified by the user.
serviceProvisioningErrors	String	False	Details of errors encountered during service provisioning.
state	String	False	The state or province of the user's address.
streetAddress	String	False	The street address of the user.
surname	String	False	The last name or surname of the user.
userPrincipalName	String	False	The unique UPN of the user within the directory, often used for authentication.
userType	String	False	The type of user, such as 'Member' or 'Guest'.

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.

Azure Active Directory Connector for CData Sync Views

Name	Description
AdministrativeUnitMembers	Lists all members of administrative units available to the authenticated user, providing details on their membership relationships.
AdministrativeUnits	Displays a comprehensive list of administrative units accessible to the authenticated user, enabling management of organizational structure.
CompanySubscriptions	Represents a commercial subscription for a tenant.
Contacts	Provides access to the organizational contact list, including external and internal contact details.
Contracts	Presents all active contracts for the authenticated user, detailing subscription and agreement terms.
DeviceLocalCredentials	Offers information on local administrator account credentials for specific device objects.
DeviceRegisteredOwners	Maps device objects to their registered owners for tracking and management purposes.
DeviceRegisteredUsers	Associates device objects with their registered users, facilitating detailed user-device relationship analysis.
DirectoryAudits	Tracks and lists all directory audit events accessible to the authenticated user for compliance and monitoring.
DirectoryRoleMembers	Identifies the members assigned to specific directory roles within the Azure AD environment.
DirectoryRoles	Contains a list of directory roles, detailing roles assigned to users and groups within the organization.
DirectoryRoleTemplates	Offers a template view of all directory roles available for use within Azure AD.
EmailAuthenticationMethods	Usage information for the operation EmailAuthenticationMethods.rsd.
Fido2AuthenticationMethods	Usage information for the operation Fido2AuthenticationMethods.rsd.
GroupApplicationRoleAssignments	Tracks application role assignments assigned to specific groups for managing permissions.
GroupMembers	Provides a detailed view of group memberships, listing all members of each group within the organization.
MFAStatuses	Lists MFA statuses for users within the organization.
MicrosoftAuthenticatorAuthenticationMethods	Usage information for the operation MicrosoftAuthenticatorAuthenticationMethods.rsd.
Organization	Contains metadata and details about the organization accessible to the authenticated user.
PasswordAuthenticationMethods	Usage information for the operation PasswordAuthenticationMethods.rsd.
PhoneAuthenticationMethods	Lists phone-based authentication methods configured for users within the organization.
PlatformCredentialAuthenticationMethods	Usage information for the operation PlatformCredentialAuthenticationMethods.rsd.
ProfileCardProperties	Retrieves custom properties displayed on user profile cards within the organization.
RiskDetections	null
RiskyServicePrincipals	null
RiskyUserHistory	null
RiskyUsers	null
RoleAssignments	Displays all role assignments configured within the Azure AD environment.
RoleDefinitions	Provides definitions for roles available in Azure AD, detailing their permissions and scope.
ServicePrincipalRiskDetections	null
SignIns	Tracks and lists all user sign-in activities for audit and monitoring purposes.
SoftwareOathAuthenticationMethods	Usage information for the operation SoftwareOathAuthenticationMethods.rsd.
SubscribedSKUs	Lists service subscriptions (SKUs) the organization is subscribed to, including details of usage and availability.
TemporaryAccessPassAuthenticationMethods	Usage information for the operation TemporaryAccessPassAuthenticationMethods.rsd.
UserApplicationRoleAssignments	Tracks application role assignments assigned to specific users for managing access and permissions.
UserManagers	Maps users to their assigned managers within the organization for reporting and hierarchy management.
UserMemberships	Provides details of group and directory role memberships for specific users within the organization.
WindowsHelloForBusinessAuthenticationMethods	Usage information for the operation WindowsHelloForBusinessAuthenticationMethods.rsd.

Lists all members of administrative units available to the authenticated user, providing details on their membership relationships.

Table Specific Information

Select

Get the members of administrative units in your Azure Active Directory. You can filter results by UnitId and MemberId.

• UnitId supports the '=' and IN operators.
• MemberId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM AdministrativeUnitMembers WHERE UnitId = '1721e354-9b76-49d5-bdf1-bb30a936c3ab'

SELECT * FROM AdministrativeUnitMembers WHERE MemberId IN (SELECT Id FROM Users)

Columns

Name	Type	Description
UnitId [KEY]	String	The unique identifier of the administrative unit, representing an Azure Active Directory organizational unit.
MemberId [KEY]	String	The unique identifier of the user or group that is a member of the specified administrative unit.

Displays a comprehensive list of administrative units accessible to the authenticated user, enabling management of organizational structure.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM AdministrativeUnits WHERE Id = '1721e354-9b76-49d5-bdf1-bb30a936c3ab'
SELECT * FROM AdministrativeUnits WHERE Id IN ('1721e354-9b76-49d5-bdf1-bb30a936c3ab')
SELECT * FROM AdministrativeUnits WHERE DisplayName LIKE '%Test%'

Columns

Name	Type	Description
id [KEY]	String	A unique identifier for the administrative unit, used to differentiate it from other units within the directory.
deletedDateTime	Datetime	The timestamp indicating when the administrative unit was deleted. It is null if the unit has not been deleted.
description	String	A brief text providing details about the purpose or characteristics of the administrative unit.
displayName	String	The user-friendly name of the administrative unit, intended for easy identification.
isMemberManagementRestricted	Bool	Specifies whether member management within this administrative unit is restricted to specific roles or users.
membershipRule	String	The dynamic membership rule for the administrative unit..
membershipRuleProcessingState	String	Controls whether the dynamic membership rule is actively processed.
membershipType	String	Indicates the membership type for the administrative unit.
visibility	String	Defines the visibility level of the administrative unit, such as whether it is publicly discoverable or restricted to internal use.

Represents a commercial subscription for a tenant.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * from CompanySubscriptions where Id = '4911b631-1b83-4384-9f22-9c8eb03e5c63'
SELECT * FROM CompanySubscriptions WHERE Id IN ('4911b631-1b83-4384-9f22-9c8eb03e5c63')

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the company subscription.
commerceSubscriptionId	String	The ID of this subscription in the commerce system.
createdDateTime	Datetime	The date and time when the company subscription was created in Azure Active Directory.
isTrial	Bool	Whether the subscription is a free trial or purchased.
nextLifecycleDateTime	Datetime	The date and time when the subscription will move to the next state if not renewed by the tenan.
ownerId	String	The object ID of the account admin.
ownerTenantId	String	The unique identifier for the Microsoft partner tenant that created the subscription on a customer tenant.
ownerType	String	Indicates the entity that ownerId belongs to.
serviceStatus	String	The provisioning status of each service included in this subscription.
skuId	String	The object ID of the SKU associated with this subscription.
skuPartNumber	String	The SKU associated with this subscription.
status	String	The status of this subscription.
totalLicenses	Int	The number of licenses included in this subscription.

Provides access to the organizational contact list, including external and internal contact details.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM Contacts WHERE Id = '8b0a526e-178d-4494-a276-8819b74d7933'
SELECT * FROM Contacts WHERE Id IN ('8b0a526e-178d-4494-a276-8819b74d7933', 'a8f14261-fb3b-42f7-a27a-d29877b5010b')
SELECT * FROM Contacts WHERE DisplayName LIKE '%Test%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the organizational contact, used for tracking and referencing.
deletedDateTime	Datetime	The timestamp indicating when the contact was deleted, if applicable.
addresses	String	A list of physical or postal addresses associated with the organizational contact.
companyName	String	The name of the company that the organizational contact is associated with.
department	String	The department within the company where the organizational contact works.
displayName	String	The full display name of the organizational contact, typically used in directories.
givenName	String	The first name or given name of the organizational contact.
jobTitle	String	The professional title or role of the organizational contact within the organization.
mail	String	The primary email address of the organizational contact.
mailNickname	String	An alias or nickname used for the contact's email.
onPremisesLastSyncDateTime	Datetime	The last recorded timestamp when the contact was synchronized with on-premises systems.
onPremisesProvisioningErrors	String	Details of any errors encountered during the provisioning of the contact on-premises.
onPremisesSyncEnabled	Bool	Indicates whether the contact is enabled for synchronization with on-premises systems.
phones	String	A list of phone numbers associated with the organizational contact.
proxyAddresses	String	Secondary email addresses or aliases associated with the organizational contact.
surname	String	The last name or family name of the organizational contact.

Presents all active contracts for the authenticated user, detailing subscription and agreement terms.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM Contracts WHERE Id = '8b0a526e-178d-4494-a276-8819b74d7933'
SELECT * FROM Contracts WHERE Id IN ('8b0a526e-178d-4494-a276-8819b74d7933')
SELECT * FROM Contracts WHERE DisplayName LIKE '%Test%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the contract, used to distinguish it from other records.
deletedDateTime	Datetime	The date and time when the contract was marked as deleted, indicating it is no longer active.
contractType	String	Specifies the type or category of the contract, such as subscription or licensing agreement.
customerId	String	The unique identifier of the customer associated with the contract.
defaultDomainName	String	The default domain name linked to the contract, typically used for customer authentication or services.
displayName	String	The user-friendly name or title assigned to the contract for easy identification.

Offers information on local administrator account credentials for specific device objects.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DeviceLocalCredentials WHERE Id = '2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785'
SELECT * FROM DeviceLocalCredentials WHERE Id IN ('2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785')
SELECT * FROM DeviceLocalCredentials WHERE DeviceName LIKE '%Desktop%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the device's local credentials, used for secure identification.
credentials	String	Encrypted or hashed representation of the device's local credentials used for authentication or access.
deviceName	String	The name assigned to the device, often used for identification or management purposes.
lastBackupDateTime	Datetime	The timestamp indicating when the device's credentials were last successfully backed up.
refreshDateTime	Datetime	The timestamp indicating the next scheduled refresh or expiration of the device's credentials.

Maps device objects to their registered owners for tracking and management purposes.

Table Specific Information

Select

Get the owners of registered Devices in your Azure Active Directory. You can filter results by DeviceId and OwnerId.

• DeviceId supports the '=' and IN operators.
• OwnerId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM DeviceRegisteredOwners WHERE DeviceId = '2b9c0347-9640-4ba4-bd2d-50965fb026e7'

SELECT * FROM DeviceRegisteredOwners WHERE OwnerId IN (SELECT Id FROM Groups)

Columns

Name	Type	Description
DeviceId [KEY]	String	The unique identifier for the device, used to reference the specific registered device in Azure Active Directory.
OwnerId [KEY]	String	The unique identifier for the user who owns the device, linking the device to its respective owner in Azure Active Directory.

Associates device objects with their registered users, facilitating detailed user-device relationship analysis.

Table Specific Information

Select

Get the users of registered Devices in your Azure Active Directory. You can filter results by DeviceId and UserId.

• DeviceId supports the '=' and IN operators.
• UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM DeviceRegisteredUsers WHERE DeviceId = '2b9c0347-9640-4ba4-bd2d-50965fb026e7'

SELECT * FROM DeviceRegisteredUsers WHERE UsersId IN (SELECT Id FROM Users)

Columns

Name	Type	Description
DeviceId [KEY]	String	The unique identifier assigned to each device registered in Azure Active Directory, used to track and manage devices.
UserId [KEY]	String	The unique identifier of the user associated with the registered device, enabling user-to-device relationship tracking.

Tracks and lists all directory audit events accessible to the authenticated user for compliance and monitoring.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DirectoryAudits WHERE Id = 'Directory_2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785'
SELECT * FROM DirectoryAudits WHERE Id IN ('Directory_2183313c-ac52-4772-8482-7b2eb2a5d7c9_LBZWQ_311068785')
SELECT * FROM DirectoryAudits WHERE ActivityDisplayName LIKE '%Update%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the DirectoryAudit entry, used to distinguish each audit record.
activityDateTime	Datetime	The date and time when the activity occurred, recorded in UTC.
activityDisplayName	String	The name of the activity or operation that was logged in the DirectoryAudit.
additionalDetails	String	Additional information or metadata about the activity, providing context or supplementary data.
category	String	The category of the activity, indicating the type of event (for example, user management, application management).
correlationId	String	The unique identifier for correlating this activity with related events across services.
initiatedBy_app_appid	String	The unique identifier of the application that initiated the activity, if applicable.
initiatedBy_app_displayName	String	The display name of the application that initiated the activity, providing a user-friendly identifier.
initiatedBy_app_servicePrincipalId	String	The service principal ID of the application that initiated the activity, used for authentication and authorization.
initiatedBy_app_servicePrincipalName	String	The service principal name of the application that initiated the activity, giving additional context about the app.
loggedByService	String	The name of the Azure service that logged this DirectoryAudit entry.
operationType	String	The type of operation performed (for example, CREATE, UPDATE, DELETE), providing high-level information about the activity.
result	String	The outcome of the activity, such as success or failure.
resultReason	String	The reason for the activity's result, offering details about any errors or issues encountered.
targetResources	String	Details about the resources targeted by this activity, including resource type and identifier.

Identifies the members assigned to specific directory roles within the Azure AD environment.

Table Specific Information

Select

Get the members of Directory Roles in your Azure Active Directory. You can filter results by RoleId and UserId.

• RoleId supports the '=' and IN operators.
• UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM DirectoryRoleMembers WHERE RoleId = '25502c98-94df-43fa-baf7-4a105e200030'

SELECT * FROM DirectoryRoleMembers WHERE UserId IN (SELECT Id FROM Users)

Columns

Name	Type	Description
RoleId [KEY]	String	The unique identifier for the directory role to which the user belongs. This value is used to associate a role with its members.
UserId [KEY]	String	The unique identifier for the user who is a member of the specified directory role. This value links the user to the role they belong to.

Contains a list of directory roles, detailing roles assigned to users and groups within the organization.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DirectoryRoles WHERE Id = '0f1032b0-ec73-4f72-836e-3b4411ea70c6'
SELECT * FROM DirectoryRoles WHERE RoleTemplateId = '4d6ac14f-3453-41d0-bef9-a3e0c569773a'
SELECT * FROM DirectoryRoles WHERE Id IN ('0f1032b0-ec73-4f72-836e-3b4411ea70c6', '081c8ba7-15a3-4c39-9972-053427b3c857')
SELECT * FROM DirectoryRoles WHERE DisplayName LIKE '%Admin%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the directory role, used to differentiate it from other roles.
deletedDateTime	Datetime	The timestamp indicating when the directory role was deleted, or null if it has not been deleted.
description	String	A detailed explanation of the directory role's purpose and functionality.
displayName	String	The human-readable name of the directory role, typically used in user interfaces.
roleTemplateId	String	The unique identifier for the template that defines the permissions and structure of this directory role.

Offers a template view of all directory roles available for use within Azure AD.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM DirectoryRoleTemplates WHERE Id = '62e90394-69f5-4237-9190-012177145e10'
SELECT * FROM DirectoryRoleTemplates WHERE Id IN ('62e90394-69f5-4237-9190-012177145e10', '2af84b1e-32c8-42b7-82bc-daa82404023b')
SELECT * FROM DirectoryRoleTemplates WHERE DisplayName LIKE '%Admin%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the directory role template, typically used as the primary key.
deletedDateTime	Datetime	The timestamp indicating when the directory role template was deleted, useful for auditing and recovery.
description	String	A detailed explanation or notes about the purpose and scope of the directory role template.
displayName	String	The human-readable name of the directory role template, used for display in user interfaces.

Usage information for the operation EmailAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
emailAddress	String

Usage information for the operation Fido2AuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
aaGuid	String
attestationCertificates	String
attestationLevel	String
createdDateTime	Datetime
displayName	String
model	String

Tracks application role assignments assigned to specific groups for managing permissions.

Table Specific Information

Select

Get the group application roles assignments in your Azure Active Directory. You can filter results by GroupId.

• UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM GroupApplicationRoleAssignments WHERE GroupId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM GroupApplicationRoleAssignments WHERE GroupId IN (SELECT Id FROM Groups)

Columns

Name	Type	Description
GroupId [KEY]	String	The unique identifier for the group associated with the application role assignment.
id [KEY]	String	The unique identifier for the application role assignment.
appRoleId	String	The unique identifier of the specific application role being assigned to the group.
createdDateTime	Datetime	The date and time when the application role assignment was created.
principalDisplayName	String	The display name of the principal (for example, user, group, or service principal) involved in the role assignment.
principalId	String	The unique identifier of the principal (for example, user, group, or service principal) associated with the role assignment.
principalType	String	The type of the principal (for example, user, group, or service principal) involved in the role assignment.
resourceDisplayName	String	The display name of the resource (for example, application or service) associated with the role assignment.
resourceId	String	The unique identifier of the resource (for example, application or service) to which the role assignment applies.

Provides a detailed view of group memberships, listing all members of each group within the organization.

Table Specific Information

Select

Query the GroupMembers table by retrieving everything from Azure AD or by specifying the GroupId with = and IN operators. You can filter results by GroupId and MemberId.

• GroupId supports the '=' and IN operators.
• MemberId supports the '=' and IN operators.

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'

Columns

Name	Type	Description
GroupId [KEY]	String	The unique identifier of the group, representing a specific collection of users or entities in Azure Active Directory.
MemberId [KEY]	String	The unique identifier of a user or entity that belongs to the specified group in Azure Active Directory.

Lists MFA statuses for users within the organization.

Table Specific Information

Select

SELECT * FROM MFAStatuses
SELECT * FROM MFAStatuses WHERE UserId = 'bc48eaf7-0dc6-45d1-b17a-5b5397466ee1'

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user, representing their Azure Active Directory account.
perUserMfaState	String	The per-user MFA state.

Usage information for the operation MicrosoftAuthenticatorAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
createdDateTime	Datetime
deviceTag	String
displayName	String
phoneAppVersion	String

Contains metadata and details about the organization accessible to the authenticated user.

Table Specific Information

Select

SELECT * FROM Organization

Update

To update an Organization record you need to specify the Id in WHERE clause.

Update Organization set marketingNotificationEmails = '[email protected]' where Id = 'bf6e4267-a9fb-419b-ae7b-7586fab0ff66'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the organization.
deletedDateTime	Datetime	The timestamp when the organization was marked as deleted, useful for auditing purposes.
assignedPlans	String	A list of plans assigned to the organization, detailing available services or subscriptions.
businessPhones	String	Contact phone numbers associated with the organization for business purposes.
city	String	The city where the organization's primary office is located.
country	String	The country where the organization is registered or primarily operates.
countryLetterCode	String	The ISO 3166-1 alpha-2 country code representing the organization's country.
createdDateTime	Datetime	The timestamp when the organization was first created in the system.
defaultUsageLocation	String	Default location code indicating where the organization primarily consumes services.
displayName	String	The human-readable name of the organization, often used for display purposes.
marketingNotificationEmails	String	Email addresses for receiving marketing-related communications from the system.
mobileDeviceManagementAuthority	String	Specifies the authority responsible for managing the organization's mobile devices, such as Intune.
onPremisesLastPasswordSyncDateTime	Datetime	The timestamp of the last successful password synchronization with on-premises systems.
onPremisesLastSyncDateTime	Datetime	The timestamp of the last directory synchronization with on-premises systems.
onPremisesSyncEnabled	Bool	Indicates whether synchronization with on-premises directories is enabled for the organization.
partnerTenantType	String	The type of tenant partnership, such as reseller or customer.
postalCode	String	The postal code of the organization's primary address.
preferredLanguage	String	The preferred language for communications and system interactions with the organization.
privacyProfile_contactEmail	String	The contact email address listed in the organization's privacy profile for data protection inquiries.
privacyProfile_statementUrl	String	The URL of the organization's privacy statement, outlining data protection policies.
provisionedPlans	String	A list of plans that have been provisioned for the organization, detailing available services.
securityComplianceNotificationMails	String	Email addresses for receiving security and compliance-related notifications.
securityComplianceNotificationPhones	String	Phone numbers for receiving security and compliance-related notifications.
state	String	The state or province where the organization's primary office is located.
street	String	The street address of the organization's primary office.
technicalNotificationMails	String	Email addresses for receiving technical alerts and system notifications.
tenantType	String	The type of tenant, such as educational or business.
verifiedDomains	String	A list of domains verified for use by the organization in the system.

Usage information for the operation PasswordAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
createdDateTime	Datetime
password	String

Lists phone-based authentication methods configured for users within the organization.

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user, representing their Azure Active Directory account.
id	String	The unique identifier for the phone authentication method associated with the user.
phoneNumber	String	The phone number registered for the user's authentication, formatted in international standard (E.164).
phoneType	String	The type of phone used for authentication, such as mobile, office, or home.
smsSignInState	String	Indicates the current state of Systems Management Server (SMS) sign-in for the user, such as enabled, disabled, or pending.

Usage information for the operation PlatformCredentialAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
createdDateTime	Datetime
displayName	String
keyStrength	String
platform	String

Retrieves custom properties displayed on user profile cards within the organization.

Table Specific Information

Select

SELECT * FROM ProfileCardProperties

Columns

Name	Type	Description
directoryPropertyName	String	Specifies the name of the directory property used in the Profile Card for identifying user attributes or details.
annotations	String	Provides additional metadata or notes about the directory property within the Profile Card for enhanced configurability.

null

Table Specific Information

Select

SELECT * FROM RiskDetections

Note: Querying this view requires additional scopes than the default. In order to access this table, you must have the IdentityRiskEvent.Read.All permission and the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission of Global Reader, Security Operator, Security Reader, or Security Administrator.

Columns

Name	Type	Description
id [KEY]	String
activity	String
activityDateTime	Datetime
additionalInfo	String
correlationId	String
detectedDateTime	Datetime
detectionTimingType	String
ipAddress	String
lastUpdatedDateTime	Datetime
location_city	String
location_countryOrRegion	String
location_geoCoordinates_altitude	Double
location_geoCoordinates_latitude	Double
location_geoCoordinates_longitude	Double
location_state	String
requestId	String
riskDetail	String
riskEventType	String
riskLevel	String
riskState	String
source	String
tokenIssuerType	String
userDisplayName	String
userId	String
userPrincipalName	String

null

Table Specific Information

Select

SELECT * FROM RiskyServicePrincipals

Note: Querying this view requires additional scopes than the default. In order to access this table, you must have the IdentityRiskyServicePrincipal.Read.All permission and the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission of Global Reader, Security Operator, Security Reader, or Security Administrator.

Columns

Name	Type	Description
id [KEY]	String
appId	String
displayName	String
isEnabled	Bool
isProcessing	Bool
riskDetail	String
riskLastUpdatedDateTime	Datetime
riskLevel	String
riskState	String
servicePrincipalType	String

null

Table Specific Information

Select

Get the risk history of a Microsoft Entra user. You can filter results by RiskyUserId.

• RiskyUserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM RiskyUserHistory WHERE RiskyUserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM RiskyUserHistory WHERE RiskyUserId IN (SELECT Id FROM RiskyUsers)

Note: Querying this view requires additional scopes than the default. In order to access this table, you must have the IdentityRiskyUser.Read.All permission and the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission of Global Reader, Security Operator, Security Reader, or Security Administrator.

Columns

Name	Type	Description
RiskyUserId	String
id [KEY]	String
isDeleted	String
isProcessing	String
riskDetail	String
riskLastUpdatedDateTime	String
riskLevel	String
riskState	String
userDisplayName	String
userPrincipalName	String
activity_detail	String
activity_riskEventTypes	String
initiatedBy	String
userId	String

null

Table Specific Information

Select

SELECT * FROM RiskyUsers

Note: Querying this view requires additional scopes than the default. In order to access this table, you must have the IdentityRiskyUser.Read.All permission and the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission of Global Reader, Security Operator, Security Reader, or Security Administrator.

Columns

Name	Type	Description
id [KEY]	String
isDeleted	Bool
isProcessing	Bool
riskDetail	String
riskLastUpdatedDateTime	Datetime
riskLevel	String
riskState	String
userDisplayName	String
userPrincipalName	String

Displays all role assignments configured within the Azure AD environment.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM RoleAssignments WHERE Id = '4yeYchSc90m7G5YI8Va7uM8rSNTfthJJt-QfAs-zqcI-1'
SELECT * FROM RoleAssignments WHERE RoleDefinitionId = '62e90394-69f5-4237-9190-012177145e10'
SELECT * FROM RoleAssignments WHERE PrincipalId = 'e5d250bd-92b4-44b2-b002-bc559f6d79e5'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the role assignment, used to distinguish it within the system.
condition	String	Specifies the condition under which the role assignment is applicable, often used for conditional access scenarios.
roleDefinitionId	String	The unique identifier of the role definition linked to this assignment, defining the permissions granted.
principalId	String	The unique identifier of the principal (user, group, or service principal) assigned this role.
directoryScopeId	String	The unique identifier for the directory scope in which this role assignment is effective, such as a specific Azure AD object or resource.
appScopeId	String	The unique identifier for the application scope of the role assignment, typically used for application-specific roles.

Provides definitions for roles available in Azure AD, detailing their permissions and scope.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM RoleDefinitions WHERE Id = '62e90394-69f5-4237-9190-012177145e10'
SELECT * FROM RoleDefinitions WHERE Id IN ('62e90394-69f5-4237-9190-012177145e10', 'fe930be7-5e62-47db-91af-98c3a49a38b1')
SELECT * FROM RoleDefinitions WHERE DisplayName LIKE '%Admin%'

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the role definition within Azure Active Directory.
allowedPrincipalTypes	String	Specifies the types of principals (for example, users, groups, applications) that can be assigned to this role.
description	String	A detailed explanation of the role definition's purpose and functionality.
displayName	String	The user-friendly name of the role definition, typically used for display in the Azure portal.
isBuiltIn	Bool	Indicates whether this role definition is prebuilt and provided by Azure (true) or custom-created (false).
isEnabled	Bool	Specifies if the role definition is currently active and available for assignments.
isPrivileged	Bool	Highlights whether this role definition includes privileged or high-impact permissions.
resourceScopes	String	Defines the set of resources or scopes (for example, subscriptions, resource groups) where the role applies.
rolePermissions	String	Lists the permissions and actions that this role grants within the defined resource scopes.
templateId	String	The unique identifier used for associating the role definition with a predefined template in Azure.
version	String	The version of the role definition, useful for tracking updates or changes.

null

Table Specific Information

Select

SELECT * FROM ServicePrincipalRiskDetections

Note: Querying this view requires additional scopes than the default. In order to access this table, you must have the IdentityRiskEvent.Read.All permission and the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission of Global Reader, Security Operator, Security Reader, or Security Administrator.

Columns

Name	Type	Description
id [KEY]	String
activity	String
activityDateTime	Datetime
additionalInfo	String
appId	String
correlationId	String
detectedDateTime	Datetime
detectionTimingType	String
ipAddress	String
keyIds	String
lastUpdatedDateTime	Datetime
location_city	String
location_countryOrRegion	String
location_geoCoordinates_altitude	Double
location_geoCoordinates_latitude	Double
location_geoCoordinates_longitude	Double
location_state	String
requestId	String
riskDetail	String
riskEventType	String
riskLevel	String
riskState	String
servicePrincipalDisplayName	String
servicePrincipalId	String
source	String
tokenIssuerType	String

Tracks and lists all user sign-in activities for audit and monitoring purposes.

Table Specific Information

Select

Most filters are handled server side, but the specific field of Id will change the endpoint we use to retrieve the data. It must be specified with an '=' or IN condition. For example:

SELECT * FROM SignIns WHERE Id = '8b0a526e-178d-4494-a276-8819b74d7933'
SELECT * FROM SignIns WHERE Id IN ('8b0a526e-178d-4494-a276-8819b74d7933', 'a8f14261-fb3b-42f7-a27a-d29877b5010b')
SELECT * FROM SignIns WHERE ResourceDisplayName LIKE '%Test%'

Columns

Name	Type	Description
id [KEY]	String	Unique identifier for the sign-in entry.
appDisplayName	String	The display name of the application involved in the sign-in event.
appId	String	The unique identifier (client ID) of the application involved in the sign-in event.
appliedConditionalAccessPolicies	String	List of conditional access policies applied during the sign-in event.
clientAppUsed	String	The type of client application (for example, browser, mobile app) used during the sign-in event.
conditionalAccessStatus	String	The status of the conditional access policy evaluation during the sign-in event (for example, success, failure).
correlationId	String	The unique identifier to correlate this sign-in event with related events for troubleshooting.
createdDateTime	Datetime	The date and time when the sign-in event occurred.
deviceDetail_browser	String	The browser used on the device during the sign-in event.
deviceDetail_deviceId	String	The unique identifier of the device used during the sign-in event.
deviceDetail_displayName	String	The display name of the device used during the sign-in event.
deviceDetail_isCompliant	Bool	Indicates whether the device used during the sign-in event complies with organizational policies.
deviceDetail_isManaged	Bool	Indicates whether the device used during the sign-in event is managed by the organization.
deviceDetail_operatingSystem	String	The operating system of the device used during the sign-in event.
deviceDetail_trustType	String	The trust type of the device (for example, Azure AD joined, hybrid Azure AD joined).
ipAddress	String	The IP address of the client device used during the sign-in event.
isInteractive	Bool	Indicates whether the sign-in was initiated interactively by the user.
signInLocation_city	String	The city where the sign-in event originated.
signInLocation_countryOrRegion	String	The country or region where the sign-in event originated.
signInLocation_state	String	The state or province where the sign-in event originated.
resourceDisplayName	String	The display name of the resource accessed during the sign-in event.
resourceId	String	The unique identifier of the resource accessed during the sign-in event.
riskDetail	String	Details about the risk assessment associated with the sign-in event.
riskEventTypes	String	The types of risk events detected during the sign-in event.
riskEventTypes_v2	String	A more detailed list of risk events detected during the sign-in event, using an updated schema.
riskLevelAggregated	String	The aggregated risk level for the sign-in event (for example, low, medium, high).
riskLevelDuringSignIn	String	The assessed risk level during the sign-in event (for example, low, medium, high).
riskState	String	The current state of the detected risk (for example, confirmed, dismissed).
signInStatus_additionalDetails	String	Additional details about the sign-in status, if available.
signInStatus_errorCode	Int	The error code returned for a failed sign-in attempt, if applicable.
signInStatus_failureReason	String	A descriptive reason for the failure of the sign-in event, if applicable.
userDisplayName	String	The display name of the user who performed the sign-in.
userId	String	The unique identifier of the user who performed the sign-in.
userPrincipalName	String	The user principal name (UPN) of the user who performed the sign-in, typically in email format.

Usage information for the operation SoftwareOathAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
secretKey	String

Lists service subscriptions (SKUs) the organization is subscribed to, including details of usage and availability.

Table Specific Information

Select

SELECT * FROM SubscribedSKUs

Columns

Name	Type	Description
id [KEY]	String	The unique identifier for the subscribed SKU.
accountId	String	The unique identifier for the account associated with the subscribed SKU.
accountName	String	The name of the account associated with the subscribed SKU.
appliesTo	String	Specifies the target audience or entity the subscribed SKU applies to.
capabilityStatus	String	The current status of the capabilities enabled by the subscribed SKU (for example, active, disabled).
consumedUnits	Int	The number of units from the subscription that have been consumed.
prepaidUnits_enabled	Int	The number of prepaid units currently enabled and available for use.
prepaidUnits_lockedOut	Int	The number of prepaid units that are locked out and cannot be used.
prepaidUnits_suspended	Int	The number of prepaid units that are suspended and temporarily unavailable.
prepaidUnits_warning	Int	The number of prepaid units with warning status, potentially indicating issues.
servicePlans	String	The service plans included in the subscribed SKU, listed as a string.
skuId	String	The unique identifier for the Stock Keeping Unit (SKU).
skuPartNumber	String	The part number associated with the SKU, often used for tracking and purchasing.
subscriptionIds	String	A list of subscription IDs tied to the subscribed SKU.

Usage information for the operation TemporaryAccessPassAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
createdDateTime	Datetime
isUsable	Bool
isUsableOnce	Bool
lifetimeInMinutes	Int
methodUsabilityReason	String
startDateTime	Datetime
temporaryAccessPass	String

Tracks application role assignments assigned to specific users for managing access and permissions.

Table Specific Information

Select

Get the user application roles assignments in your Azure Active Directory. You can filter results by UserId.

• UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM UserApplicationRoleAssignments WHERE UserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM UserApplicationRoleAssignments WHERE UserId IN (SELECT Id FROM Users)

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user assigned to the application role.
id [KEY]	String	The unique identifier for this specific application role assignment.
appRoleId	String	The unique identifier of the application role associated with the assignment.
createdDateTime	Datetime	The date and time when this application role assignment was created, in ISO 8601 format.
principalDisplayName	String	The display name of the principal (for example, user, group, or service principal) assigned the application role.
principalId	String	The unique identifier of the principal (for example, user, group, or service principal) associated with this role assignment.
principalType	String	The type of principal (for example, user, group, or service principal) associated with the role assignment.
resourceDisplayName	String	The display name of the target resource (for example, application or service) for the role assignment.
resourceId	String	The unique identifier of the target resource (for example, application or service) associated with the role assignment.

Maps users to their assigned managers within the organization for reporting and hierarchy management.

Table Specific Information

Select

Get the manager of users in your Azure Active Directory. You can filter results by UserId.

• UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM UserManagers WHERE UserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM UserManagers WHERE UserId IN (SELECT Id FROM Users)

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user associated with the manager.
ManagerId [KEY]	String	The unique identifier for the manager overseeing the user.
displayName	String	The full display name of the manager, typically used for identification in user interfaces.
jobTitle	String	The professional job title of the manager, indicating their role or position within the organization.
mail	String	The primary email address of the manager, used for communication purposes.
userPrincipalName	String	The principal username of the manager, typically formatted as an email address and used for sign-in.

Provides details of group and directory role memberships for specific users within the organization.

Table Specific Information

Select

Get the memberships of users in your Azure Active Directory. You can filter results by UserId.

• UserId supports the '=' and IN operators.

For example, the following queries are processed server side:

SELECT * FROM UserMemberships WHERE UserId = 'ffacf701-6caf-4228-9e3b-7e57c14122ee'

SELECT * FROM UserMemberships WHERE UserId IN (SELECT Id FROM Users)

Columns

Name	Type	Description
UserId [KEY]	String	The unique identifier for the user associated with this membership.
MembershipId [KEY]	String	The unique identifier for the membership entry.
classification	String	The classification label used to organize or categorize the membership.
createdDateTime	Datetime	The timestamp indicating when the membership was created.
creationOptions	String	Options or parameters specified during the creation of the membership.
deletedDateTime	Datetime	The timestamp indicating when the membership was deleted, if applicable.
description	String	A descriptive label or summary for the membership entry.
displayName	String	The human-readable name of the membership used for display purposes.
expirationDateTime	Datetime	The timestamp when the membership is set to expire, if applicable.
groupTypes	String	The types of groups the membership belongs to, such as 'Unified' or 'Dynamic'.
isAssignableToRole	Bool	Indicates whether this membership can be assigned to a role.
mail	String	The email address associated with the membership, if applicable.
mailEnabled	Bool	Indicates whether the membership has an active email mailbox.
mailNickname	String	The email alias or nickname associated with the membership.
membershipRule	String	The rules governing dynamic membership conditions for this group.
membershipRuleProcessingState	String	The current state of processing for the dynamic membership rules.
onPremisesDomainName	String	The domain name for the membership, synced from on-premises directories.
onPremisesLastSyncDateTime	Datetime	The timestamp of the last synchronization with the on-premises directory.
onPremisesNetBiosName	String	The NetBIOS name for the membership from the on-premises directory.
onPremisesProvisioningErrors	String	Details of any provisioning errors encountered during an on-premises synchronization.
onPremisesSamAccountName	String	The Security Account Manager (SAM) account name for the membership.
onPremisesSecurityIdentifier	String	The unique security identifier (SID) for the membership from the on-premises directory.
onPremisesSyncEnabled	Bool	Indicates whether synchronization with the on-premises directory is enabled.
preferredDataLocation	String	The preferred geographic location for storing the membership's data.
preferredLanguage	String	The preferred language setting for the membership.
proxyAddresses	String	A list of proxy addresses associated with the membership.
renewedDateTime	Datetime	The timestamp of the most recent renewal of the membership.
resourceBehaviorOptions	String	Behavioral options or settings applied to resources linked to the membership.
resourceProvisioningOptions	String	Provisioning options for resources tied to the membership.
securityEnabled	Bool	Indicates whether the membership has security features enabled.
securityIdentifier	String	The unique security identifier (SID) for the membership.
serviceProvisioningErrors	String	Details of any errors during service provisioning for the membership.
theme	String	The visual theme or branding applied to the membership.
uniqueName	String	A system-generated unique name for the membership.
visibility	String	The visibility setting of the membership, such as 'Public' or 'Private'.

Usage information for the operation WindowsHelloForBusinessAuthenticationMethods.rsd.

Columns

Name	Type	Description
UserId [KEY]	String
id	String
createdDateTime	Datetime
displayName	String
keyStrength	String

Data Type Mappings

The Sync App maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Azure Active Directory (OData V4)	CData Schema
Edm.Binary	binary
Edm.Boolean	bool
Edm.Date	datetime
Edm.DateTimeOffset	datetime
Edm.Decimal	decimal
Edm.Double	double
Edm.Guid	guid
Edm.Int32	int
Edm.String	string
Edm.TimeOfDay	time

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

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

Authentication

---

Property	Description
AuthScheme	Specifies the type of authentication to use when connecting to Azure Active Directory. If this property is left blank, the default authentication is used.

Azure Authentication

---

Property	Description
AzureTenant	Identifies the Azure Active Directory 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.

OAuth

---

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.

JWT OAuth

---

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.

SSL

---

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

Firewall

---

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

Proxy

---

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
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.
ExtensionPropertiesAppId	The ID of the Application that you want to get extension properties for. For all applications, set the value of this property to '*'.
GroupId	Specify a default GroupId.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxSelectLength	This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it. The default is -1.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
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.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
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 Azure Active Directory. If this property is left blank, the default authentication is used.

Specifies the type of authentication to use when connecting to Azure Active Directory. If this property is left blank, the default authentication is used.

Remarks

AuthScheme values include:

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

For information about creating a custom application to authenticate with Azure AD, see Creating an 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).

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 Azure Active Directory 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 Azure Active Directory tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.

Remarks

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:

• When AuthScheme is set to AzureServicePrincipal or AzureServicePrincipalCert
• When AuthScheme is AzureAD and the user account belongs to multiple tenants

You can provide the tenant value in one of two formats:

• A domain name (for example, contoso.onmicrosoft.com)
• A directory (tenant) ID in GUID format (for example, c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

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.

Remarks

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

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

---

Property	Description
OAuthClientId	Specifies the client ID (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.

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App 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.).

Remarks

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:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

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.

Remarks

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.

Remarks

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 Sync App initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

• The most common User and Machine certificate stores in Windows include:
  • MY: A certificate store holding personal certificates with their associated private keys.
  • CA: Certifying authority certificates.
  • ROOT: Root certificates.
  • SPC: Software publisher certificates.
• In Java, the certificate store normally is a file containing certificates and optional private keys.
• When the certificate store type is PFXFile, this property must be set to the name of the file.
• When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Identifies the type of key store containing the JWT Certificate.

Remarks

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.

Remarks

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.

Remarks

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

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

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

Common fields include:

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

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

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

---

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

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

Remarks

If 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 Firewall properties you can configure in the connection string for this provider.

---

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

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

Remarks

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

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

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

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

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Azure Active Directory. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Azure Active Directory. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Azure Active Directory. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

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

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

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

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

Remarks

Supported authentication types :

• BASIC: The Sync App performs HTTP basic authentication.
• DIGEST: The Sync App performs HTTP digest authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Signifies that the ProxyServer does not require authentication.

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

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

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

Remarks

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

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

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

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

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

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

---

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

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

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

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

---

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

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

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\AzureAD Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

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

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

Remarks

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

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

Remarks

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

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

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

Remarks

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

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

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

---

Property	Description
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.
ExtensionPropertiesAppId	The ID of the Application that you want to get extension properties for. For all applications, set the value of this property to '*'.
GroupId	Specify a default GroupId.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxSelectLength	This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it. The default is -1.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
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.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserId	Specify a default UserId.

Determines whether to use the /me/memberOf or /groups endpoint for user authentication.

Remarks

Determines whether to use the /me/memberOf or /groups endpoint for user authentication.

Supported values are:

• CurrentUser: Uses the /me/memberOf endpoint for user authentication.
• AllGroups: Uses the /groups endpoint for user authentication.

Determines whether to use the /me or /users endpoint for user authentication.

Remarks

Determines whether to use the /me or /users endpoint for user authentication.

Supported values are:

• CurrentUser: Uses the /me endpoint for user authentication.
• AllUsers: Uses the /users endpoint for user authentication.

The ID of the Application that you want to get extension properties for. For all applications, set the value of this property to '*'.

Remarks

The ID of the Application that you want to get extension properties for. For all applications, set the value of this property to '*'.

Specify a default GroupId.

Remarks

Specify a default GroupId.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

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.

This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it. The default is -1.

Remarks

Some APIs require that the list of columns be specified in the $select query parameter. In these cases, it is recommended to use the ExpandAsterisk connection property.

If the MaxSelectLength is exceeded, we will try to default to $select=*. However, APIs that do not support this will trigger a validation error, so customers will need to manually limit the selection list. Depending on the OData version, using $select=* and omitting the $select parameter completely considered the same. The default is -1.

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

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

Integration and Formatting

Property	Description
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

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

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

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.

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

Remarks

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

For example:

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

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Specify a default UserId.

Remarks

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.