クイックスタート: Teams ユーザー向けのアクセス トークンを設定して管理する

前提条件の設定

• お使いのオペレーティング システムに対応した最新バージョンの .NET SDK。

最終的なコード

このクイックスタートの最終的なコードは GitHub にあります。

設定

新しい C# アプリケーションを作成する

コンソール ウィンドウ (cmd、PowerShell、Bash など) で、dotnet new コマンドを使用し、CommunicationAccessTokensQuickstart という名前で新しいコンソール アプリを作成します。 このコマンドにより、1 つのソース ファイルを使用する単純な "Hello World" C# プロジェクトが作成されます。Program.cs。

dotnet new console -o CommunicationAccessTokensQuickstart

新しく作成したアプリ フォルダーにディレクトリを変更し、dotnet build コマンドを使用してアプリケーションをコンパイルします。

cd CommunicationAccessTokensQuickstart
dotnet build

パッケージをインストールする

まだアプリケーション ディレクトリにいる間に、dotnet add package コマンドを使用して、.NET 用の Azure Communication Services ID ライブラリ パッケージをインストールします。

dotnet add package Azure.Communication.Identity
dotnet add package Microsoft.Identity.Client

アプリのフレームワークを設定する

プロジェクト ディレクトリで次の操作を行います。

1. テキスト エディターで、Program.cs ファイルを開きます
2. Azure.Communication.Identity 名前空間を含めるように using ディレクティブを追加します
3. 非同期コードをサポートするように Main メソッドの宣言を更新します

次のコードを使用して開始します。

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Communication.Identity;
using Microsoft.Identity.Client;

namespace CommunicationAccessTokensQuickstart
{
    class Program
    {
        static async Task Main(string[] args)
        {
            Console.WriteLine("Azure Communication Services - Teams Access Tokens Quickstart");

            // Quickstart code goes here
        }
    }
}

手順 1: MSAL ライブラリを使って Microsoft Entra ユーザー トークンとオブジェクト ID を受け取る

トークン交換フローの最初の手順は、Microsoft.Identity.Client を使用して、Teams ユーザーのトークンを取得することです。 以下のコードは、環境変数 AAD_CLIENT_ID と AAD_TENANT_ID から、Microsoft Entra クライアント ID とテナント ID を取得します。 Fabrikam のテナント内のユーザーに対応するオブジェクト ID (oid) 要求を取得し、userObjectId 変数を初期化できるように、AAD_TENANT_ID 環境変数に基づいて適切な権限を持つ MSAL クライアントを構成することが不可欠です。

// This code demonstrates how to fetch an AAD client ID and tenant ID 
// from an environment variable.
string appId = Environment.GetEnvironmentVariable("AAD_CLIENT_ID");
string tenantId = Environment.GetEnvironmentVariable("AAD_TENANT_ID");
string authority = $"https://login.microsoftonline.com/{tenantId}";
string redirectUri = "http://localhost";

// Create an instance of PublicClientApplication
var aadClient = PublicClientApplicationBuilder
                .Create(appId)
                .WithAuthority(authority)
                .WithRedirectUri(redirectUri)
                .Build();

List<string> scopes = new() {
    "https://auth.msft.communication.azure.com/Teams.ManageCalls",
    "https://auth.msft.communication.azure.com/Teams.ManageChats"
};

// Retrieve the AAD token and object ID of a Teams user
var result = await aadClient
                        .AcquireTokenInteractive(scopes)
                        .ExecuteAsync();
string teamsUserAadToken =  result.AccessToken;
string userObjectId =  result.UniqueId;

手順 2: CommunicationIdentityClient を初期化する

接続文字列を使用して CommunicationIdentityClient を初期化します。 次のコードは、 COMMUNICATION_SERVICES_CONNECTION_STRING という名前の環境変数からリソースの接続文字列を取得します。 リソースの接続文字列を管理する方法について確認してください。

Main メソッドに次のコードを追加します。

// This code demonstrates how to fetch your connection string
// from an environment variable.
string connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");
var client = new CommunicationIdentityClient(connectionString);

