"export=": {
ACCOUNT_SET_COOKIE: string;
ACCOUNT_TICKET_PARAM: string;
accountChoiceNeeded: (
req: any,
) => { accounts: number; hint: string; reason: string };
ACCOUNTS_PATH: string;
accountsAct: (
req: any,
res: AuthnAnswering<
"selectAccount"
| "useAnotherAccount"
| "forgetAccount",
>,
record: any,
body: any,
) => void;
accountSessionsOf: (req: any) => any[];
accountSetCookieName: () => string;
accountsView: (req: any, record: any) => any;
accountTicketFor: (req: any, target: any, hint: any) => any;
adoptRelyingPartySession: (spec: any) => SessionRow;
adoptSessionRisk: (id: string, risk: any) => boolean;
afterAccountSignOut: (
req: any,
res: any,
) => { defaultEnded: boolean; defaultNow: any };
afterSignIn: (
res: any,
go: () => void,
refuse: (why: string) => void,
) => void;
ANONYMOUS_USERNAME: string;
answerJson: <R, S extends number>(
res: R,
status: S,
body: AnswerOf<R, S>,
) => void;
assessSignIn: (
req: any,
username: string,
via: string,
detail?: any,
) => Promise<any>;
auditActorSessionOf: (req: any) => string;
Authn: typeof Authn;
AUTHN_API_PATH: string;
backdateAuthentication: (session: any, seconds: any) => void;
BACKUP_CODE_PATH: string;
beginAuthentication: (opts: any) => string;
beginSecondFactorAfterFederation: (req: any, res: any, spec: any) => any;
beginSecondFactorAfterWallet: (
req: any,
res: any,
record: any,
username: string,
outcome: any,
assessment?: any,
opts?: { first?: string },
) => any;
bindingSessionOf: (
req: any,
pick: any,
) => { others: boolean; session: any };
browserAccounts: (
req: any,
) => { accounts: any[]; enabled: boolean; max: number };
CARD_CSS: string;
claimStepForBrowser: (
id: unknown,
sessionId: string,
kind?: string,
) => boolean;
clearSessionCookie: (res: any, cookieName?: any) => void;
clearSiteDataAfterSignOut: (req: any, res: any) => void;
clientDisplay: (application: unknown) => any;
completeAuthentication: (res: any, record: any) => void;
consoleSession: (
req: any,
) => {
foreign: boolean;
realm: {
builtin: boolean;
createdAt: any;
description: string;
id: string;
name: string;
overrides: {};
};
session: any;
};
cookieSession: (
req: any,
cookieName: any,
store?: any,
realmId?: any,
) =>
| { error: boolean; id: any; session?: undefined }
| { error?: undefined; id: any; session: any };
cookiesOf: (req: any) => Record<string, any>;
derivedFrom: (parentId: any, store?: any, alsoRealm?: any) => any[];
deviceBindingOf: (session: any) => any;
dropMfaStep: (id: string) => void;
EMAIL_CODE_PATH: string;
EMAIL_LINK_OPEN_PATH: string;
EMAIL_LINK_PATH: string;
endEverySessionIn: (realmId: any, via: any, initiatingEntity?: any) => any;
endRelyingPartySessions: (
surfaceId: string,
fromRealm: string,
about: (user: any, session?: any) => boolean,
via: string,
initiatingEntity: string,
) => number;
endSession: (req: any, res: any, sid?: any) => any;
endSessionById: (id: any, via: any, initiatingEntity?: any) => any;
expectedOriginFor: (base: any, credential: any) => string;
finishEmailFirstFactor: (
req: any,
res: any,
step: any,
kind: string,
) => Promise<any>;
finishEmailSecondFactor: (
req: any,
res: any,
mfaId: string,
step: any,
kind: string,
) => boolean;
finishWithWallet: (req: any, res: any, mfaId: string, outcome: any) => any;
firstAmrFor: (step: any) => string[];
hintAccount: (req: any, hint: any) => void;
hintAccountKey: (req: any, key: any) => void;
holdPresentation: (session: any) => void;
installInstance: (instance: Authn) => void;
instanceOrigin: () => string;
keyForAssertion: (username: any, use: any, presentedId: any) => any;
lastAuthenticatedAt: (session: any) => number;
latestAuthorityOf: (session: any) => string;
liveSessionCountsAsync: (
usernames: any,
) => Promise<{ byUsername: Map<any, any>; people: number }>;
liveSessionPageAsync: (
options?: any,
) => Promise<
| {
authenticated?: undefined;
sessions?: undefined;
total?: undefined;
unauthenticated?: undefined;
unread: boolean;
}
| {
authenticated: number;
sessions: any[];
total: number;
unauthenticated: number;
unread?: undefined;
},
>;
locationOf: (res: any, target: string) => string;
LOGIN_PATH: string;
markPresentationHeld: (session: any, held: any) => void;
MAX_SESSION_EVENTS: number;
mergeSessionRows: (mine: any, theirs: any) => any;
MFA_SETUP_PATH: string;
mfaBackupCodeAct: (
req: any,
res: AuthnAnswering<"spendRecoveryCode">,
mfaId: string,
body: any,
) => Promise<void>;
mfaPasswordAct: (
req: any,
res: AuthnAnswering<"checkFactorPassword">,
mfaId: string,
body: any,
) => Promise<void>;
mfaSetupAct: (
req: any,
res: AuthnAnswering<
| "beginKeyEnrolment"
| "beginAppEnrolment"
| "confirmAppEnrolment"
| "ignoreOffer",
>,
setupId: string,
action: string,
body: any,
) => Promise<void>;
mfaStartOver: (
req: any,
res: AuthnAnswering<"startOver">,
mfaId: string,
) => void;
mfaStepFor: (id: unknown, accepts?: string) => any;
mfaStepTtlMs: () => any;
mfaTotpAct: (
req: any,
res: AuthnAnswering<"checkCode">,
mfaId: string,
body: any,
) => Promise<void>;
mfaView: (req: any, page: string, mfaId: string, key?: string) => any;
mfaWebauthnAct: (
req: any,
res: AuthnAnswering<"finishPasskeyStep">,
mfaId: string,
posted: any,
) => any;
mfaWebauthnOptions: (
req: any,
res: AuthnAnswering<"passkeyStepOptions">,
mfaId: string,
key: string,
lane?: string,
algorithms?: string,
) => void;
mintMfaStep: (step: any) => string;
multipleAccounts: () => boolean;
noteAccountAmbiguous: (req: any, via: any, answer: any) => void;
notePresented: (
session: any,
via: any,
req: any,
application?: any,
) => boolean;
noteSessionChanged: (session: any) => boolean;
originOf: (base: any) => string;
passkeyOptions: (req: any, record: any) => any;
PASSWORD_CHANGE_PATH: string;
PASSWORD_FACTOR_PATH: string;
passwordChangeAct: (
req: any,
res: AuthnAnswering<"changePassword">,
changeId: any,
step: any,
body: any,
) => Promise<void>;
passwordChangeStartOver: (
req: any,
res: AuthnAnswering<"startOverFromPasswordChange">,
changeId: string,
) => void;
passwordChangeStep: (
res: AuthnAnswering<"getPasswordChange">,
changeId: any,
) => any;
passwordChangeView: (changeId: any, step: any) => any;
pendingEndReports: () => number;
pendingFor: (id: any) => any;
pendingForAccounts: (id: any) => any;
pendingTtlMs: () => any;
POST_LOGIN_PATH: string;
postLoginAct: (
req: any,
res: AuthnAnswering<"registerPostLoginPasskey" | "skipPostLoginActivity">,
stepId: string,
action: string,
) => void;
preferredLanguageOf: (username: string) => any;
realmAtSessionCap: () => boolean;
refreshPartners: (record: any) => number;
refuseAccountsUnread: (
req: any,
res: AuthnAnswering<
| "getAccountChoice"
| "selectAccount"
| "useAnotherAccount"
| "forgetAccount",
>,
) => boolean;
refuseAtScreen: (
res: any,
record: any,
error: string,
status?: number,
) => void;
registeredDeviceOf: (session: any) => any;
registerRoutes: (app: any) => void;
relyingPartySessionOf: (req: any, cookie: any, realmId: any) => any;
renewRelyingPartySession: (spec: any) => any;
restartPendingAtHome: (
req: any,
res: AuthnAnswering,
pendingId: string,
fallback: string,
home: string,
) => Promise<void>;
rpIdOf: (base: any) => any;
rpIdProblem: (base: any) => string;
saveMfaStep: (id: string, step: any) => void;
screenAct: (
req: any,
res: AuthnAnswering<
| "signInWithPassword"
| "cancelSignIn"
| "continueAnonymously"
| "continueWithCertificate"
| "signInByEmail"
| "signInWithPasskey",
>,
record: any,
body: any,
) => Promise<void>;
screenProblem: (record: any) => string;
screenView: (req: any, record: any, problem?: string) => any;
SELECT_IDP_PATH: string;
selectIdpView: (req: any, record: any) => any;
SESSION_COOKIE: string;
sessionById: (id: any) => any;
sessionCookieNames: (req: any, sid: any) => boolean;
sessionEnded: (session: any, nowMs?: any) => "" | "expired" | "idle";
sessionIdleTimeoutMs: () => number;
sessionLifetimeMs: () => any;
sessionNamesFactor: (session: any, factor: any) => any;
sessionOf: (req: any, ignoreBinding?: any) => any;
sessions: Map<any, any> & {
countAsync: () => Promise<number>;
countEstimateAsync: () => Promise<{ count: number; exact: boolean }>;
dropHeld: (realmId: string, key: string) => boolean;
lookup: (indexKey: string) => any[];
lookupEntries: (
indexKey: string,
) => { key: any; origin: string; own: boolean; value: any }[];
lookupEntriesAsync: (
indexKey: string,
) => Promise<{ key: any; origin?: string; own?: boolean; value: any }[]>;
newestAsync: (limit: number) => Promise<{ key: any; value: any }[]>;
onDemandLive: () => boolean;
peek: (k: any) => any;
realmMap: (id?: any) => Map<any, any>;
scan: (fn: (value: any, key: any) => void) => void;
scanAsync: (fn: (value: any, key: any) => boolean | void) => Promise<void>;
warm: (keys: any[]) => Promise<void>;
};
sessionsForRelationship: (relationship: any) => any[];
sessionsForRisk: () => any[];
sessionsHeldUnder: (username?: any, subjectId?: any) => any[];
sessionsMatching: (test: any) => any[];
sessionsOf: (username: any) => any[];
sessionStartedAt: (session: any) => number;
sessionView: (session: any) => Session;
sessionWindowOn: () => boolean;
setSessionObserver: (fn: any) => void;
signedInAccounts: (
req: any,
) => {
current: boolean;
displayName: string;
key: string;
sid: string;
sub: string;
username: string;
}[];
SIGNIN_SCRIPT_PATH: string;
signInBundle: () => any;
signInShell: (
req: any,
res: any,
application: string,
person?: string,
) => void;
signOnFactsFor: (
session: any,
) => {
acr: any;
amr: any;
authentications: any;
authTime: number;
deviceBound: any;
fromParent: boolean;
startedAt: number;
};
spendAccountTicket: (req: any) => void;
SPNEGO_PATH: string;
startArrivalSession: (req: any, res: any, via: any) => SessionRow;
startRelyingPartySession: (spec: any) => SessionRow;
startSession: (
res: any,
username: any,
amr: any,
acr: any,
via: any,
detail: any,
) => any;
stepAnswer: (
res: AuthnAnswering,
next: AnswerAt200,
step: string,
id: string,
path: string,
query: string,
) => void;
stepApplication: (name: string, id: string) => string;
stepPagePath: (page: string) => string;
stepRefused: (res: AuthnAnswering, why: string, status?: number) => void;
sweepAccountSets: () => any;
sweepAccountSetsBudgeted: () => Promise<any>;
sweepAccountSetsInSlices: () => Promise<any>;
sweepExpiredSessions: () => number;
sweepExpiredSessionsInSlices: () => Promise<number>;
takePending: (record: any) => void;
tokensExpireAt: (tokens: any) => any;
usernamelessRequired: (record: any) => boolean;
WALLET_PATH: string;
WALLET_WAIT_PATH: string;
warmSessionAsync: (id: any) => Promise<boolean>;
}
Type Declaration
-
ACCOUNT_SET_COOKIE: string
-
ACCOUNT_TICKET_PARAM: string
-
accountChoiceNeeded: (req: any) => { accounts: number; hint: string; reason: string }
-
ACCOUNTS_PATH: string
-
accountsAct: (
req: any,
res: AuthnAnswering<
"selectAccount"
| "useAnotherAccount"
| "forgetAccount",
>,
record: any,
body: any,
) => void
-
accountSessionsOf: (req: any) => any[]
-
accountSetCookieName: () => string
-
accountsView: (req: any, record: any) => any
-
accountTicketFor: (req: any, target: any, hint: any) => any
-
adoptRelyingPartySession: (spec: any) => SessionRow
-
adoptSessionRisk: (id: string, risk: any) => boolean
-
afterAccountSignOut: (req: any, res: any) => { defaultEnded: boolean; defaultNow: any }
-
afterSignIn: (res: any, go: () => void, refuse: (why: string) => void) => void
-
ANONYMOUS_USERNAME: string
-
answerJson: <R, S extends number>(res: R, status: S, body: AnswerOf<R, S>) => void
-
assessSignIn: (req: any, username: string, via: string, detail?: any) => Promise<any>
-
auditActorSessionOf: (req: any) => string
-
Authn: typeof Authn
-
AUTHN_API_PATH: string
-
backdateAuthentication: (session: any, seconds: any) => void
-
BACKUP_CODE_PATH: string
-
beginAuthentication: (opts: any) => string
-
beginSecondFactorAfterFederation: (req: any, res: any, spec: any) => any
-
beginSecondFactorAfterWallet: (
req: any,
res: any,
record: any,
username: string,
outcome: any,
assessment?: any,
opts?: { first?: string },
) => any
-
bindingSessionOf: (req: any, pick: any) => { others: boolean; session: any }
-
browserAccounts: (req: any) => { accounts: any[]; enabled: boolean; max: number }
-
CARD_CSS: string
-
claimStepForBrowser: (id: unknown, sessionId: string, kind?: string) => boolean
-
clearSessionCookie: (res: any, cookieName?: any) => void
-
clearSiteDataAfterSignOut: (req: any, res: any) => void
-
clientDisplay: (application: unknown) => any
-
completeAuthentication: (res: any, record: any) => void
-
consoleSession: (
req: any,
) => {
foreign: boolean;
realm: {
builtin: boolean;
createdAt: any;
description: string;
id: string;
name: string;
overrides: {};
};
session: any;
}
-
cookieSession: (
req: any,
cookieName: any,
store?: any,
realmId?: any,
) =>
| { error: boolean; id: any; session?: undefined }
| { error?: undefined; id: any; session: any }
-
cookiesOf: (req: any) => Record<string, any>
-
derivedFrom: (parentId: any, store?: any, alsoRealm?: any) => any[]
-
deviceBindingOf: (session: any) => any
-
dropMfaStep: (id: string) => void
-
EMAIL_CODE_PATH: string
-
EMAIL_LINK_OPEN_PATH: string
-
EMAIL_LINK_PATH: string
-
endEverySessionIn: (realmId: any, via: any, initiatingEntity?: any) => any
-
endRelyingPartySessions: (
surfaceId: string,
fromRealm: string,
about: (user: any, session?: any) => boolean,
via: string,
initiatingEntity: string,
) => number
-
endSession: (req: any, res: any, sid?: any) => any
-
endSessionById: (id: any, via: any, initiatingEntity?: any) => any
-
expectedOriginFor: (base: any, credential: any) => string
-
finishEmailFirstFactor: (req: any, res: any, step: any, kind: string) => Promise<any>
-
finishEmailSecondFactor: (req: any, res: any, mfaId: string, step: any, kind: string) => boolean
-
finishWithWallet: (req: any, res: any, mfaId: string, outcome: any) => any
-
firstAmrFor: (step: any) => string[]
-
hintAccount: (req: any, hint: any) => void
-
hintAccountKey: (req: any, key: any) => void
-
holdPresentation: (session: any) => void
-
installInstance: (instance: Authn) => void
-
instanceOrigin: () => string
-
keyForAssertion: (username: any, use: any, presentedId: any) => any
-
lastAuthenticatedAt: (session: any) => number
-
latestAuthorityOf: (session: any) => string
-
liveSessionCountsAsync: (usernames: any) => Promise<{ byUsername: Map<any, any>; people: number }>
-
liveSessionPageAsync: (
options?: any,
) => Promise<
| {
authenticated?: undefined;
sessions?: undefined;
total?: undefined;
unauthenticated?: undefined;
unread: boolean;
}
| {
authenticated: number;
sessions: any[];
total: number;
unauthenticated: number;
unread?: undefined;
},
>
-
locationOf: (res: any, target: string) => string
-
LOGIN_PATH: string
-
markPresentationHeld: (session: any, held: any) => void
-
MAX_SESSION_EVENTS: number
-
mergeSessionRows: (mine: any, theirs: any) => any
-
MFA_SETUP_PATH: string
-
mfaBackupCodeAct: (
req: any,
res: AuthnAnswering<"spendRecoveryCode">,
mfaId: string,
body: any,
) => Promise<void>
-
mfaPasswordAct: (
req: any,
res: AuthnAnswering<"checkFactorPassword">,
mfaId: string,
body: any,
) => Promise<void>
-
mfaSetupAct: (
req: any,
res: AuthnAnswering<
| "beginKeyEnrolment"
| "beginAppEnrolment"
| "confirmAppEnrolment"
| "ignoreOffer",
>,
setupId: string,
action: string,
body: any,
) => Promise<void>
-
mfaStartOver: (req: any, res: AuthnAnswering<"startOver">, mfaId: string) => void
-
mfaStepFor: (id: unknown, accepts?: string) => any
-
mfaStepTtlMs: () => any
-
mfaTotpAct: (
req: any,
res: AuthnAnswering<"checkCode">,
mfaId: string,
body: any,
) => Promise<void>
-
mfaView: (req: any, page: string, mfaId: string, key?: string) => any
-
mfaWebauthnAct: (
req: any,
res: AuthnAnswering<"finishPasskeyStep">,
mfaId: string,
posted: any,
) => any
-
mfaWebauthnOptions: (
req: any,
res: AuthnAnswering<"passkeyStepOptions">,
mfaId: string,
key: string,
lane?: string,
algorithms?: string,
) => void
-
mintMfaStep: (step: any) => string
-
multipleAccounts: () => boolean
-
noteAccountAmbiguous: (req: any, via: any, answer: any) => void
-
notePresented: (session: any, via: any, req: any, application?: any) => boolean
-
noteSessionChanged: (session: any) => boolean
-
originOf: (base: any) => string
-
passkeyOptions: (req: any, record: any) => any
-
PASSWORD_CHANGE_PATH: string
-
PASSWORD_FACTOR_PATH: string
-
passwordChangeAct: (
req: any,
res: AuthnAnswering<"changePassword">,
changeId: any,
step: any,
body: any,
) => Promise<void>
-
passwordChangeStartOver: (
req: any,
res: AuthnAnswering<"startOverFromPasswordChange">,
changeId: string,
) => void
-
passwordChangeStep: (res: AuthnAnswering<"getPasswordChange">, changeId: any) => any
-
passwordChangeView: (changeId: any, step: any) => any
-
pendingEndReports: () => number
-
pendingFor: (id: any) => any
-
pendingForAccounts: (id: any) => any
-
pendingTtlMs: () => any
-
POST_LOGIN_PATH: string
-
postLoginAct: (
req: any,
res: AuthnAnswering<"registerPostLoginPasskey" | "skipPostLoginActivity">,
stepId: string,
action: string,
) => void
-
preferredLanguageOf: (username: string) => any
-
realmAtSessionCap: () => boolean
-
refreshPartners: (record: any) => number
-
refuseAccountsUnread: (
req: any,
res: AuthnAnswering<
| "getAccountChoice"
| "selectAccount"
| "useAnotherAccount"
| "forgetAccount",
>,
) => boolean
-
refuseAtScreen: (res: any, record: any, error: string, status?: number) => void
-
registeredDeviceOf: (session: any) => any
-
registerRoutes: (app: any) => void
-
relyingPartySessionOf: (req: any, cookie: any, realmId: any) => any
-
renewRelyingPartySession: (spec: any) => any
-
restartPendingAtHome: (
req: any,
res: AuthnAnswering,
pendingId: string,
fallback: string,
home: string,
) => Promise<void>
-
rpIdOf: (base: any) => any
-
rpIdProblem: (base: any) => string
-
saveMfaStep: (id: string, step: any) => void
-
screenAct: (
req: any,
res: AuthnAnswering<
| "signInWithPassword"
| "cancelSignIn"
| "continueAnonymously"
| "continueWithCertificate"
| "signInByEmail"
| "signInWithPasskey",
>,
record: any,
body: any,
) => Promise<void>
-
screenProblem: (record: any) => string
-
screenView: (req: any, record: any, problem?: string) => any
-
SELECT_IDP_PATH: string
-
selectIdpView: (req: any, record: any) => any
-
SESSION_COOKIE: string
-
sessionById: (id: any) => any
-
sessionCookieNames: (req: any, sid: any) => boolean
-
sessionEnded: (session: any, nowMs?: any) => "" | "expired" | "idle"
-
sessionIdleTimeoutMs: () => number
-
sessionLifetimeMs: () => any
-
sessionNamesFactor: (session: any, factor: any) => any
-
sessionOf: (req: any, ignoreBinding?: any) => any
-
sessions: Map<any, any> & {
countAsync: () => Promise<number>;
countEstimateAsync: () => Promise<{ count: number; exact: boolean }>;
dropHeld: (realmId: string, key: string) => boolean;
lookup: (indexKey: string) => any[];
lookupEntries: (
indexKey: string,
) => { key: any; origin: string; own: boolean; value: any }[];
lookupEntriesAsync: (
indexKey: string,
) => Promise<{ key: any; origin?: string; own?: boolean; value: any }[]>;
newestAsync: (limit: number) => Promise<{ key: any; value: any }[]>;
onDemandLive: () => boolean;
peek: (k: any) => any;
realmMap: (id?: any) => Map<any, any>;
scan: (fn: (value: any, key: any) => void) => void;
scanAsync: (fn: (value: any, key: any) => boolean | void) => Promise<void>;
warm: (keys: any[]) => Promise<void>;
}
-
sessionsForRelationship: (relationship: any) => any[]
-
sessionsForRisk: () => any[]
-
sessionsHeldUnder: (username?: any, subjectId?: any) => any[]
-
sessionsMatching: (test: any) => any[]
-
sessionsOf: (username: any) => any[]
-
sessionStartedAt: (session: any) => number
-
sessionView: (session: any) => Session
-
sessionWindowOn: () => boolean
-
setSessionObserver: (fn: any) => void
-
signedInAccounts: (
req: any,
) => {
current: boolean;
displayName: string;
key: string;
sid: string;
sub: string;
username: string;
}[]
-
SIGNIN_SCRIPT_PATH: string
-
signInBundle: () => any
-
signInShell: (req: any, res: any, application: string, person?: string) => void
-
signOnFactsFor: (
session: any,
) => {
acr: any;
amr: any;
authentications: any;
authTime: number;
deviceBound: any;
fromParent: boolean;
startedAt: number;
}
-
spendAccountTicket: (req: any) => void
-
SPNEGO_PATH: string
-
startArrivalSession: (req: any, res: any, via: any) => SessionRow
-
startRelyingPartySession: (spec: any) => SessionRow
-
startSession: (res: any, username: any, amr: any, acr: any, via: any, detail: any) => any
-
stepAnswer: (
res: AuthnAnswering,
next: AnswerAt200,
step: string,
id: string,
path: string,
query: string,
) => void
-
stepApplication: (name: string, id: string) => string
-
stepPagePath: (page: string) => string
-
stepRefused: (res: AuthnAnswering, why: string, status?: number) => void
-
sweepAccountSets: () => any
-
sweepAccountSetsBudgeted: () => Promise<any>
-
sweepAccountSetsInSlices: () => Promise<any>
-
sweepExpiredSessions: () => number
-
sweepExpiredSessionsInSlices: () => Promise<number>
-
takePending: (record: any) => void
-
tokensExpireAt: (tokens: any) => any
-
usernamelessRequired: (record: any) => boolean
-
WALLET_PATH: string
-
WALLET_WAIT_PATH: string
-
warmSessionAsync: (id: any) => Promise<boolean>
The authentication service: the sign-in screen, the second factors and the sign-on session every protocol reads.
The functions forward to the instance the composition root installs.