Class KavenSSOServer

Hierarchy

KavenSSO
- KavenSSOServer

Index

Constructors

Properties

EnableLog LoginPath LoginSessionSet ParameterName SSOPath Secret TokenName

Methods

GetClient GetClients GetClientsByServerSessionID GetRedirectToClientURL Logout MakeNotifyURL MakeRedirectURL Verify

Constructors

constructor

new KavenSSOServer(secret: string, options?: ISSOServerOption): KavenSSOServer
Parameters
- secret: string
- Optional options: ISSOServerOption
Returns KavenSSOServer
Overrides KavenSSO.constructor
- Defined in src/net/sso/KavenSSOServer.ts:65

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
Parameters
- token: string
Returns undefined | ISSOClientForServer
- Defined in src/net/sso/KavenSSOServer.ts:110

GetClients

GetClients(appID: string, sessionID?: string): ISSOClientForServer[]
Parameters
- appID: string
- Optional sessionID: string
Returns ISSOClientForServer[]
- Defined in src/net/sso/KavenSSOServer.ts:83

GetClientsByServerSessionID

GetClientsByServerSessionID(serverSessionID: string): ISSOClientForServer[]
Parameters
- serverSessionID: string
Returns ISSOClientForServer[]
- Defined in src/net/sso/KavenSSOServer.ts:99

GetRedirectToClientURL

GetRedirectToClientURL(client?: ISSOClientForServer): Promise<undefined | string>
Parameters
- Optional client: ISSOClientForServer
Returns Promise<undefined | string>
- Defined in src/net/sso/KavenSSOServer.ts:240

Logout

Logout(serverSessionID: string, ignoreToken?: string): Promise<void>
Parameters
- serverSessionID: string
- Optional ignoreToken: string
Returns Promise<void>
- Defined in src/net/sso/KavenSSOServer.ts:261

MakeNotifyURL

MakeNotifyURL(client: ISSOClientForServer, action: SSOAction, data?: string): undefined | Promise<string>
Parameters
- client: ISSOClientForServer
- action: SSOAction
- Optional data: string
Returns undefined | Promise<string>
- Defined in src/net/sso/KavenSSOServer.ts:209

MakeRedirectURL

MakeRedirectURL(client: ISSOClientForServer): Promise<undefined | string>
Parameters
- client: ISSOClientForServer
Returns Promise<undefined | string>
- Defined in src/net/sso/KavenSSOServer.ts:225

Verify

Verify(originalUrl: string, userID?: string, loginSessionID?: string): Promise<undefined | ISSOServerVerifyResult>
Parameters
- originalUrl: string
- Optional userID: string
- Optional loginSessionID: string
  
  If defined, a new client will be created
Returns Promise<undefined | ISSOServerVerifyResult>
- Defined in src/net/sso/KavenSSOServer.ts:120

Generated using TypeDoc