Class MeAPI

Me API

Index

Constructors

Methods

getMe putMePassword

Constructors

constructor

new MeAPI(influxDB: InfluxDB): MeAPI
Creates MeAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns MeAPI
- Defined in apis/src/generated/MeAPI.ts:22

Methods

getMe

getMe(
request?: GetMeRequest,
requestOptions?: RequestOptions,
): Promise<UserResponse>
Retrieve the currently authenticated user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetMe
Parameters
- Optionalrequest: GetMeRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<UserResponse>
promise of response
- Defined in apis/src/generated/MeAPI.ts:32

putMePassword

putMePassword(
request: PutMePasswordRequest,
requestOptions?: RequestOptions,
): Promise<void>
Update a password. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PutMePassword
Parameters
- request: PutMePasswordRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/MeAPI.ts:45