Class KavenSSOClient

constructor

• new KavenSSOClient(appID, appHost, serverHost, secret, options?): KavenSSOClient

• Parameters

  • appID: string
  • appHost: string
  • serverHost: string
  • secret: string
  • Optionaloptions: ISSOClientOption

  Returns KavenSSOClient

ReadonlyAppHost

ReadonlyAppID

ReadonlyAppNotifyPath

ReadonlyServerHost

ReadonlyServerLoginPath

ReadonlyServerSSOPath

AppNotifyURL

• get AppNotifyURL(): string

• Returns string

ServerLoginURL

• get ServerLoginURL(): string

• Returns string

ServerSSOURL

• get ServerSSOURL(): string

• Returns string

GetDataFromSSOServer

• GetDataFromSSOServer<T>(url): Promise<T>

• Type Parameters

  • T = any

  Parameters

  • url: string

  Returns Promise<T>

GetRedirectToServerURL

• GetRedirectToServerURL(originalUrl, sessionID?): Promise<string>

• Parameters

  • originalUrl: string
  • OptionalsessionID: string

  Returns Promise<string>

Logout

• Logout(client, notifyServer?): Promise<void>

• Parameters

  • client: ISSOClient
  • notifyServer: boolean = true

  Returns Promise<void>

  Note

  This method will not throw an exception

MakeRedirectURL

• MakeRedirectURL(returnTo, sessionID?): Promise<string>

• Parameters

  • returnTo: string
  • OptionalsessionID: string

  Returns Promise<string>

MakeSSOURL

• MakeSSOURL(action, client, data?): Promise<string>

• Parameters

  • action: SSOAction
  • client: ISSOClient
  • Optionaldata: string

  Returns Promise<string>

RemoveSSOParametersFromURL

• RemoveSSOParametersFromURL(url, ...others): string

• Parameters

  • url: string
  • Rest...others: string[]

  Returns string

Verify

• Verify(originalUrl): Promise<undefined | ISSOVerifyResult>

• Parameters

  • originalUrl: string

  Returns Promise<undefined | ISSOVerifyResult>

VerifyClient

• VerifyClient(client): Promise<true | SSOVerifyError>

• Parameters

  • client: ISSOClient

  Returns Promise<true | SSOVerifyError>