チュートリアル:Node.js コンソールデーモンアプリで Microsoft Graph API を呼び出す

[アーティクル]
04/09/2024

このチュートリアルでは、独自の ID を使用して Microsoft Graph API を呼び出すコンソールデーモンアプリを作成します。作成するデーモンアプリでは、Node.js 用の Microsoft Authentication Library (MSAL) を使用します。

このチュートリアルでは、次の手順に従います。

Azure portal でアプリケーションを登録する
Node.js コンソールデーモンアプリプロジェクトを作成する
アプリに認証ロジックを追加する
アプリの登録の詳細を追加する
Web API を呼び出すメソッドを追加する
アプリケーションをテストする

前提条件

Node.js
Visual Studio Code または別のコードエディター

アプリケーションを登録する

まず、Microsoft ID プラットフォームへのアプリケーションの登録に関するページの手順に従って、アプリを登録します。

アプリの登録には、次の設定を使用します。

名前: NodeDaemonApp (推奨)
サポートされているアカウントの種類: この組織のディレクトリ内のアカウントのみ
API のアクセス許可: [Microsoft API]>[Microsoft Graph]>[アプリケーションのアクセス許可]>User.Read.All
クライアントシークレット: ********* (後の手順で使用するためにこの値を記録します。これは 1 回しか表示されません)

プロジェクトを作成する

まず、この Node.js チュートリアルプロジェクトのディレクトリを作成します。例: NodeDaemonApp。
ターミナルで、作成したディレクトリ (プロジェクトルート) に移動し、次のコマンドを実行します。
```
npm init -y
npm install --save dotenv yargs axios @azure/msal-node
```
次に、プロジェクトルートの package.json ファイルを編集し、次のように main の値の前に bin/ を付けます。
```
"main": "bin/index.js",
```

次に、bin ディレクトリを作成し、bin 内に、index.js という名前の新しいファイルに次のコードを追加します。

#!/usr/bin/env node

// read in env settings
require('dotenv').config();

const yargs = require('yargs');

const fetch = require('./fetch');
const auth = require('./auth');

const options = yargs
    .usage('Usage: --op <operation_name>')
    .option('op', { alias: 'operation', describe: 'operation name', type: 'string', demandOption: true })
    .argv;

async function main() {
    console.log(`You have selected: ${options.op}`);

    switch (yargs.argv['op']) {
        case 'getUsers':

            try {
                // here we get an access token
                const authResponse = await auth.getToken(auth.tokenRequest);

                // call the web API with the access token
                const users = await fetch.callApi(auth.apiConfig.uri, authResponse.accessToken);

                // display result
                console.log(users);
            } catch (error) {
                console.log(error);
            }

            break;
        default:
            console.log('Select a Graph operation first');
            break;
    }
};

main();

作成した index.js ファイルは、次に作成する他の 2 つのノードモジュールを参照します。

auth.js - MSAL Node を使用して、Microsoft ID プラットフォームからアクセストークンを取得します。
fetch.js - API への HTTP 要求にアクセストークン (auth.js で取得) を含めて、Microsoft Graph API からデータを要求します。

チュートリアルの最後に、プロジェクトのファイルとディレクトリの構造が次のように表示されます。

NodeDaemonApp/
├── bin
│   ├── auth.js
│   ├── fetch.js
│   ├── index.js
├── package.json
└── .env

認証ロジックを追加する

bin ディレクトリ内で、auth.js という名前の新しいファイルに次のコードを追加します。 auth.js のコードは、Microsoft Graph API の要求に含めるためのアクセストークンを Microsoft ID プラットフォームから取得します。

const msal = require('@azure/msal-node');

/**
 * Configuration object to be passed to MSAL instance on creation.
 * For a full list of MSAL Node configuration parameters, visit:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/configuration.md
 */
const msalConfig = {
    auth: {
        clientId: process.env.CLIENT_ID,
        authority: process.env.AAD_ENDPOINT + '/' + process.env.TENANT_ID,
        clientSecret: process.env.CLIENT_SECRET,
    }
};

