Home > @influxdata/influxdb-client-apis > UsersAPI

UsersAPI class

Users API

Signature:

declare class UsersAPI 

Constructors

Constructor	Modifiers	Description
(constructor)(influxDB)		Creates UsersAPI

Methods

Method	Modifiers	Description
deleteUsersID(request, requestOptions)		Delete a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteUsersID
getUsers(request, requestOptions)		List users. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetUsers
getUsersID(request, requestOptions)		Retrieve a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetUsersID
patchUsersID(request, requestOptions)		Update a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchUsersID
postUsers(request, requestOptions)		Create a user. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostUsers
postUsersIDPassword(request, requestOptions)		Update a password. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostUsersIDPassword