Class KavenSSOServer

Hierarchy (view full)

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, options?): KavenSSOServer
Parameters
- secret: string
- Optionaloptions: ISSOServerOption
Returns KavenSSOServer
Overrides KavenSSO.constructor
- Defined in src/net/sso/KavenSSOServer.ts:60

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

GetClients

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

GetClientsByServerSessionID

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

GetRedirectToClientURL

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

Logout

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

MakeNotifyURL

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

MakeRedirectURL

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

Verify

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