Skip to content

Documentation


Documentation / @u-net/server / DirectLoginWebAdapterOptions

Interface: DirectLoginWebAdapterOptions

Defined in: webAdapters.ts:31

Properties

accountStore

accountStore: DirectLoginAccountStore

Defined in: webAdapters.ts:35


exchange?

optional exchange?: (session) => Promise<Record<string, unknown> | Response>

Defined in: webAdapters.ts:37

Parameters

session
expiresAtIso

string

requestRef

string

scopedUserId

string

sessionId

string

Returns

Promise<Record<string, unknown> | Response>


inboxStore?

optional inboxStore?: OfficialMessagingInboxStore

Defined in: webAdapters.ts:36


origin

origin: string

Defined in: webAdapters.ts:33


service

service: object

Defined in: webAdapters.ts:34

approve()

approve(approval): Promise<void>

Parameters
approval

DirectLoginApproval

Returns

Promise<void>

completeSessionExchange()

completeSessionExchange(sessionId): Promise<void>

Parameters
sessionId

string

Returns

Promise<void>

createChallenge()

createChallenge(input): Promise<DirectLoginChallenge>

Parameters
input
approvalUrl

string

challengeUrl

string

Returns

Promise<DirectLoginChallenge>

exchangeSession()

exchangeSession(sessionId): Promise<DirectLoginSession>

Parameters
sessionId

string

Returns

Promise<DirectLoginSession>

getChallenge()

getChallenge(requestRef): Promise<DirectLoginChallenge>

Parameters
requestRef

string

Returns

Promise<DirectLoginChallenge>

poll()

poll(requestRef): Promise<{ session?: DirectLoginSession; state: "pending" | "approved" | "consumed" | "expired"; }>

Parameters
requestRef

string

Returns

Promise<{ session?: DirectLoginSession; state: "pending" | "approved" | "consumed" | "expired"; }>

prepareSessionExchange()

prepareSessionExchange(sessionId): Promise<DirectLoginSession>

Parameters
sessionId

string

Returns

Promise<DirectLoginSession>

retire()

retire(retirement): Promise<void>

Parameters
retirement

ServiceAccountRetirement

Returns

Promise<void>


serviceId

serviceId: string

Defined in: webAdapters.ts:32