KavenSSOClient | kaven-utils

Hierarchy

KavenSSO
- KavenSSOClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides KavenSSO.constructor
- Defined in src/KavenSSO/KavenSSOClient.ts:68
Parameters
- appID: string
- appHost: string
- serverHost: string
- secret: string
- Optional options: ISSOClientOption
Returns KavenSSOClient

Properties

Readonly AppHost

AppHost: string = ...

Readonly AppID

AppID: string = ...

Readonly AppNotifyPath

AppNotifyPath: string = "/sso/notify"

EnableLog

EnableLog: boolean = false

Readonly ParameterName

ParameterName: ISSOParameterName = ...

Readonly Secret

Secret: string

Readonly ServerHost

ServerHost: string = ...

Readonly ServerLoginPath

ServerLoginPath: string = "/login"

Readonly ServerSSOPath

ServerSSOPath: string = "/sso"

Readonly TokenName

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

Accessors

AppNotifyURL

get AppNotifyURL(): string

- Defined in src/KavenSSO/KavenSSOClient.ts:62
Returns string

ServerLoginURL

get ServerLoginURL(): string

- Defined in src/KavenSSO/KavenSSOClient.ts:54
Returns string

ServerSSOURL

get ServerSSOURL(): string

- Defined in src/KavenSSO/KavenSSOClient.ts:58
Returns string

Methods

GetDataFromSSOServer

GetDataFromSSOServer<T>(url: string): Promise<IHTTPResponse<T>>

- Defined in src/KavenSSO/KavenSSOClient.ts:184
Type parameters
- T = any
Parameters
- url: string
Returns Promise<IHTTPResponse<T>>

GetRedirectToServerURL

GetRedirectToServerURL(originalUrl: string, sessionID?: string): string

- Defined in src/KavenSSO/KavenSSOClient.ts:129
Parameters
- originalUrl: string
- Optional sessionID: string
Returns string

Logout

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

- Defined in src/KavenSSO/KavenSSOClient.ts:193
note

This method will not throw an exception

Parameters
- client: ISSOClient
- notifyServer: boolean = true
Returns Promise<void>

MakeRedirectURL

MakeRedirectURL(returnTo: string, sessionID?: string): string

- Defined in src/KavenSSO/KavenSSOClient.ts:105
Parameters
- returnTo: string
- Optional sessionID: string
Returns string

MakeSSOURL

MakeSSOURL(action: SSOAction, client: ISSOClient, data?: string): string

- Defined in src/KavenSSO/KavenSSOClient.ts:92
Parameters
- action: SSOAction
- client: ISSOClient
- Optional data: string
Returns string

RemoveSSOParametersFromURL

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

- Defined in src/KavenSSO/KavenSSOClient.ts:118
Parameters
- url: string
- Rest ...others: string[]
Returns string

Verify

Verify(originalUrl: string): undefined | ISSOVerifyResult

- Defined in src/KavenSSO/KavenSSOClient.ts:134
Parameters
- originalUrl: string
Returns undefined | ISSOVerifyResult

VerifyClient

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

- Defined in src/KavenSSO/KavenSSOClient.ts:161
Parameters
- client: ISSOClient
Returns Promise<true | SSOVerifyError>

Generated using TypeDoc