MastraAuthWorkos クラス

MastraAuthWorkos クラスは、WorkOS を用いて Mastra の認証を提供します。WorkOS のアクセストークンで受信リクエストを検証し、experimental_auth オプションを通じて Mastra サーバーと統合します。

前提条件

この例では WorkOS 認証を使用します。以下を実施してください:

workos.com で WorkOS アカウントを作成する
WorkOS ダッシュボードでアプリケーションを設定する
リダイレクト URI と許可ドメイン（オリジン）を設定する
必要に応じて組織（Organizations）を作成し、ユーザーのロールを設定する

.env


WORKOS_API_KEY=sk_live_...
WORKOS_CLIENT_ID=client_...

注意: API キーとクライアント ID は、WorkOS Dashboard の「API Keys」と「Applications」セクションでそれぞれ確認できます。

詳細なセットアップ手順については、ご利用のプラットフォーム向けの WorkOS ドキュメントを参照してください。

インストール

MastraAuthWorkos クラスを使用する前に、@mastra/auth-workos パッケージをインストールしておく必要があります。


npm install @mastra/auth-workos@latest

使い方の例

環境変数を使った基本的な使用方法

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { MastraAuthWorkos } from '@mastra/auth-workos';
 
export const mastra = new Mastra({
  // ..
  server: {
    experimental_auth: new MastraAuthWorkos(),
  },
});

カスタム設定

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { MastraAuthWorkos } from '@mastra/auth-workos';
 
export const mastra = new Mastra({
  // ..
  server: {
    experimental_auth: new MastraAuthWorkos({
      apiKey: process.env.WORKOS_API_KEY,
      clientId: process.env.WORKOS_CLIENT_ID
    }),
  },
});

構成

ユーザー認可

デフォルトでは、MastraAuthWorkos は認証済みユーザーが所属するいずれかの組織で「admin」ロールを持っているかどうかを確認します。認可の流れは次のとおりです:

ユーザー ID を用いて、そのユーザーの組織メンバーシップを取得する
メンバーシップからすべてのロールを抽出する
いずれかのロールのスラッグが「admin」かどうかを確認する
少なくとも 1 つの組織でユーザーが admin ロールを持っている場合にのみアクセスを許可する

ユーザー認可をカスタマイズするには、カスタムの authorizeUser 関数を指定します:

src/mastra/auth.ts


import { MastraAuthWorkos } from '@mastra/auth-workos';
 
const workosAuth = new MastraAuthWorkos({
  apiKey: process.env.WORKOS_API_KEY,
  clientId: process.env.WORKOS_CLIENT_ID,
  authorizeUser: async (user) => {
    return !!user;
  },
});

利用可能な設定オプションの一覧は、MastraAuthWorkos の API リファレンスをご覧ください。

クライアント側のセットアップ

WorkOS 認証を利用する場合は、認可コードをアクセストークンに交換するための WorkOS の認証フローを実装し、そのトークンを Mastra のリクエストで使用する必要があります。

WorkOS SDK のインストール

まず、アプリケーションに WorkOS SDK をインストールします。


npm install @workos-inc/node

認可コードをアクセストークンに交換する

ユーザーが WorkOS の認証フローを完了し、認可コードを持って戻ってきたら、そのコードをアクセストークンに交換します。

lib/auth.ts


import { WorkOS } from '@workos-inc/node';
 
const workos = new WorkOS(process.env.WORKOS_API_KEY);
 
export const authenticateWithWorkos = async (code: string, clientId: string) => {
  const authenticationResponse = await workos.userManagement.authenticateWithCode({
    code,
    clientId,
  });
 
  return authenticationResponse.accessToken;
};

追加の認証方法や設定オプションについては、WorkOS User Management のドキュメントを参照してください。

`MastraClient` の設定

experimental_auth を有効にすると、MastraClient によるすべてのリクエストで、Authorization ヘッダーに有効な WorkOS アクセストークンを含める必要があります。

lib/mastra/mastra-client.ts


import { MastraClient } from "@mastra/client-js";
 
export const createMastraClient = (accessToken: string) => {
  return new MastraClient({
    baseUrl: "https://<mastra-api-url>",
    headers: {
      Authorization: `Bearer ${accessToken}`
    }
  });
};

注: Authorization ヘッダーでは、アクセストークンの前に Bearer を付ける必要があります。

さらに詳しい設定オプションについては、Mastra Client SDK を参照してください。

認証済みリクエストの実行

MastraClient に WorkOS のアクセストークンを設定すると、認証済みリクエストを送信できます:

src/api/agents.ts


import { WorkOS } from '@workos-inc/node';
import { MastraClient } from '@mastra/client-js';
 
const workos = new WorkOS(process.env.WORKOS_API_KEY);
 
export const callMastraWithWorkos = async (code: string, clientId: string) => {
  const authenticationResponse = await workos.userManagement.authenticateWithCode({
    code,
    clientId,
  });
 
  const token = authenticationResponse.accessToken;
 
  const mastra = new MastraClient({
    baseUrl: "http://localhost:4111",
    headers: {
      Authorization: `Bearer ${token}`,
    },
  });
 
  const weatherAgent = mastra.getAgent("weatherAgent");
  const response = await weatherAgent.generate({
    messages: "What's the weather like in Nairobi",
  });
 
  return response.text;
};

