Auth | @tillhub/javascript-sdk

Hierarchy

Auth
- Auth

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Auth(options: AuthOptions): Auth

Overrides Auth.constructor
- Defined in src/v1/auth.ts:20
Parameters
- options: AuthOptions
Returns Auth

Properties

authenticated

authenticated: boolean = false

options

options: AuthOptions

Optional token

token: string

Optional user

user: string

Optional whitelabel

whitelabel: string

Methods

authenticate

authenticate(): Promise<AuthResponse>

Overrides Auth.authenticate
- Defined in src/v1/auth.ts:37
Returns Promise<AuthResponse>

clearInstance

clearInstance(): void

Inherited from Auth.clearInstance
- Defined in src/v0/auth.ts:142
Initialise the SDK instance by authenticating the client

Returns void

Protected determineAuthType

determineAuthType(): void

Inherited from Auth.determineAuthType
- Defined in src/v0/auth.ts:150
Returns void

getEndpoint

getEndpoint(path?: string): string

Inherited from Auth.getEndpoint
- Defined in src/v0/auth.ts:132
Parameters
- Optional path: string
Returns string

loginAsSupport

loginAsSupport(authData: SupportAuth): Promise<AuthResponse>

- Defined in src/v1/auth.ts:123
Parameters
- authData: SupportAuth
Returns Promise<AuthResponse>

loginServiceAccount

loginServiceAccount(authData: KeyAuth): Promise<AuthResponse>

- Defined in src/v1/auth.ts:57
Parameters
- authData: KeyAuth
Returns Promise<AuthResponse>

loginUsername

loginUsername(authData: UsernameAuth): Promise<AuthResponse>

Inherited from Auth.loginUsername
- Defined in src/v0/auth.ts:165
Parameters
- authData: UsernameAuth
Returns Promise<AuthResponse>

loginWithOrganisation

loginWithOrganisation(authData: OrgAuth): Promise<AuthResponse>

- Defined in src/v1/auth.ts:83
Parameters
- authData: OrgAuth
Returns Promise<AuthResponse>

logout

logout(token?: string, whitelabel?: string): Promise<LogoutResponse>

Inherited from Auth.logout
- Defined in src/v0/auth.ts:275
Parameters
- Optional token: string
- Optional whitelabel: string
Returns Promise<LogoutResponse>

requestPasswordReset

requestPasswordReset(target: PasswordResetRequest): Promise<PasswordResetRequestResponse>

Inherited from Auth.requestPasswordReset
- Defined in src/v0/auth.ts:214
Parameters
- target: PasswordResetRequest
Returns Promise<PasswordResetRequestResponse>

requestPasswordResetWithOrganisation

requestPasswordResetWithOrganisation(target: PasswordOrgResetRequest): Promise<PasswordResetRequestResponse>

Inherited from Auth.requestPasswordResetWithOrganisation
- Defined in src/v0/auth.ts:228
Parameters
- target: PasswordOrgResetRequest
Returns Promise<PasswordResetRequestResponse>

Protected setDefaultHeader

setDefaultHeader(user: string, token: string, whitelabel?: string): void

Inherited from Auth.setDefaultHeader
- Defined in src/v0/auth.ts:258
Parameters
- user: string
- token: string
- Optional whitelabel: string
Returns void

setNewPassword

setNewPassword(nonce: PasswordResetNonce): Promise<PasswordResetRequestResponse>

Inherited from Auth.setNewPassword
- Defined in src/v0/auth.ts:243
Parameters
- nonce: PasswordResetNonce
Returns Promise<PasswordResetRequestResponse>

Generated using TypeDoc