手順 3: Teams ユーザーの Microsoft Entra アクセス トークンを通信 ID アクセス トークンに交換する

GetTokenForTeamsUser メソッドを使用して、Azure Communication Services SDK で使用できる Teams ユーザーのアクセス トークンを発行します。

var options = new GetTokenForTeamsUserOptions(teamsUserAadToken, appId, userObjectId);
var accessToken = await client.GetTokenForTeamsUserAsync(options);
Console.WriteLine($"Token: {accessToken.Value.Token}");

コードの実行

アプリケーション ディレクトリから dotnet run コマンドを使用してアプリケーションを実行します。

dotnet run

前提条件の設定

• Node.js アクティブ LTS およびメンテナンス LTS バージョン (8.11.1 および 10.14.1 を推奨)。

最終的なコード

このクイックスタートの最終的なコードは GitHub にあります。

設定

新しい Node.js アプリケーションを作成する

ターミナルまたはコマンド ウィンドウを開き、アプリ用の新しいディレクトリを作成し、そこに移動します。

mkdir communication-access-tokens-quickstart && cd communication-access-tokens-quickstart

既定の設定で npm init -y を実行して、package.json ファイルを作成します。

npm init -y

パッケージをインストールする

npm install コマンドを使用して、JavaScript 用の Azure Communication Services Identity SDK をインストールします。

npm install @azure/communication-identity@latest --save
npm install @azure/msal-node --save
npm install express --save
npm install dotenv --save

--save オプションを使用すると、package.json ファイル内の依存関係としてライブラリが表示されます。

アプリのフレームワークを設定する

プロジェクト ディレクトリで次の操作を行います。

1. コード エディターで新しいテキスト ファイルを開きます

2. CommunicationIdentityClient を読み込むための require 呼び出しを追加します

3. 基本的な例外処理を含め、プログラムの構造を作成します

   const { CommunicationIdentityClient } = require('@azure/communication-identity');    
   const { PublicClientApplication, CryptoProvider } = require('@azure/msal-node');
   const express = require("express");
   
   // You will need to set environment variables in .env
   const SERVER_PORT = process.env.PORT || 80;
   const REDIRECT_URI = `http://localhost:${SERVER_PORT}/redirect`;
   const clientId = process.env['AAD_CLIENT_ID'];
   const tenantId = process.env['AAD_TENANT_ID'];
   
   // Quickstart code goes here
   
   app.listen(SERVER_PORT, () => console.log(`Communication access token application started on ${SERVER_PORT}!`))
   
   

4. access-tokens-quickstart ディレクトリに新しいファイルを issue-communication-access-token.js として保存します。

手順 1: MSAL ライブラリを使って Microsoft Entra ユーザー トークンとオブジェクト ID を受け取る

トークン交換フローの最初の手順は、Microsoft.Identity.Client を使用して、Teams ユーザーのトークンを取得することです。 以下のコードは、環境変数 AAD_CLIENT_ID と AAD_TENANT_ID から、Microsoft Entra クライアント ID とテナント ID を取得します。 Fabrikam のテナント内のユーザーに対応するオブジェクト ID (oid) 要求を取得し、userObjectId 変数を初期化できるように、AAD_TENANT_ID 環境変数に基づいて適切な権限を持つ MSAL クライアントを構成することが不可欠です。

// Create configuration object that will be passed to MSAL instance on creation.
const msalConfig = {
    auth: {
        clientId: clientId,
        authority: `https://login.microsoftonline.com/${tenantId}`,
    }
};

// Create an instance of PublicClientApplication
const pca = new PublicClientApplication(msalConfig);
const provider = new CryptoProvider();

const app = express();

let pkceVerifier = "";
const scopes = [
            "https://auth.msft.communication.azure.com/Teams.ManageCalls",
            "https://auth.msft.communication.azure.com/Teams.ManageChats"
        ];

