CData Python Connector for Office 365 2019 - Online Help
Questions / Feedback?

Groups

CData Python Connector for Office 365 2019 - Build 19.0.7416

The Office365 table Groups.

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 Custom Credentials 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 navigate to the following web page and grant permissions. Then run the OAuth authorization as normal afterwards.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

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
SELECT * FROM Groups WHERE Id = 'Group Id here'
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)

Columns

Name Type ReadOnly References Description
id [KEY] String True

The unique identifier for the group.

allowExternalSenders Boolean False

Indicates if people external to the organization can send messages to the group.

autoSubscribeNewMembers Boolean False

Indicates if new members added to the group will be auto-subscribed to receive email notifications.

description String False

An optional description for the group.

displayName String False

The display name for the group.

groupTypes String False

Specifies the type of group to create. Possible values are Unified to create an Office 365 group, or DynamicMembership for dynamic groups. For all other group types, like security-enabled groups and email-enabled security groups, do not set this property.

isSubscribedByMail Boolean False

Indicates whether the current user is subscribed to receive email conversations..

mail String True

The SMTP address for the group.

mailEnabled Boolean False

Specifies whether the group is mail-enabled. If the securityEnabled property is also true, the group is a mail-enabled security group; otherwise, the group is a Microsoft Exchange distribution group.

mailNickname String False

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

onPremisesLastSyncDateTime Datetime True

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

onPremisesSecurityIdentifier String True

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

onPremisesSyncEnabled Boolean True

True if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory.

proxyAddresses String True

The proxy addresses for the table Groups.

securityEnabled Boolean False

Specifies whether the group is a security group. If the mailEnabled property is also true, the group is a mail-enabled security group; otherwise it is a security group. Must be false for Office 365 groups.

unseenCount Int32 False

Count of posts that the current user has not seen since his last visit.

visibility String False

Specifies the visibility of an Office 365 group. The possible values are: Private, Public, HiddenMembership, or empty (which is interpreted as Public).

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7416.0