Class BasicAuth

Allows to use Basic-Auth for Authorization to the Cumulocity API.

Hierarchy

BasicAuth

Implements

IAuthentication

Index

Constructors

Properties

Methods

getCometdHandshake getFetchOptions logout updateCredentials

Constructors

constructor

new BasicAuth(credentials?: ICredentials): BasicAuth
Authenticates the given user against the given tenant.
Parameters
- Optional credentials: ICredentials
Returns BasicAuth
- Defined in packages/client/src/core/BasicAuth.ts:20

Properties

user

user: string

Methods

getCometdHandshake

getCometdHandshake(config?: {
ext?: object;
}): {
ext?: object;
}
Parameters
- config: {
  ext?: object;
  } = {}
  - Optional ext?: object
Returns {
ext?: object;
}
- Optional ext?: object
Implementation of IAuthentication.getCometdHandshake
- Defined in packages/client/src/core/BasicAuth.ts:59

getFetchOptions

getFetchOptions(options: any): any
Parameters
- options: any
Returns any
Implementation of IAuthentication.getFetchOptions
- Defined in packages/client/src/core/BasicAuth.ts:43

logout

logout(): void
Returns void
Implementation of IAuthentication.logout
- Defined in packages/client/src/core/BasicAuth.ts:68

updateCredentials

updateCredentials(__namedParameters?: ICredentials): string
Parameters
- __namedParameters: ICredentials = {}
Returns string
Implementation of IAuthentication.updateCredentials
- Defined in packages/client/src/core/BasicAuth.ts:24