app.get('/', async (req, res) => {
    // Generate PKCE Codes before starting the authorization flow
    const {verifier, challenge} = await provider.generatePkceCodes();
    pkceVerifier = verifier;
    
    const authCodeUrlParameters = {
        scopes: scopes,
        redirectUri: REDIRECT_URI,
        codeChallenge: challenge, 
        codeChallengeMethod: "S256"
    };
    // Get url to sign user in and consent to scopes needed for application
    pca.getAuthCodeUrl(authCodeUrlParameters).then((response) => {
        res.redirect(response);
    }).catch((error) => console.log(JSON.stringify(error)));
});

app.get('/redirect', async (req, res) => {
    // Create request parameters object for acquiring the AAD token and object ID of a Teams user
    const tokenRequest = {
        code: req.query.code,
        scopes: scopes,
        redirectUri: REDIRECT_URI,
        codeVerifier: pkceVerifier,
    };
    // Retrieve the AAD token and object ID of a Teams user
    pca.acquireTokenByCode(tokenRequest).then(async(response) => {
        console.log("Response:", response);
        let teamsUserAadToken = response.accessToken;
        let userObjectId = response.uniqueId;
        //TODO: the following code snippets go here
        res.sendStatus(200);
    }).catch((error) => {
        console.log(error);
        res.status(500).send(error);
    });
});

手順 2: CommunicationIdentityClient を初期化する

接続文字列を使用して CommunicationIdentityClient をインスタンス化します。 次のコードは、 COMMUNICATION_SERVICES_CONNECTION_STRING という名前の環境変数からリソースの接続文字列を取得します。 リソースの接続文字列を管理する方法について確認してください。

then メソッドに次のコードを追加します。

// This code demonstrates how to fetch your connection string
// from an environment variable.
const connectionString = process.env['COMMUNICATION_SERVICES_CONNECTION_STRING'];

// Instantiate the identity client
const identityClient = new CommunicationIdentityClient(connectionString);

手順 3: Teams ユーザーの Microsoft Entra アクセス トークンを通信 ID アクセス トークンに交換する

getTokenForTeamsUser メソッドを使用して、Azure Communication Services SDK で使用できる Teams ユーザーのアクセス トークンを発行します。

//Exchange the Azure AD access token of the Teams User for a Communication Identity access token
let accessToken = await identityClient.getTokenForTeamsUser({
    teamsUserAadToken: teamsUserAadToken,
    clientId: clientId,
    userObjectId: userObjectId,
  });
console.log("Token:", accessToken);

コードの実行

コンソール プロンプトから、issue-communication-access-token.js ファイルが格納されているディレクトリに移動し、次の node コマンドを実行してアプリを実行します。

node ./issue-communication-access-token.js

前提条件の設定

• Python 3.8 以降。

最終的なコード

このクイックスタートの最終的なコードは GitHub にあります。

設定

新しい Python アプリケーションを作成する

1. ターミナルまたはコマンド ウィンドウを開き、自分のアプリ用に新しいディレクトリを作成し、そこに移動します。

   mkdir communication-access-tokens-quickstart && cd communication-access-tokens-quickstart
   

2. テキスト エディターを使用して、exchange-communication-access-tokens.py という名前のファイルをプロジェクトのルート ディレクトリに作成し、基本的な例外処理を含むプログラムの構造を追加します。 このクイックスタートのソース コードはすべて、以降のセクションでこのファイルに追加します。

   import os
   from azure.communication.identity import CommunicationIdentityClient, CommunicationUserIdentifier
   from msal.application import PublicClientApplication
   
   try:
      print("Azure Communication Services - Access Tokens Quickstart")
      # Quickstart code goes here
   except Exception as ex:
      print(f"Exception: {ex}")
   

パッケージをインストールする

引き続きアプリケーション ディレクトリで、pip install コマンドを使用して、Python 用の Azure Communication Services ID SDK パッケージをインストールします。

pip install azure-communication-identity
pip install msal

手順 1: MSAL ライブラリを使って Microsoft Entra ユーザー トークンとオブジェクト ID を受け取る