/**
 * With client credentials flows permissions need to be granted in the portal by a tenant administrator.
 * The scope is always in the format '<resource>/.default'. For more, visit:
 * https://zcusa.951200.xyz/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
 */
const tokenRequest = {
    scopes: [process.env.GRAPH_ENDPOINT + '/.default'],
};

const apiConfig = {
    uri: process.env.GRAPH_ENDPOINT + '/v1.0/users',
};

/**
 * Initialize a confidential client application. For more info, visit:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-confidential-client-application.md
 */
const cca = new msal.ConfidentialClientApplication(msalConfig);

/**
 * Acquires token with client credentials.
 * @param {object} tokenRequest
 */
async function getToken(tokenRequest) {
    return await cca.acquireTokenByClientCredential(tokenRequest);
}

module.exports = {
    apiConfig: apiConfig,
    tokenRequest: tokenRequest,
    getToken: getToken
};

上記のコードスニペットでは、まず構成オブジェクト (msalConfig) を作成し、これを渡すことによって MSAL ConfidentialClientApplication を初期化します。次に、クライアントの資格情報を使用してトークンを取得するためのメソッドを作成し、最後に、main.js からアクセスできるようにこのモジュールを公開します。このモジュールの構成パラメーターは、次の手順で作成する環境ファイルから取得されます。

アプリの登録の詳細を追加する

トークンを取得するときに使用されるアプリ登録の詳細を格納するための環境ファイルを作成します。これを行うには、サンプルのルートフォルダー (NodeDaemonApp) 内に .env という名前のファイルを作成し、次のコードを追加します。

# Credentials
TENANT_ID=Enter_the_Tenant_Id_Here
CLIENT_ID=Enter_the_Application_Id_Here
CLIENT_SECRET=Enter_the_Client_Secret_Here

# Endpoints
AAD_ENDPOINT=Enter_the_Cloud_Instance_Id_Here/
GRAPH_ENDPOINT=Enter_the_Graph_Endpoint_Here/

これらの詳細には、Azure アプリ登録ポータルから取得した値を入力します。

Enter_the_Tenant_Id_here は、次のいずれかにする必要があります。
- ご自分のアプリケーションで "この組織のディレクトリ内のアカウント" がサポートされる場合は、この値をテナント ID またはテナント名に置き換えます。たとえば、「 contoso.microsoft.com 」のように入力します。
- アプリケーションで "任意の組織のディレクトリ内のアカウント" がサポートされる場合は、この値を organizations に置き換えます。
- アプリケーションで "任意の組織のディレクトリ内のアカウントと個人用の Microsoft アカウント" がサポートされる場合は、この値を common に置き換えます。
- "個人用の Microsoft アカウントのみ" にサポートを制限するには、この値を consumers に置き換えます。
Enter_the_Application_Id_Here:登録したアプリケーションのアプリケーション (クライアント) ID。
Enter_the_Cloud_Instance_Id_Here:アプリケーションが登録されている Azure クラウドインスタンス。
- メイン ("グローバル") Azure クラウドの場合は、「https://login.microsoftonline.com」と入力します。
- 各国のクラウド (中国など) の場合は、「各国のクラウド」に適切な値が記載されています。
Enter_the_Graph_Endpoint_Here は、アプリケーションが通信する必要がある、Microsoft Graph API のインスタンスです。
- グローバル Microsoft Graph API エンドポイントの場合は、この文字列の両方のインスタンスを https://graph.microsoft.com に置き換えます。
- 各国のクラウドのデプロイにおけるエンドポイントの場合は、Microsoft Graph のドキュメントで「各国のクラウドでのデプロイ」を参照してください。

Web API を呼び出すメソッドを追加する

bin フォルダーに fetch.js という名前の別のファイルを作成し、Microsoft Graph API への REST 呼び出しを行うための次のコードを追加します。

const axios = require('axios');

/**
 * Calls the endpoint with authorization bearer token.
 * @param {string} endpoint
 * @param {string} accessToken
 */
