zero-auth

Appearance

zero-auth API Documentation v1.6.0

zero-auth API Documentation / ResolvedConfig

Interface: ResolvedConfig ​

Defined in: packages/zero-auth/src/types/auth.ts:220

Fully resolved config after defaults are applied. Used internally.

Properties ​

accessExpiresIn ​

accessExpiresIn: string

Defined in: packages/zero-auth/src/types/auth.ts:236

accessSecret? ​

optional accessSecret?: string

Defined in: packages/zero-auth/src/types/auth.ts:227

algorithm ​

algorithm: SupportedAlgorithm

Defined in: packages/zero-auth/src/types/auth.ts:221

cookies ​

cookies: Required<CookieConfig> & object

Defined in: packages/zero-auth/src/types/auth.ts:238

Type Declaration ​

options ​

options: CookieOptions

csrf ​

csrf: object

Defined in: packages/zero-auth/src/types/auth.ts:239

cookieName ​

cookieName: string

headerName ​

headerName: string

methods ​

methods: string[]

secret? ​

optional secret?: string

csrfSecret? ​

optional csrfSecret?: string

Defined in: packages/zero-auth/src/types/auth.ts:234

isAsymmetric ​

isAsymmetric: boolean

Defined in: packages/zero-auth/src/types/auth.ts:222

isJwks ​

isJwks: boolean

Defined in: packages/zero-auth/src/types/auth.ts:224

isVerifierOnly ​

isVerifierOnly: boolean

Defined in: packages/zero-auth/src/types/auth.ts:223

jwks? ​

optional jwks?: RemoteJwksConfig

Defined in: packages/zero-auth/src/types/auth.ts:226

jwksUri? ​

optional jwksUri?: string

Defined in: packages/zero-auth/src/types/auth.ts:225

jwt ​

jwt: JwtValidationConfig

Defined in: packages/zero-auth/src/types/auth.ts:235

keyId? ​

optional keyId?: string

Defined in: packages/zero-auth/src/types/auth.ts:233

privateKey? ​

optional privateKey?: KeyInput

Defined in: packages/zero-auth/src/types/auth.ts:229

publicKey? ​

optional publicKey?: KeyInput

Defined in: packages/zero-auth/src/types/auth.ts:230

refreshExpiresIn ​

refreshExpiresIn: string

Defined in: packages/zero-auth/src/types/auth.ts:237

refreshOptions ​

refreshOptions: object

Defined in: packages/zero-auth/src/types/auth.ts:245

consumeRefreshToken? ​

optional consumeRefreshToken?: (oldJti, ctx?) => boolean | Promise<boolean>

Parameters ​
oldJti ​

string

ctx? ​

RefreshTokenContext

Returns ​

boolean | Promise<boolean>

isRevoked? ​

optional isRevoked?: (jti) => boolean | Promise<boolean>

Parameters ​
jti ​

string

Returns ​

boolean | Promise<boolean>

onRefreshReuse? ​

optional onRefreshReuse?: (ctx) => void | Promise<void>

Parameters ​
ctx ​

RefreshReuseContext

Returns ​

void | Promise<void>

registerRefreshToken? ​

optional registerRefreshToken?: (newJti, ctx) => void | Promise<void>

Parameters ​
newJti ​

string

ctx ​

RefreshTokenContext

Returns ​

void | Promise<void>

resolveUser? ​

optional resolveUser?: (claims, ctx) => JwtPayload | Promise<JwtPayload | null> | null

Parameters ​
claims ​

JwtPayload

ctx ​

RefreshTokenContext

Returns ​

JwtPayload | Promise<JwtPayload | null> | null

revokeRefreshToken? ​

optional revokeRefreshToken?: (oldJti, ctx?) => void | Promise<void>

Parameters ​
oldJti ​

string

ctx? ​

RefreshTokenContext

Returns ​

void | Promise<void>

rotate ​

rotate: boolean

refreshPrivateKey? ​

optional refreshPrivateKey?: KeyInput

Defined in: packages/zero-auth/src/types/auth.ts:231

refreshPublicKey? ​

optional refreshPublicKey?: KeyInput

Defined in: packages/zero-auth/src/types/auth.ts:232

refreshSecret? ​

optional refreshSecret?: string

Defined in: packages/zero-auth/src/types/auth.ts:228