トークン交換フローの最初の手順は、Microsoft.Identity.Client を使用して、Teams ユーザーのトークンを取得することです。 Azure portal で、"モバイルおよびデスクトップ アプリケーション" のリダイレクト URI を http://localhost として構成します。 以下のコードは、環境変数 AAD_CLIENT_ID と AAD_TENANT_ID から、Microsoft Entra クライアント ID とテナント ID を取得します。 Fabrikam のテナント内のユーザーに対応するオブジェクト ID (oid) 要求を取得し、user_object_id 変数を初期化できるように、AAD_TENANT_ID 環境変数に基づいて適切な権限を持つ MSAL クライアントを構成することが不可欠です。

# This code demonstrates how to fetch your Azure AD client ID and tenant ID
# from an environment variable.
client_id = os.environ["AAD_CLIENT_ID"]
tenant_id = os.environ["AAD_TENANT_ID"]
authority = "https://login.microsoftonline.com/%s" % tenant_id

# Create an instance of PublicClientApplication
app = PublicClientApplication(client_id, authority=authority)

scopes = [ 
"https://auth.msft.communication.azure.com/Teams.ManageCalls",
"https://auth.msft.communication.azure.com/Teams.ManageChats"
 ]

# Retrieve the AAD token and object ID of a Teams user
result = app.acquire_token_interactive(scopes)
aad_token =  result["access_token"]
user_object_id = result["id_token_claims"]["oid"] 

手順 2: CommunicationIdentityClient を初期化する

接続文字列を使用して CommunicationIdentityClient をインスタンス化します。 次のコードは、 COMMUNICATION_SERVICES_CONNECTION_STRING という名前の環境変数からリソースの接続文字列を取得します。 リソースの接続文字列を管理する方法について確認してください。

このコードを try ブロック内に追加します。

# This code demonstrates how to fetch your connection string
# from an environment variable.
connection_string = os.environ["COMMUNICATION_SERVICES_CONNECTION_STRING"]

# Instantiate the identity client
client = CommunicationIdentityClient.from_connection_string(connection_string)

手順 3: Teams ユーザーの Microsoft Entra アクセス トークンを通信 ID アクセス トークンに交換する

get_token_for_teams_user メソッドを使用して、Azure Communication Services SDK で使用できる Teams ユーザーのアクセス トークンを発行します。

# Exchange the Azure AD access token of the Teams User for a Communication Identity access token
token_result = client.get_token_for_teams_user(aad_token, client_id, user_object_id)
print("Token: " + token_result.token)

コードの実行

コンソール プロンプトから、exchange-teams-access-tokens.py ファイルが格納されているディレクトリに移動し、次の python コマンドを実行してアプリを実行します。

python ./exchange-communication-access-tokens.py

前提条件の設定

• Java Development Kit (JDK) バージョン 8 以降。
• Apache Maven。

最終的なコード

このクイックスタートの最終的なコードは GitHub にあります。

設定

新しい Java アプリケーションを作成する

ターミナルまたはコマンド ウィンドウを開きます。 Java アプリケーションを作成するディレクトリに移動します。 次のコマンドを実行して、maven-archetype-quickstart テンプレートから Java プロジェクトを生成します。

mvn archetype:generate -DgroupId=com.communication.quickstart -DartifactId=communication-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

"generate" タスクによって、artifactId と同じ名前のディレクトリが作成されたことがわかります。 このディレクトリの下の src/main/java ディレクトリにはプロジェクトのソース コードが含まれており、src/test/java directory にはテスト ソースが含まれており、pom.xml ファイルはプロジェクトのプロジェクト オブジェクト モデル (POM) です。

パッケージをインストールする

テキスト エディターで pom.xml ファイルを開きます。 依存関係のグループに、次の dependency 要素を追加します。

<dependencies>
    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-communication-identity</artifactId>
        <version>[1.2.0,)</version>
    </dependency>
    <dependency>
      <groupId>com.microsoft.azure</groupId>
      <artifactId>msal4j</artifactId>
      <version>1.11.0</version>
    </dependency>
</dependencies>

アプリのフレームワークを設定する

プロジェクト ディレクトリで次の操作を行います。

1. /src/main/java/com/communication/quickstart ディレクトリに移動します
2. エディターで App.java ファイルを開きます
3. System.out.println("Hello world!"); ステートメントを置き換えます
4. import ディレクティブを追加します

