JWT

DefaultJWT

継承

• Record<string, unknown>

プロパティ

email?

optional email: null | string;

exp?

optional exp: number;

iat?

optional iat: number;

jti?

optional jti: string;

name?

optional name: null | string;

picture?

optional picture: null | string;

sub?

optional sub: string;

GetTokenParams<R>

継承

• GetTokenParamsBase

型パラメーター

プロパティ

cookieName?

optional cookieName: string;

JWTがCookieにある場合、getToken()が検索する名前。

decode()?

optional decode: (params) => Awaitable<null | JWT>;

パラメーター

戻り値

Awaitable<null | JWT>

logger?

optional logger: LoggerInstance | Console;

raw?

optional raw: R;

getToken()がこの値がtrueに設定されている場合、生のJWTを返します。

デフォルト

false

req

req: Request | {
  headers: Headers | Record<string, string>;
};

CookieまたはAuthorizationヘッダーにJWTを含むリクエスト。

salt?

optional salt: string;

継承元

GetTokenParamsBase.salt

secret?

optional secret: string | string[];

継承元

GetTokenParamsBase.secret

secureCookie?

optional secureCookie: boolean;

NEXTAUTH_URLのURLがhttp://である場合、または設定されていない場合（開発またはテストインスタンスなど）は、プレフィックスなしの名前を使用します。

JWT

JWTセッションを使用する場合、jwtコールバックによって返されます。

jwtコールバック

継承

• Record<string, unknown>.DefaultJWT

プロパティ

email?

optional email: null | string;

継承元

DefaultJWT.email

exp?

optional exp: number;

継承元

DefaultJWT.exp

iat？

optional iat: number;

継承元

DefaultJWT.iat

jti？

optional jti: string;

継承元

DefaultJWT.jti

name？

optional name: null | string;

継承元

DefaultJWT.name

picture？

optional picture: null | string;

継承元

DefaultJWT.picture

sub？

optional sub: string;

継承元

DefaultJWT.sub

JWTDecodeParams

プロパティ

salt

salt: string;

JWTの暗号化秘密鍵を導出するためにsecretと組み合わせて使用されます。

secret

secret: string | string[];

JWTの暗号化秘密鍵を導出するためにsaltと組み合わせて使用されます。

注記

秘密鍵の配列を渡すこともできます。その場合、JWTを正常に復号化できる最初の秘密鍵が使用されます。これは、既存のセッションを無効にすることなく秘密鍵をローテーションする場合に便利です。新しい秘密鍵は配列の先頭に追加する必要があります。これにより、すべての新しいセッションで使用されます。

token？

optional token: string;

復号化するAuth.js発行のJWT。

JWTEncodeParams<Payload>

型パラメータ

プロパティ

maxAge？

optional maxAge: number;

Auth.js発行のJWTの最大有効期間（秒単位）。

デフォルト

30 * 24 * 60 * 60 // 30 days

salt

salt: string;

JWTの暗号化秘密鍵を導出するためにsecretと組み合わせて使用されます。

secret

secret: string | string[];

JWTの暗号化秘密鍵を導出するためにsaltと組み合わせて使用されます。

token？

optional token: Payload;

JWTペイロード。

JWTOptions

プロパティ

decode()

decode: (params) => Awaitable<null | JWT>;

Auth.js発行のJWTの復号化を制御するためにこのメソッドをオーバーライドします。

パラメータ

戻り値

Awaitable<null | JWT>

encode()

encode: (params) => Awaitable<string>;

Auth.js発行のJWTのエンコードを制御するためにこのメソッドをオーバーライドします。

パラメータ

戻り値

Awaitable<string>

maxAge

maxAge: number;

Auth.js発行のJWTの最大有効期間（秒単位）。

デフォルト

30 * 24 * 60 * 60 // 30 days

decode()

decode<Payload>(params): Promise<Payload | null>

Auth.js発行のJWTを復号化します。

型パラメータ

パラメータ

戻り値

Promise<Payload | null>

encode()

encode<Payload>(params): Promise<string>

JWTを発行します。デフォルトでは、JWTは「A256CBC-HS512」を使用して暗号化されます。

型パラメータ

パラメータ

戻り値

Promise<string>

getToken()

getToken<R>(params): Promise<R extends true ? string : JWT | null>

Auth.jsリクエスト（req）を受け取り、Auth.js発行のJWTのペイロードまたは生のJWT文字列を返します。JWTは、CookieまたはAuthorizationヘッダーのいずれかで検索されます。

型パラメータ

パラメータ

戻り値

Promise<R extends true ? string : JWT | null>