AuthEngine
Defined in: types.ts:102
Properties
Section titled “Properties”config
Section titled “config”
readonlyconfig:AuthConfig
Defined in: types.ts:103
Methods
Section titled “Methods”authenticate()
Section titled “authenticate()”authenticate(
strategyName,data,params):Promise<AuthResult>
Defined in: types.ts:115
Parameters
Section titled “Parameters”strategyName
Section titled “strategyName”string
Record<string, unknown>
params
Section titled “params”Returns
Section titled “Returns”Promise<AuthResult>
createJwt()
Section titled “createJwt()”createJwt(
payload,options?):string
Defined in: types.ts:104
Parameters
Section titled “Parameters”payload
Section titled “payload”options?
Section titled “options?”expiresIn?
Section titled “expiresIn?”string | number
Returns
Section titled “Returns”string
createTokenPair()
Section titled “createTokenPair()”createTokenPair(
sub,accessExtra?):Promise<TokenPair>
Defined in: types.ts:113
Issue an access + refresh token pair for a subject. The refresh token carries
{ sub, type: "refresh", jti }, is signed with refreshExpiresIn, and its
jti is recorded in the RefreshTokenStore before the pair is returned.
All strategies must issue refresh tokens through this helper so jti
bookkeeping stays uniform.
Parameters
Section titled “Parameters”string
accessExtra?
Section titled “accessExtra?”Record<string, unknown>
Returns
Section titled “Returns”Promise<TokenPair>
isAgentTokenValid()
Section titled “isAgentTokenValid()”isAgentTokenValid(
id):Promise<boolean>
Defined in: types.ts:130
True unless the agent token id was revoked, or was never issued on this engine’s store.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
issueAgentToken()
Section titled “issueAgentToken()”issueAgentToken(
scope,delegatingUserId,options?):Promise<IssuedAgentToken>
Defined in: types.ts:122
Mint a short-lived, capability-scoped agent token delegated from delegatingUserId. The
token is a JWT carrying { sub: <agent id>, type: "agent", scope, delegatingUserId } — only
authorizeAgent() accepts it, never authenticate("jwt"). Recorded in the AgentTokenStore
so it can be revoked before its natural expiry via revokeAgentToken.
Parameters
Section titled “Parameters”delegatingUserId
Section titled “delegatingUserId”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<IssuedAgentToken>
registerStrategy()
Section titled “registerStrategy()”registerStrategy(
strategy):void
Defined in: types.ts:114
Parameters
Section titled “Parameters”strategy
Section titled “strategy”Returns
Section titled “Returns”void
revokeAgentToken()
Section titled “revokeAgentToken()”revokeAgentToken(
id):Promise<void>
Defined in: types.ts:128
Revoke one agent token immediately, independent of its JWT expiry.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
verifyJwt()
Section titled “verifyJwt()”verifyJwt(
token):JwtPayload
Defined in: types.ts:105
Parameters
Section titled “Parameters”string