次のコードを使用して開始します。

package com.communication.quickstart;

import com.azure.communication.identity.CommunicationIdentityClient;
import com.azure.communication.identity.CommunicationIdentityClientBuilder;
import com.azure.communication.identity.models.GetTokenForTeamsUserOptions;
import com.azure.core.credential.AccessToken;
import com.microsoft.aad.msal4j.IAuthenticationResult;
import com.microsoft.aad.msal4j.InteractiveRequestParameters;
import com.microsoft.aad.msal4j.PublicClientApplication;

import java.net.URI;
import java.util.HashSet;
import java.util.Set;

public class App
{
    public static void main( String[] args ) throws Exception
    {
        System.out.println("Azure Communication Services - Communication access token Quickstart");
        // Quickstart code goes here
    }
}

手順 1: MSAL ライブラリを使って Microsoft Entra ユーザー トークンとオブジェクト ID を受け取る

トークン交換フローの最初の手順は、Microsoft.Identity.Client を使用して、Teams ユーザーのトークンを取得することです。 Fabrikam のテナント内のユーザーに対応するオブジェクト ID (oid) 要求を取得し、userObjectId 変数を初期化できるように、tenantId 変数に基づいて適切な権限を持つ MSAL クライアントを構成することが不可欠です。

// You need to provide your Azure AD client ID and tenant ID
String appId = "<contoso_application_id>";
String tenantId = "<contoso_tenant_id>";
String authority = "https://login.microsoftonline.com/" + tenantId;

// Create an instance of PublicClientApplication
PublicClientApplication pca = PublicClientApplication.builder(appId)
        .authority(authority)
        .build();

String redirectUri = "http://localhost";
Set<String> scope = new HashSet<String>();
scope.add("https://auth.msft.communication.azure.com/Teams.ManageCalls");
scope.add("https://auth.msft.communication.azure.com/Teams.ManageChats");

// Create an instance of InteractiveRequestParameters for acquiring the AAD token and object ID of a Teams user
InteractiveRequestParameters parameters = InteractiveRequestParameters
                    .builder(new URI(redirectUri))
                    .scopes(scope)
                    .build();

// Retrieve the AAD token and object ID of a Teams user
IAuthenticationResult result = pca.acquireToken(parameters).get();
String teamsUserAadToken = result.accessToken();
String[] accountIds = result.account().homeAccountId().split("\\.");
String userObjectId = accountIds[0];
System.out.println("Teams token: " + teamsUserAadToken);

手順 2: CommunicationIdentityClient を初期化する

リソースのアクセス キーとエンドポイントを使用して、CommunicationIdentityClient をインスタンス化します。 リソースの接続文字列を管理する方法について確認してください。 加えて、クライアントは、com.azure.core.http.HttpClient インターフェイスを実装する任意のカスタム HTTP クライアントを使用して初期化できます。

main メソッドに次のコードを追加します。

//You can find your connection string from your resource in the Azure portal
String connectionString = "<connection_string>";

// Instantiate the identity client
CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
    .connectionString(connectionString)
    .buildClient();

手順 3: Teams ユーザーの Microsoft Entra アクセス トークンを通信 ID アクセス トークンに交換する

getTokenForTeamsUser メソッドを使用して、Azure Communication Services SDK で使用できる Teams ユーザーのアクセス トークンを発行します。

// Exchange the Azure AD access token of the Teams User for a Communication Identity access token
GetTokenForTeamsUserOptions options = new GetTokenForTeamsUserOptions(teamsUserAadToken, appId, userObjectId);
var accessToken = communicationIdentityClient.getTokenForTeamsUser(options);
System.out.println("Token: " + accessToken.getToken());

コードの実行

pom.xml ファイルが格納されているディレクトリに移動し、mvn compile コマンドを使用してプロジェクトをコンパイルします。

次に、パッケージをビルドします。

mvn package

次の mvn コマンドを実行して、アプリを実行します。

mvn exec:java -Dexec.mainClass="com.communication.quickstart.App" -Dexec.cleanupDaemonThreads=false