Class AuthorizationsAPI

Authorizations API

Index

Constructors

Methods

deleteAuthorizationsID getAuthorizations getAuthorizationsID patchAuthorizationsID postAuthorizations

Constructors

constructor

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

Methods

deleteAuthorizationsID

deleteAuthorizationsID(
request: DeleteAuthorizationsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete an authorization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteAuthorizationsID
Parameters
- request: DeleteAuthorizationsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/AuthorizationsAPI.ts:144

getAuthorizations

getAuthorizations(
request?: GetAuthorizationsRequest,
requestOptions?: RequestOptions,
): Promise<Authorizations>
List authorizations. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetAuthorizations
Parameters
- Optionalrequest: GetAuthorizationsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Authorizations>
promise of response
- Defined in apis/src/generated/AuthorizationsAPI.ts:65

getAuthorizationsID

getAuthorizationsID(
request: GetAuthorizationsIDRequest,
requestOptions?: RequestOptions,
): Promise<Authorization>
Retrieve an authorization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetAuthorizationsID
Parameters
- request: GetAuthorizationsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Authorization>
promise of response
- Defined in apis/src/generated/AuthorizationsAPI.ts:107

patchAuthorizationsID

patchAuthorizationsID(
request: PatchAuthorizationsIDRequest,
requestOptions?: RequestOptions,
): Promise<Authorization>
Update an authorization to be active or inactive. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchAuthorizationsID
Parameters
- request: PatchAuthorizationsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Authorization>
promise of response
- Defined in apis/src/generated/AuthorizationsAPI.ts:125

postAuthorizations

postAuthorizations(
request: PostAuthorizationsRequest,
requestOptions?: RequestOptions,
): Promise<Authorization>
Create an authorization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostAuthorizations
Parameters
- request: PostAuthorizationsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Authorization>
promise of response
- Defined in apis/src/generated/AuthorizationsAPI.ts:88