ms-python-client 1.0.4

This package is used to interact with the microsoft graph API

Microsoft Python client

Microsoft graph API Python client with support for Server to Server Oauth tokens with App Only access.

Install

This package is available on Pypi

pip install ms-python-client

Requirements

• Python >= 3.10

How to configure the client variables to make API calls

Defining your env variables

Define the following variables in your env or your .env file:

• MS_ACCOUNT_ID
• MS_CLIENT_ID
• MS_CLIENT_SECRET

For testing purposes

For testing purposes, you can use the following value:

• MS_ACCESS_TOKEN

This token could be obtained from the Microsoft Graph Explorer by clicking on the Sign in with Microsoft button and then clicking on the Access Token tab.

Usage

Initialize the MSApiClient from environment variables

from ms_python_client.ms_api_client import MSApiClient

ms_client = MSApiClient.init_from_env()

Initialize the MSApiClient from .env

from ms_python_client.ms_api_client import MSApiClient

ms_client = MSApiClient.init_from_dotenv()

Initialize the MSApiClient manually

from ms_python_client.ms_api_client import MSApiClient

ms_client = MSApiClient(
        account_id="<YOUR ACCOUNT ID>",
        client_id="<YOUR CLIENT ID>",
        client_secret="<YOUR CLIENT SECRET>")

Use the file system to store the access token instead of environment

There are some cases where you might want to store the access token in the file system in order to share its value with other elements of the application (Ex. different pods on a Kubernetes/Openshift application).

You can define the path where the token will be stored, passing the use_path variable to the constructor:

from ms_python_client.ms_api_client import MSApiClient

ms_client = MSApiClient(
        account_id="<YOUR ACCOUNT ID>",
        client_id="<YOUR CLIENT ID>",
        client_secret="<YOUR CLIENT SECRET>",
        use_path="/path/to/token/folder")

How to make API calls

USER_ID = "12345"
SUBJECT = "Test meeting"

query = {"$count": "true", "$filter": f"contains(subject,'{SUBJECT}')"}
result = cern_ms_client.events.list_events(USER_ID, query)

Optional: How to configure the logging

from ms_python_client.utils.logger import setup_logs

setup_logs(log_level=logging.DEBUG)

Available endpoints

events:

1. get all events
2. get a single event
3. create an event
4. update an event
5. delete an event

users:

1. get all users

CERN specific usage

Instead of using the MSApiClient class, you can use the CERNMSApiClient class, which is a subclass of the MSApiClient class. This class will provide you some more utilities but it will only work for CERN users (obviously).

This will be used in the context of synchronizing the events between the CERN Indico system and the calendars of the Zoom Rooms.

How to initialize the CERNMSApiClient

Follow the How to configure the client variables to make API calls section and then:

from ms_python_client.cern_ms_api_client import CERNMSApiClient

cern_ms_client = CERNMSApiClient.init_from_dotenv()

Available endpoints

events:

1. get all events
2. get a single event using zoom id
3. create an event
4. update an event using zoom id
5. delete an event using zoom id
6. get the zoom id of an event

You will find useful the EventParameters and PartialEventParameters classes, which will help you to create the events.

• ZOOM_ID is the id of the zoom meeting, which can be found inside the url of a meeting link. This is mandatory to create an event.
• USER_ID is the email of the Zoom Room.

from ms_python_client.cern_ms_api_client import CERNMSApiClient
from ms_python_client.utils.event_generator import (EventParameters, PartialEventParameters)

cern_ms_client = CERNMSApiClient.init_from_dotenv()

USER_ID = os.getenv("USER_ID") # Which is the email of the Zoom Room
ZOOM_ID = os.getenv("ZOOM_ID")

event_parameters = EventParameters(
        subject="Test meeting",
        start_time="2021-10-01T12:00:00",
        end_time="2021-10-01T13:00:00",
        timezone="Europe/Zurich",
        zoom_id=ZOOM_ID,
        zoom_url="https://cern.zoom.us/******",
)

partial_event_parameters = PartialEventParameters(
        zoom_id=ZOOM_ID,
        end_time="2021-10-01T14:00:00",
) # You can update only the end_time of the event for example

cern_ms_client.events.create_event(USER_ID, event_parameters)
cern_ms_client.events.update_event_by_zoom_id(USER_ID, partial_event_parameters)
cern_ms_client.events.delete_event_by_zoom_id(USER_ID, ZOOM_ID)