Class MitIdEndpoint

MitID operations.

Index

Constructors

Methods

auth authStatus backchannelAuth cancelAuth cancelSign sign signStatus waitForAuth waitForSign

Constructors

constructor

new MitIdEndpoint(client: IdkollenClient): MitIdEndpoint
Parameters
- client: IdkollenClient
Returns MitIdEndpoint
- Defined in src/endpoints/mitid.ts:13

Methods

auth

auth(req: MitIdAuthRequest): Promise<MitIdStatus>
Start a MitID authentication session.
Parameters
- req: MitIdAuthRequest
Returns Promise<MitIdStatus>
- Defined in src/endpoints/mitid.ts:16

authStatus

authStatus(id: string): Promise<MitIdStatus>
Poll the current status of a MitID authentication session.
Parameters
- id: string
Returns Promise<MitIdStatus>
- Defined in src/endpoints/mitid.ts:31

backchannelAuth

backchannelAuth(req: MitIdBackchannelAuthRequest): Promise<MitIdStatus>
Start a MitID backchannel authentication session.
Parameters
- req: MitIdBackchannelAuthRequest
Returns Promise<MitIdStatus>
- Defined in src/endpoints/mitid.ts:21

cancelAuth

cancelAuth(id: string): Promise<void>
Cancel a MitID authentication session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/mitid.ts:41

cancelSign

cancelSign(id: string): Promise<void>
Cancel a MitID signing session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/mitid.ts:46

sign

sign(req: MitIdSignRequest): Promise<MitIdStatus>
Start a MitID signing session.
Parameters
- req: MitIdSignRequest
Returns Promise<MitIdStatus>
- Defined in src/endpoints/mitid.ts:26

signStatus

signStatus(id: string): Promise<MitIdStatus>
Poll the current status of a MitID signing session.
Parameters
- id: string
Returns Promise<MitIdStatus>
- Defined in src/endpoints/mitid.ts:36

waitForAuth

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

waitForSign

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