Class MicroserviceClientRequestAuth

Allows to use either Cookie-Auth or Basic-Auth of a microservice client request header for Authorization to the Cumulocity API.

Hierarchy (View Summary)

MicroserviceClientRequestAuth
- NodeJSCookieAuth

Implements

IAuthentication

Index

Constructors

Methods

getCometdHandshake getFetchOptions logout updateCredentials

Constructors

constructor

new MicroserviceClientRequestAuth(
headers?: IMicroserviceClientRequestHeaders,
): MicroserviceClientRequestAuth
Authenticates using the credentials which were provided within the request headers of the client call to the microservice.
Parameters
- headers: IMicroserviceClientRequestHeaders = {}
Returns MicroserviceClientRequestAuth
- Defined in packages/client/src/core/MicroserviceClientRequestAuth.ts:22

Methods

getCometdHandshake

getCometdHandshake(
config?: { ext?: { [key: string]: any } },
): { ext?: { [key: string]: any } }
Parameters
- config: { ext?: { [key: string]: any } } = {}
Returns { ext?: { [key: string]: any } }
Implementation of IAuthentication.getCometdHandshake
- Defined in packages/client/src/core/MicroserviceClientRequestAuth.ts:43

getFetchOptions

getFetchOptions(options: IFetchOptions): IFetchOptions
Parameters
- options: IFetchOptions
Returns IFetchOptions
Implementation of IAuthentication.getFetchOptions
- Defined in packages/client/src/core/MicroserviceClientRequestAuth.ts:32

logout

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

updateCredentials

updateCredentials(): string
Returns string
Implementation of IAuthentication.updateCredentials
- Defined in packages/client/src/core/MicroserviceClientRequestAuth.ts:28