Class UsersAPI

Users API

Index

Constructors

Methods

deleteUsersID getUsers getUsersID patchUsersID postUsers postUsersIDPassword

Constructors

constructor

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

Methods

deleteUsersID

deleteUsersID(
request: DeleteUsersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteUsersID
Parameters
- request: DeleteUsersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/UsersAPI.ts:164

getUsers

getUsers(
request?: GetUsersRequest,
requestOptions?: RequestOptions,
): Promise<Users>
List users. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetUsers
Parameters
- Optionalrequest: GetUsersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Users>
promise of response
- Defined in apis/src/generated/UsersAPI.ts:84

getUsersID

getUsersID(
request: GetUsersIDRequest,
requestOptions?: RequestOptions,
): Promise<UserResponse>
Retrieve a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetUsersID
Parameters
- request: GetUsersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<UserResponse>
promise of response
- Defined in apis/src/generated/UsersAPI.ts:127

patchUsersID

patchUsersID(
request: PatchUsersIDRequest,
requestOptions?: RequestOptions,
): Promise<UserResponse>
Update a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchUsersID
Parameters
- request: PatchUsersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<UserResponse>
promise of response
- Defined in apis/src/generated/UsersAPI.ts:145

postUsers

postUsers(
request: PostUsersRequest,
requestOptions?: RequestOptions,
): Promise<UserResponse>
Create a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostUsers
Parameters
- request: PostUsersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<UserResponse>
promise of response
- Defined in apis/src/generated/UsersAPI.ts:108

postUsersIDPassword

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