async function callApi(endpoint, accessToken) {

    const options = {
        headers: {
            Authorization: `Bearer ${accessToken}`
        }
    };

    console.log('request made to web API at: ' + new Date().toString());

    try {
        const response = await axios.get(endpoint, options);
        return response.data;
    } catch (error) {
        console.log(error)
        return error;
    }
};

module.exports = {
    callApi: callApi
};

ここでは、callApi メソッドを使用して、アクセストークンを必要とする保護されたリソースに対して HTTP GET 要求を実行します。その後、この要求からその内容が呼び出し元に返されます。このメソッドは、取得したトークンを HTTP Authorization ヘッダーに追加します。ここで保護されているリソースは、このアプリが登録されているテナント内のユーザーを表示する Microsoft Graph API ユーザーエンドポイントです。

アプリをテストする

これでアプリケーションの作成が完了し、アプリの機能をテストする準備ができました。

プロジェクトフォルダーのルート内から次のコマンドを実行して、Node.js コンソールデーモンアプリを起動します。

node . --op getUsers

これにより Microsoft Graph API からの JSON 応答が生成され、コンソールにユーザーオブジェクトの配列が表示されます。

You have selected: getUsers
request made to web API at: Fri Jan 22 2021 09:31:52 GMT-0800 (Pacific Standard Time)
{
    '@odata.context': 'https://graph.microsoft.com/v1.0/$metadata#users',
    value: [
        {
            displayName: 'Adele Vance'
            givenName: 'Adele',
            jobTitle: 'Retail Manager',
            mail: 'AdeleV@msaltestingjs.onmicrosoft.com',
            mobilePhone: null,
            officeLocation: '18/2111',
            preferredLanguage: 'en-US',
            surname: 'Vance',
            userPrincipalName: 'AdeleV@msaltestingjs.onmicrosoft.com',
            id: '00aa00aa-bb11-cc22-dd33-44ee44ee44ee'
        }
    ]
}

Graph の応答が表示されたコマンドラインインターフェイス

アプリケーションの動作

このアプリケーションでは、OAuth 2.0 クライアント資格情報の認可を使用します。この種類の許可は、バックグラウンドでの実行が必要なサーバー間の相互作用に使用され、ユーザーとの即時の相互動作は必要ありません。資格情報許可フローでは、Web サービス (機密クライアント) が別の Web サービスを呼び出すときに、ユーザーを偽装する代わりに、独自の資格情報を使用して認証を行うことができます。この認証モデルでサポートされるアプリケーションの種類は、通常、デーモンまたはサービスアカウントです。

クライアントの資格情報フローのために要求するスコープは、後に /.default が続くリソースの名前です。この表記は、アプリケーションの登録時に静的に宣言された "アプリケーションレベルの権限" を使用するように Microsoft Entra ID に指示します。また、これらの API アクセス許可は、テナント管理者が付与する必要があります。

次のステップ

Microsoft ID プラットフォームでの Node.js コンソールデーモンアプリケーションの開発についてさらに詳しく知りたい場合は、複数のパートで構成される次のシナリオシリーズを参照してください。

シナリオ: デーモンアプリケーション

次の方法で共有

チュートリアル:Node.js コンソールデーモンアプリで Microsoft Graph API を呼び出す

前提条件

アプリケーションを登録する

プロジェクトを作成する

認証ロジックを追加する

アプリの登録の詳細を追加する

Web API を呼び出すメソッドを追加する

アプリをテストする

アプリケーションの動作

次のステップ

フィードバック

その他のリソース

次の方法で共有

チュートリアル:Node.js コンソール デーモン アプリで Microsoft Graph API を呼び出す

前提条件

アプリケーションを登録する

プロジェクトを作成する

認証ロジックを追加する

アプリの登録の詳細を追加する

Web API を呼び出すメソッドを追加する

アプリをテストする

アプリケーションの動作

次のステップ

フィードバック

その他のリソース

チュートリアル:Node.js コンソールデーモンアプリで Microsoft Graph API を呼び出す