Auth0
@mastra/auth-auth0 パッケージは、Auth0 を使用した Mastra の認証を提供します。Auth0 が発行した JWT トークンを使用して受信リクエストを検証し、auth オプションで Mastra サーバーと統合します。
前提条件前提条件への直接リンク
この例では Auth0 認証を使用します。次の準備を行ってください。
- auth0.com で Auth0 アカウントを作成する
- Auth0 Dashboard で Application を設定する
- Auth0 Dashboard で識別子(audience)を指定して API を設定する
- Application で許可するコールバック URL、Web オリジン、ログアウト URL を設定する
AUTH0_DOMAIN=your-tenant.auth0.com
AUTH0_AUDIENCE=your-api-identifier
ドメインは Auth0 Dashboard の Applications > Settings で確認できます。audience は Auth0 Dashboard > APIs で設定した API の識別子です。
詳しい設定手順については、使用するプラットフォーム向けの Auth0 クイックスタートを参照してください。
インストールインストールへの直接リンク
MastraAuthAuth0 クラスを使用するには、事前に @mastra/auth-auth0 パッケージをインストールする必要があります。
- npm
- pnpm
- Yarn
- Bun
npm install @mastra/auth-auth0@latest
pnpm add @mastra/auth-auth0@latest
yarn add @mastra/auth-auth0@latest
bun add @mastra/auth-auth0@latest
使用例使用例への直接リンク
環境変数を使用する基本的な構成環境変数を使用する基本的な構成への直接リンク
import { Mastra } from '@mastra/core'
import { MastraAuthAuth0 } from '@mastra/auth-auth0'
export const mastra = new Mastra({
server: {
auth: new MastraAuthAuth0(),
},
})
カスタム設定カスタム設定への直接リンク
import { Mastra } from '@mastra/core'
import { MastraAuthAuth0 } from '@mastra/auth-auth0'
export const mastra = new Mastra({
server: {
auth: new MastraAuthAuth0({
domain: process.env.AUTH0_DOMAIN,
audience: process.env.AUTH0_AUDIENCE,
}),
},
})
設定設定への直接リンク
ユーザー認可ユーザー認可への直接リンク
デフォルトでは、MastraAuthAuth0 は指定した audience に対する有効な Auth0 トークンを持つすべての認証済みユーザーを許可します。トークンの検証では、次の点が確認されます。
- トークンが Auth0 によって正しく署名されている
- トークンの有効期限が切れていない
- トークンの audience が設定した audience と一致する
- トークンの発行者が Auth0 ドメインと一致する
ユーザー認可をカスタマイズするには、カスタムの authorizeUser 関数を指定します。
import { MastraAuthAuth0 } from '@mastra/auth-auth0'
const auth0Provider = new MastraAuthAuth0({
authorizeUser: async user => {
// Custom authorization logic
return user.email?.endsWith('@yourcompany.com') || false
},
})
利用可能なすべての設定オプションについては、MastraAuthAuth0 を参照してください。
クライアント側の設定クライアント側の設定への直接リンク
Auth0 認証を使用する場合は、Auth0 React SDK を設定してユーザーを認証し、取得したアクセストークンを Mastra へのリクエストに渡す必要があります。
Auth0 React SDK の設定Auth0 React SDK の設定への直接リンク
まず、アプリケーションに Auth0 React SDK をインストールして設定します。
- npm
- pnpm
- Yarn
- Bun
npm install @auth0/auth0-react
pnpm add @auth0/auth0-react
yarn add @auth0/auth0-react
bun add @auth0/auth0-react
import React from 'react'
import { Auth0Provider } from '@auth0/auth0-react'
const Auth0ProviderWithHistory = ({ children }) => {
return (
<Auth0Provider
domain={process.env.REACT_APP_AUTH0_DOMAIN}
clientId={process.env.REACT_APP_AUTH0_CLIENT_ID}
authorizationParams={{
redirect_uri: window.location.origin,
audience: process.env.REACT_APP_AUTH0_AUDIENCE,
scope: 'read:current_user update:current_user_metadata',
}}
>
{children}
</Auth0Provider>
)
}
export default Auth0ProviderWithHistory
アクセストークンの取得アクセストークンの取得への直接リンク
Auth0 React SDK を使用してユーザーを認証し、アクセストークンを取得します。
import { useAuth0 } from '@auth0/auth0-react'
export const useAuth0Token = () => {
const { getAccessTokenSilently } = useAuth0()
const getAccessToken = async () => {
const token = await getAccessTokenSilently()
return token
}
return { getAccessToken }
}
その他の認証方法や設定オプションについては、Auth0 React SDK ドキュメントを参照してください。
MastraClient の設定configuring-mastraclientへの直接リンク
auth を有効にすると、MastraClient から送信するすべてのリクエストで、Authorization ヘッダーに有効な Auth0 アクセストークンを含める必要があります。
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 を参照してください。
認証済みリクエストの送信認証済みリクエストの送信への直接リンク
Auth0 アクセストークンを使って MastraClient を設定すると、認証済みリクエストを送信できます。
- React
- cURL
import React, { useState } from 'react'
import { useAuth0 } from '@auth0/auth0-react'
import { MastraClient } from '@mastra/client-js'
export const MastraApiTest = () => {
const { getAccessTokenSilently } = useAuth0()
const [result, setResult] = useState(null)
const callMastraApi = async () => {
const token = await getAccessTokenSilently()
const mastra = new MastraClient({
baseUrl: 'http://localhost:4111',
headers: {
Authorization: `Bearer ${token}`,
},
})
const weatherAgent = mastra.getAgent('weatherAgent')
const response = await weatherAgent.generate("What's the weather like in New York")
setResult(response.text)
}
return (
<div>
<button onClick={callMastraApi}>Test Mastra API</button>
{result && (
<div className="result">
<h6>Result:</h6>
<pre>{result}</pre>
</div>
)}
</div>
)
}
curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your-auth0-access-token>" \
-d '{
"messages": "Weather in London"
}'