Class FrejaEndpoint

Freja eID operations.

Index

Constructors

Methods

auth authStatus backchannelAuth backchannelSign cancelAuth cancelSign sign signStatus waitForAuth waitForSign

Constructors

constructor

new FrejaEndpoint(client: IdkollenClient): FrejaEndpoint
Parameters
- client: IdkollenClient
Returns FrejaEndpoint
- Defined in src/endpoints/freja.ts:14

Methods

auth

auth(req: FrejaAuthRequest): Promise<FrejaStatus>
Start a Freja eID authentication session.
Parameters
- req: FrejaAuthRequest
Returns Promise<FrejaStatus>
- Defined in src/endpoints/freja.ts:17

authStatus

authStatus(id: string): Promise<FrejaStatus>
Poll the current status of a Freja eID authentication session.
Parameters
- id: string
Returns Promise<FrejaStatus>
- Defined in src/endpoints/freja.ts:37

backchannelAuth

backchannelAuth(req: FrejaBackchannelAuthRequest): Promise<FrejaStatus>
Start a Freja eID backchannel authentication session.
Parameters
- req: FrejaBackchannelAuthRequest
Returns Promise<FrejaStatus>
- Defined in src/endpoints/freja.ts:22

backchannelSign

backchannelSign(req: FrejaBackchannelSignRequest): Promise<FrejaStatus>
Start a Freja eID backchannel signing session.
Parameters
- req: FrejaBackchannelSignRequest
Returns Promise<FrejaStatus>
- Defined in src/endpoints/freja.ts:32

cancelAuth

cancelAuth(id: string): Promise<void>
Cancel a Freja eID authentication session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/freja.ts:47

cancelSign

cancelSign(id: string): Promise<void>
Cancel a Freja eID signing session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/freja.ts:52

sign

sign(req: FrejaSignRequest): Promise<FrejaStatus>
Start a Freja eID signing session.
Parameters
- req: FrejaSignRequest
Returns Promise<FrejaStatus>
- Defined in src/endpoints/freja.ts:27

signStatus

signStatus(id: string): Promise<FrejaStatus>
Poll the current status of a Freja eID signing session.
Parameters
- id: string
Returns Promise<FrejaStatus>
- Defined in src/endpoints/freja.ts:42

waitForAuth

waitForAuth(id: string, opts?: PollOptions): Promise<FrejaStatus>
Poll until the authentication session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<FrejaStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/freja.ts:60

waitForSign

waitForSign(id: string, opts?: PollOptions): Promise<FrejaStatus>
Poll until the signing session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<FrejaStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/freja.ts:85