Class KavenSSOClient

constructor

• new KavenSSOClient(
      appID: string,
      appHost: string,
      serverHost: string,
      secret: string,
      options?: ISSOClientOption,
  ): 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 = unknown>(url: string): Promise<undefined | T>

  Type Parameters

  • T = unknown

  Parameters

  • url: string

  Returns Promise<undefined | T>

GetRedirectToServerURL

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

  Parameters

  • originalUrl: string
  • OptionalsessionID: string

  Returns Promise<string>

Logout

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

  Parameters

  • client: ISSOClient
  • notifyServer: boolean = true

  Returns Promise<void>

  Note

  This method will not throw an exception

MakeRedirectURL

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

  Parameters

  • returnTo: string
  • OptionalsessionID: string

  Returns Promise<string>

MakeSSOURL

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

  Parameters

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

  Returns Promise<string>

RemoveSSOParametersFromURL

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

  Parameters

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

  Returns string

Verify

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

  Parameters

  • originalUrl: string

  Returns Promise<undefined | ISSOVerifyResult>

VerifyClient

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

  Parameters

  • client: ISSOClient

  Returns Promise<true | SSOVerifyError>