Skip to Content
Technical Articles
Author's profile photo Robert Eijpe

Consuming Microsoft 365 API in the Cloud Application Programming (CAP) Model

The SAP Devtoberfest 2020 challenge brought new insights to simplify the consuming external API in NodeJS and the Cloud Application Programming (CAP) Model and combine them with a concept for integrating Microsoft Azure and Google Cloud APIs.

As a result of this challenge, the SAP mentor’s community announced a new node.js library CDS-SCP-API for simplifying the consuming external service in Cloud Application Programming (CAP) Model. This blog will explain how you can use this node.js library for consuming Microsoft 365 APIs.

We will use the Microsoft Graph API for reading all users’ full profiles, which API documentation can be found at Microsoft Graph REST API v1.0 documentation. But you can use any API which is available at Microsoft Azure.

To use Microsoft 365 APIs, we first need to configure the Microsoft Graph API layer in Microsoft Azure. These 19 configuration steps in Microsoft Azure are written here in the documentation of the node.js library CDS-SCP-API.

After we have configured Microsoft Azure, we need to configure our destination in the SAP Cloud Platform Destination Service.

URL               :
Client ID         : <Application client ID of Azure App>
Client Secret     : <Clients Secrets Value of Azure App>
Token Service URL :<Directory Tenant ID of Azure App>/oauth2/v2.0/token
                    or <Token Service URL : <Application OAuth 2.0 token Endpoint(v2) of Azure App>
Scope             :


Now we set up SAP Cloud Platform and Microsoft Azure, we are ready to build our CAP project.


  1. Create a new folder and enter the new folder
    mkdir <cds-azure-example-folder>
    cd <cds-azure-example-folder>​
  2. Initialize as CAP CDS project
    cds init​
  3. Add cds-scp-API dependencies in the package.json file.
    "dependencies": {
      "@sapmentors/cds-scp-api": "latest"
  4. install the node packages by running
    npm install​
  5. add a file named msgraph-user-service.cds with the following cds definition in the srv folder
    @cds.query.limit: 100
    service MSGraphService @(requires:'any'){
      entity User {
        key aad_id                 : String;
            username               : String;
            displayName            : String;
            givenName              : String;
            surname                : String;
            isAzureActiveDirectory : Boolean;
  6. add a file named msgraph-user-service.js with the following cds definition in the srv folder
    const cdsapi = require("@sapmentors/cds-scp-api");
    const readFunction = async (req) => {
      let destination = 'MSGraph'
      const url = `/v1.0/users/`
      const service = await;
      const graphUser = await{
        url: url
      let users = => {
        var user = {}
        user.aad_id =
        user.username = graph_user.userPrincipalName
        user.displayName = graph_user.displayName
        user.givenName = graph_user.givenName
        user.surname = graph_user.surname
        user.isAzureActiveDirectory = true
        return user
      return users
    module.exports = (srv) => {
      srv.on('READ', 'User', readFunction)
  7. create a default-env.json file as described in the prerequisites for running examples locally
  8. Start CDS watch to start the application.
    cds watch​
  9. Open http://localhost:4004 in your browser to open an overview of the CAP services.
  10. Click on the link User to see the data from Microsoft Azure Active Directory User List API.

Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Pierre Dominique
      Pierre Dominique

      This is something that was on my todo list (i.e getting user details from O365) so thank you for sharing this!

      Author's profile photo Pierre Dominique
      Pierre Dominique

      Robert Eijpe > I followed your instructions but when I run cds watch I get the following error:

      [ERROR] Failed loading service implementation from '/Users/pdominique/code/cap/cap-azure-test/msgraph-user-service.js'
      at _require (/Users/pdominique/code/cap/cap-azure-test/node_modules/@sap/cds/lib/srv/factory.js:42:17)
      at _use (/Users/pdominique/code/cap/cap-azure-test/node_modules/@sap/cds/lib/srv/factory.js:23:48)
      at new ServiceFactory (/Users/pdominique/code/cap/cap-azure-test/node_modules/@sap/cds/lib/srv/factory.js:14:43)
      at _new (/Users/pdominique/code/cap/cap-azure-test/node_modules/@sap/cds/lib/srv/serve.js:114:15)
      at /Users/pdominique/code/cap/cap-azure-test/node_modules/@sap/cds/lib/srv/serve.js:71:32
      at (<anonymous>)
      at /Users/pdominique/code/cap/cap-azure-test/node_modules/@sap/cds/lib/srv/serve.js:71:23

      Note: I also had to install the module directly from GitHub as it’s not published on npm:

      npm install git+

      EDIT: I found the issue -> I just needed to remove the following line of code (not necessary anyway):

      @impl            : 'msgraph-user-service.js'


      Author's profile photo Shyam Vasani
      Shyam Vasani

      Dear Robert Eijpe ,


      Thanks for the nice blog and the npm package.


      I tried following the same steps, but upon execution I am getting below error -


      Could you please guide on what I might be missing upon?


      Best Regards,

      Shyam Vasani

      Author's profile photo Mary Silvester
      Mary Silvester

      Hi Shyam,


      I am also facing the same issue.. Did you got any resolution for the above error.



      Mary Silvester

      Author's profile photo Krzysztof Bulanowski
      Krzysztof Bulanowski


      Thanks for posting this very interesting blog.

      I have a question regarding point 7. - where can I find the prerequisites in which the creation of a default-env.json file is described?

      Many thanks in advance,


      Author's profile photo Robert Eijpe
      Robert Eijpe
      Blog Post Author


      Author's profile photo Krzysztof Bulanowski
      Krzysztof Bulanowski

      Hi Robert,


      I have an issue with the $search parameter when I try to read data of a particular user.

      I build the url as follows:


      const url = `/users/?$search="onPremisesSamAccountName:ABCDE"`


      But then I get the error which says:

      "Request with $search query parameter only works through MSGraph with a special request header: 'ConsistencyLevel: eventual'"

      I have added the property URL.headers.ConsistencyLevel to destination properties in SAP BTP, but it does not work.

      I have also tried to set this header property explicitly:

      const graphUser = await{

      url: url,

      headers: { "ConsistencyLevel": "Eventual"}


      But in both cases I get the same error message.


      Do you know how to request the data of a particular user from Graph or how to correctly set ConsistencyLevel property in request header?