groups_samples.md

Create the API Client

import asyncio

from azure.identity import ClientSecretCredential
from msgraph import GraphServiceClient

# Create a credential object. Used to authenticate requests
credential = ClientSecretCredential(
    tenant_id='TENANT_ID',
    client_id='CLIENT_ID',
    client_secret='CLIENT_SECRET'
)
scopes = ['https://graph.microsoft.com/.default']

# Create an API client with the credentials and scopes.
client = GraphServiceClient(credentials=credential, scopes=scopes)

1. LIST ALL GROUPS IN THE TENANT (GET /groups)

async def get_groups():
    groups = await client.groups.get()
    if groups and groups.value:
        for group in groups.value:
            print(group.id, group.display_name)
asyncio.run(get_groups())

2. GET A SPECIFIC GROUP (GET /groups/{id})

async def get_group():
    group = await client.groups.by_group_id('GROUP_ID').get()
    if group:
        print(group.id, group.display_name, group.description, group.group_types,
            group.security_enabled)
asyncio.run(get_group())

3. LIST ALL MEMBERS IN A GROUP (GET /groups/{id}/members)

async def get_group_members(): 
    members = await client.groups.by_group_id('GROUP_ID').members.get()
    if members and members.value:
        for member in members.value:
            user = await client.users.by_user_id(member.id).get()
            if user:
                print(user.display_name, user.mail)
asyncio.run(get_group_members())

4. LIST A GROUP TEAM SHAREPOINT SITES (GET /groups/{id}/sites)

async def get_group_sites():
    sites = await client.groups.by_group_id('GROUP_ID').sites.get()
    if sites and sites.value:
        for site in sites.value:
            print(site.id, site.web_url)
asyncio.run(get_group_sites())

5. LIST A GROUP'S TRANSITIVE MEMBERS (GET /groups/{id}/transitiveMembers)

async def get_group_transitive_members():
    members = await client.groups.by_group_id('GROUP_ID').transitive_members.get()
    if members and members.value:
        for member in members.value:
            obj = await client.directory_objects.by_directory_object_id(member.id).get()
            if obj and obj.odata_type == '#microsoft.graph.user':
                user = await client.users.by_user_id(obj.id).get()
                if user:
                    print(user.id, user.display_name, user.mail)
asyncio.run(get_group_transitive_members())

6. LIST ALL GROUP DRIVES (GET /groups/{id}/drives)

async def get_group_drives():
    drives = await client.groups.by_group_id('GROUP_ID').drives.get()
    if drives and drives.value:
        for drive in drives.value:
            print(drive.id, drive.name)
asyncio.run(get_group_drives())

7. GET A GROUP DRIVE (GET /groups/{id}/drives/{id})

async def get_group_drive():
    drive = await client.groups.by_group_id(
        'GROUP_ID'
        ).drives.by_drive_id(
            'DRIVE_ID'
            ).get()
    if drive:
        print(drive.id, drive.drive_type, drive.name, drive.web_url, drive.items)
asyncio.run(get_group_drive())