providers/zitadel
組み込みのZitadel統合機能です。
ZitadelProfile
プロファイルコールバックを使用した場合に ZITADEL から返されるユーザープロファイル。標準クレームのリファレンスはこちらを参照してください。ZITADEL API にアクセスしたり、追加情報が必要な場合は、対応するスコープを追加してください。
拡張
Record<string,any>
プロパティ
amr
amr: string;aud
aud: string;auth_time
auth_time: number;azp
azp: string;email: string;email_verified
email_verified: boolean;exp
exp: number;family_name
family_name: string;gender
gender: string;given_name
given_name: string;iat
iat: number;iss
iss: string;jti
jti: string;locale
locale: string;name
name: string;nbf
nbf: number;phone
phone: string;phone_verified
phone_verified: boolean;picture
picture: string;preferred_username
preferred_username: string;sub
sub: string;default()
default<P>(options): OIDCConfig<P>ZITADEL ログインをページに追加します。
セットアップ
コールバック URL
https://example.com/api/auth/callback/zitadel構成
import { Auth } from "@auth/core"
import ZITADEL from "@auth/core/providers/zitadel"
const request = new Request(origin)
const response = await Auth(request, {
providers: [
ZITADEL({
clientId: ZITADEL_CLIENT_ID,
clientSecret: ZITADEL_CLIENT_SECRET,
}),
],
})リソース
注記
デフォルトでは、Auth.js は ZITADEL プロバイダーが Open ID Connect 仕様に基づいていると想定します。
認証情報の作成時に使用するリダイレクト URI には、完全なドメインを含め、コールバックパスで終わる必要があります。例:
- 本番環境の場合:
https://{YOUR_DOMAIN}/api/auth/callback/zitadel - 開発環境の場合:
http://localhost:3000/api/auth/callback/zitadel
ローカル開発でのリダイレクトを許可するには、ZITADEL コンソールで開発モードを有効にしてください。
💡
ZITADEL プロバイダーには、デフォルト構成が付属しています。ユースケースに合わせてデフォルトをオーバーライドするには、組み込みの OAuth プロバイダーのカスタマイズを参照してください。
💡
ZITADEL は、プロファイルに email_verified ブール値プロパティも返します。このプロパティを使用して、認証済みアカウントを持つユーザーへのアクセスを制限できます。
const options = {
...
callbacks: {
async signIn({ account, profile }) {
if (account.provider === "zitadel") {
return profile.email_verified;
}
return true; // Do different verification for other providers that don't have `email_verified`
},
}
...
}型パラメータ
| 型パラメータ |
|---|
P は ZitadelProfile を拡張します |
パラメータ
| パラメータ | 型 |
|---|---|
options | OAuthUserConfig<P> |
戻り値
OIDCConfig<P>