Interface Authentication<R, U, T>

Authentication is repsonsible to establish and delete a user session.

Params

U the user type

Params

T the ticket type

interface Authentication<R = any, U = any, T = any> {
    login(request: R): Promise<Session<U, T>>;
    logout(): Promise<void>;
    start(): Promise<Session<U, T> | null>;
}

Type Parameters

R = any
any information requires to trigger the login
U = any
T = any

Implemented by

OIDCAuthentication

Index

Methods

login(request: R): Promise<Session<U, T>>
request a session
Parameters
- request: R
  any request information.
Returns Promise<Session<U, T>>
a valid session
- Defined in libs/portal/src/lib/session/authentication.ts:36

logout

logout(): Promise<void>
logout

Returns Promise<void>
- Defined in libs/portal/src/lib/session/authentication.ts:41

start

start(): Promise<Session<U, T> | null>
setup the authentication and possibly restore a valid session.

Returns Promise<Session<U, T> | null>
- Defined in libs/portal/src/lib/session/authentication.ts:29

Interface Authentication<R, U, T>

Params

Params

Type Parameters

Implemented by

Index

Methods

Methods

Parameters

Returns Promise<Session<U, T>>

logout

Returns Promise<void>

start

Returns Promise<Session<U, T> | null>

Settings

On This Page