Skip to content

Documentation


Documentation / @u-net/server / createDirectLoginService

Function: createDirectLoginService() ​

createDirectLoginService(options): object

Defined in: directLogin.ts:185

Parameters ​

options ​

DirectLoginServiceOptions

Returns ​

approve() ​

approve(approval): Promise<void>

Parameters ​

approval ​

DirectLoginApproval

Returns ​

Promise<void>

createChallenge() ​

createChallenge(input): Promise<DirectLoginChallenge>

Parameters ​

input ​
approvalUrl ​

string

challengeUrl ​

string

redemptionSecret ​

string

Returns ​

Promise<DirectLoginChallenge>

exchangeSession() ​

exchangeSession(requestRef, redemptionSecret): Promise<DirectLoginSession>

Parameters ​

requestRef ​

string

redemptionSecret ​

string

Returns ​

Promise<DirectLoginSession>

getChallenge() ​

getChallenge(requestRef): Promise<DirectLoginChallenge>

Parameters ​

requestRef ​

string

Returns ​

Promise<DirectLoginChallenge>

poll() ​

poll(requestRef, redemptionSecret): Promise<{ state: "pending" | "approved" | "consumed" | "expired"; }>

Parameters ​

requestRef ​

string

redemptionSecret ​

string

Returns ​

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

retire() ​

retire(retirement): Promise<void>

Parameters ​

retirement ​

ServiceAccountRetirement

Returns ​

Promise<void>

retryRetirementCleanup() ​

retryRetirementCleanup(): Promise<{ completed: number; pending: number; }>

Run durably from a provider worker/cron; callbacks must be idempotent.

Returns ​

Promise<{ completed: number; pending: number; }>