Documentation

---

Documentation / @u-net/server / createDirectLoginService

Function: createDirectLoginService()

createDirectLoginService(options): object

Defined in: directLogin.ts:127

Parameters

options

DirectLoginServiceOptions

Returns

object

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>