Class KavenSSOServer

Hierarchy (View Summary)

KavenSSO
- KavenSSOServer

Index

Constructors

Properties

EnableLog Logger? LoginPath LoginSessionSet ParameterName Secret SSOPath TokenName

Methods

GetClient GetClients GetClientsByServerSessionID GetRedirectToClientURL Logout MakeNotifyURL MakeRedirectURL Verify

Constructors

constructor

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

Properties

EnableLog

EnableLog: boolean = false

`Optional`Logger

Logger?: ILoggingAgent

`Readonly`LoginPath

LoginPath: string = "/login"

`Readonly`LoginSessionSet

LoginSessionSet: Set<string>

Server logged in sessions

`Readonly`ParameterName

ParameterName: ISSOParameterName = DefaultSSOParameterName

`Readonly`Secret

Secret: string

`Readonly`SSOPath

SSOPath: string = "/sso"

`Readonly`TokenName

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

Methods

GetClient

GetClient(token: string): ISSOClientForServer | undefined
Parameters
- token: string
Returns ISSOClientForServer | undefined
- Defined in src/net/sso/KavenSSOServer.ts:106

GetClients

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

GetClientsByServerSessionID

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

GetRedirectToClientURL

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

Logout

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

MakeNotifyURL

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

MakeRedirectURL

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

Verify

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