MastraAuthWorkos クラス

前提条件

この例では WorkOS 認証を使用します。以下を実施してください:

workos.com で WorkOS アカウントを作成する
WorkOS ダッシュボードでアプリケーションを設定する
リダイレクト URI と許可ドメイン（オリジン）を設定する
必要に応じて組織（Organizations）を作成し、ユーザーのロールを設定する

.env


WORKOS_API_KEY=sk_live_...
WORKOS_CLIENT_ID=client_...

注意: API キーとクライアント ID は、WorkOS Dashboard の「API Keys」と「Applications」セクションでそれぞれ確認できます。

詳細なセットアップ手順については、ご利用のプラットフォーム向けの WorkOS ドキュメントを参照してください。

インストール

MastraAuthWorkos クラスを使用する前に、@mastra/auth-workos パッケージをインストールしておく必要があります。


npm install @mastra/auth-workos@latest

使い方の例

環境変数を使った基本的な使用方法

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { MastraAuthWorkos } from '@mastra/auth-workos';
 
export const mastra = new Mastra({
  // ..
  server: {
    experimental_auth: new MastraAuthWorkos(),
  },
});

カスタム設定

src/mastra/index.ts


import { Mastra } from "@mastra/core/mastra";
import { MastraAuthWorkos } from '@mastra/auth-workos';
 
export const mastra = new Mastra({
  // ..
  server: {
    experimental_auth: new MastraAuthWorkos({
      apiKey: process.env.WORKOS_API_KEY,
      clientId: process.env.WORKOS_CLIENT_ID
    }),
  },
});

構成

ユーザー認可

ユーザー ID を用いて、そのユーザーの組織メンバーシップを取得する
メンバーシップからすべてのロールを抽出する
いずれかのロールのスラッグが「admin」かどうかを確認する
少なくとも 1 つの組織でユーザーが admin ロールを持っている場合にのみアクセスを許可する

ユーザー認可をカスタマイズするには、カスタムの authorizeUser 関数を指定します:

src/mastra/auth.ts


import { MastraAuthWorkos } from '@mastra/auth-workos';
 
const workosAuth = new MastraAuthWorkos({
  apiKey: process.env.WORKOS_API_KEY,
  clientId: process.env.WORKOS_CLIENT_ID,
  authorizeUser: async (user) => {
    return !!user;
  },
});

利用可能な設定オプションの一覧は、MastraAuthWorkos の API リファレンスをご覧ください。

クライアント側のセットアップ

WorkOS SDK のインストール

まず、アプリケーションに WorkOS SDK をインストールします。


npm install @workos-inc/node

認可コードをアクセストークンに交換する

ユーザーが WorkOS の認証フローを完了し、認可コードを持って戻ってきたら、そのコードをアクセストークンに交換します。

lib/auth.ts


import { WorkOS } from '@workos-inc/node';
 
const workos = new WorkOS(process.env.WORKOS_API_KEY);
 
export const authenticateWithWorkos = async (code: string, clientId: string) => {
  const authenticationResponse = await workos.userManagement.authenticateWithCode({
    code,
    clientId,
  });
 
  return authenticationResponse.accessToken;
};

追加の認証方法や設定オプションについては、WorkOS User Management のドキュメントを参照してください。

`MastraClient` の設定

lib/mastra/mastra-client.ts


import { MastraClient } from "@mastra/client-js";
 
export const createMastraClient = (accessToken: string) => {
  return new MastraClient({
    baseUrl: "https://<mastra-api-url>",
    headers: {
      Authorization: `Bearer ${accessToken}`
    }
  });
};

注: Authorization ヘッダーでは、アクセストークンの前に Bearer を付ける必要があります。

さらに詳しい設定オプションについては、Mastra Client SDK を参照してください。

認証済みリクエストの実行

MastraClient に WorkOS のアクセストークンを設定すると、認証済みリクエストを送信できます:

src/api/agents.ts


import { WorkOS } from '@workos-inc/node';
import { MastraClient } from '@mastra/client-js';
 
const workos = new WorkOS(process.env.WORKOS_API_KEY);
 
export const callMastraWithWorkos = async (code: string, clientId: string) => {
  const authenticationResponse = await workos.userManagement.authenticateWithCode({
    code,
    clientId,
  });
 
  const token = authenticationResponse.accessToken;
 
  const mastra = new MastraClient({
    baseUrl: "http://localhost:4111",
    headers: {
      Authorization: `Bearer ${token}`,
    },
  });
 
  const weatherAgent = mastra.getAgent("weatherAgent");
  const response = await weatherAgent.generate({
    messages: "What's the weather like in Nairobi",
  });
 
  return response.text;
};

MastraAuthWorkos クラス

前提条件

インストール

使い方の例

環境変数を使った基本的な使用方法

カスタム設定

構成

ユーザー認可

クライアント側のセットアップ

WorkOS SDK のインストール

認可コードをアクセストークンに交換する

MastraClient の設定

認証済みリクエストの実行

MastraAuthWorkos クラス

前提条件

インストール

使い方の例

環境変数を使った基本的な使用方法

カスタム設定

構成

ユーザー認可

クライアント側のセットアップ

WorkOS SDK のインストール

認可コードをアクセストークンに交換する

MastraClient の設定

認証済みリクエストの実行

`MastraClient` の設定

`MastraClient` の設定