Forum OpenACS Development: New Interface for interacting with the Microsoft Graph (e.g. MS Teams)

Dear all,

since a while, there is an interface for the MSGraph API in the OpenACS code repository. Thus, API can be used e.g. to integrate OpenACS applications with MS Teams or other application in the Microsoft cloud.

These interface classes support conversion from/to JSON and to the url-encoded calling patterns on the fly, just by specifying the Tcl variable names with minor annotations (somewhat similar to the
export_vars interface). Furthermore, the interface supports pagination: some Microsoft Graph API calls return per default just a partial number of results (e.g. first 100). To obtain all results, multiple REST calls have to be issued to get the full result set. Over this interface, one can specify the desired maximum number of entries.

Furthermore, the API supports async operations
(create/clone/archive/unarchive teams), where the behavior can be tailored via the options "-wait" and "-donecallback".

To use the Microsoft Graph API, an "app" has to be
registered/configured/authorized/...[1,2,3] by an administrator of the organization before an access token [4] can be obtained token from the Microsoft identity platform. The access token contains information about your app and the permissions it has for the resources and APIs available through Microsoft Graph.

This interface is based on access tokens [4] and the /token endpoint [1] ("Get access without a user") and assumes, one has already obtained the client_id and client_secret to configure this service this way.

In theory, this API will allow later to switch to newer versions of the Graph API when newer versions (currently post 1.0) of the Microsoft Graph API will come out.

The interface is written in an ensemble style where commands with the same kind of objects share a common prefix (examples are "group", "team", "user", "application", ... see below for more details). It follows strictly to the Microsoft naming conventions and makes it straightforward to extend the interface in the future.

The implementation is part of the xooauth package [5]. The wiki page msgraph contains the listing of the API calls and an example usage.

Hope, someone might find this useful