Class KavenSSOServer

Hierarchy

KavenSSO
- KavenSSOServer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KavenSSOServer(secret: string, options?: ISSOServerOption): KavenSSOServer

Overrides KavenSSO.constructor
- Defined in src/KavenSSO/KavenSSOServer.ts:64
Parameters
- secret: string
- Optional options: ISSOServerOption
Returns KavenSSOServer

Properties

EnableLog

EnableLog: boolean = false

Readonly LoginPath

LoginPath: string = "/login"

Readonly LoginSessionSet

LoginSessionSet: Set<string>

Server logged in sessions

Readonly ParameterName

ParameterName: ISSOParameterName = DefaultSSOParameterName

Readonly SSOPath

SSOPath: string = "/sso"

Readonly Secret

Secret: string

Readonly TokenName

TokenName: string = "KAVEN-UNIFORM-SSO-TOKEN"

Methods

GetClient

GetClient(token: string): undefined | ISSOClientForServer

- Defined in src/KavenSSO/KavenSSOServer.ts:109
Parameters
- token: string
Returns undefined | ISSOClientForServer

GetClients

GetClients(appID: string, sessionID?: string): ISSOClientForServer[]

- Defined in src/KavenSSO/KavenSSOServer.ts:82
Parameters
- appID: string
- Optional sessionID: string
Returns ISSOClientForServer[]

GetClientsByServerSessionID

GetClientsByServerSessionID(serverSessionID: string): ISSOClientForServer[]

- Defined in src/KavenSSO/KavenSSOServer.ts:98
Parameters
- serverSessionID: string
Returns ISSOClientForServer[]

GetRedirectToClientURL

GetRedirectToClientURL(client?: ISSOClientForServer): Promise<undefined | string>

- Defined in src/KavenSSO/KavenSSOServer.ts:239
Parameters
- Optional client: ISSOClientForServer
Returns Promise<undefined | string>

Logout

Logout(serverSessionID: string, ignoreToken?: string): Promise<void>

- Defined in src/KavenSSO/KavenSSOServer.ts:260
Parameters
- serverSessionID: string
- Optional ignoreToken: string
Returns Promise<void>

MakeNotifyURL

MakeNotifyURL(client: ISSOClientForServer, action: SSOAction, data?: string): undefined | Promise<string>

- Defined in src/KavenSSO/KavenSSOServer.ts:208
Parameters
- client: ISSOClientForServer
- action: SSOAction
- Optional data: string
Returns undefined | Promise<string>

MakeRedirectURL

MakeRedirectURL(client: ISSOClientForServer): Promise<undefined | string>

- Defined in src/KavenSSO/KavenSSOServer.ts:224
Parameters
- client: ISSOClientForServer
Returns Promise<undefined | string>

Verify

Verify(originalUrl: string, userID?: string, loginSessionID?: string): Promise<undefined | ISSOServerVerifyResult>

- Defined in src/KavenSSO/KavenSSOServer.ts:119
Parameters
- originalUrl: string
- Optional userID: string
- Optional loginSessionID: string
  
  If defined, a new client will be created
Returns Promise<undefined | ISSOServerVerifyResult>

Generated using TypeDoc