Class OrgsAPI

Orgs API

Index

Constructors

Methods

deleteOrgsID deleteOrgsIDMembersID deleteOrgsIDOwnersID deleteOrgsIDSecretsID getOrgs getOrgsID getOrgsIDMembers getOrgsIDOwners getOrgsIDSecrets patchOrgsID patchOrgsIDSecrets postOrgs postOrgsIDMembers postOrgsIDOwners postOrgsIDSecrets

Constructors

constructor

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

Methods

deleteOrgsID

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

deleteOrgsIDMembersID

deleteOrgsIDMembersID(
request: DeleteOrgsIDMembersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove a member from an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteOrgsIDMembersID
Parameters
- request: DeleteOrgsIDMembersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:314

deleteOrgsIDOwnersID

deleteOrgsIDOwnersID(
request: DeleteOrgsIDOwnersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove an owner from an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteOrgsIDOwnersID
Parameters
- request: DeleteOrgsIDOwnersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:369

deleteOrgsIDSecretsID

deleteOrgsIDSecretsID(
request: DeleteOrgsIDSecretsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a secret from an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteOrgsIDSecretsID
Parameters
- request: DeleteOrgsIDSecretsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:406

getOrgs

getOrgs(
request?: GetOrgsRequest,
requestOptions?: RequestOptions,
): Promise<Organizations>
List organizations. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetOrgs
Parameters
- Optionalrequest: GetOrgsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Organizations>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:141

getOrgsID

getOrgsID(
request: GetOrgsIDRequest,
requestOptions?: RequestOptions,
): Promise<Organization>
Retrieve an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetOrgsID
Parameters
- request: GetOrgsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Organization>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:185

getOrgsIDMembers

getOrgsIDMembers(
request: GetOrgsIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMembers>
List all members of an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetOrgsIDMembers
Parameters
- request: GetOrgsIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMembers>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:277

getOrgsIDOwners

getOrgsIDOwners(
request: GetOrgsIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwners>
List all owners of an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetOrgsIDOwners
Parameters
- request: GetOrgsIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwners>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:332

getOrgsIDSecrets

getOrgsIDSecrets(
request: GetOrgsIDSecretsRequest,
requestOptions?: RequestOptions,
): Promise<SecretKeysResponse>
List all secret keys for an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetOrgsIDSecrets
Parameters
- request: GetOrgsIDSecretsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<SecretKeysResponse>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:240

patchOrgsID

patchOrgsID(
request: PatchOrgsIDRequest,
requestOptions?: RequestOptions,
): Promise<Organization>
Update an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchOrgsID
Parameters
- request: PatchOrgsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Organization>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:203

patchOrgsIDSecrets

patchOrgsIDSecrets(
request: PatchOrgsIDSecretsRequest,
requestOptions?: RequestOptions,
): Promise<void>
Update secrets in an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchOrgsIDSecrets
Parameters
- request: PatchOrgsIDSecretsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:258

postOrgs

postOrgs(
request: PostOrgsRequest,
requestOptions?: RequestOptions,
): Promise<Organization>
Create an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostOrgs
Parameters
- request: PostOrgsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Organization>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:166

postOrgsIDMembers

postOrgsIDMembers(
request: PostOrgsIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMember>
Add a member to an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostOrgsIDMembers
Parameters
- request: PostOrgsIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMember>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:295

postOrgsIDOwners

postOrgsIDOwners(
request: PostOrgsIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwner>
Add an owner to an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostOrgsIDOwners
Parameters
- request: PostOrgsIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwner>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:350

postOrgsIDSecrets

postOrgsIDSecrets(
request: PostOrgsIDSecretsRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete secrets from an organization. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostOrgsIDSecrets
Parameters
- request: PostOrgsIDSecretsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/OrgsAPI.ts:387

Class OrgsAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OrgsAPI

Methods

deleteOrgsID

Parameters

Returns Promise<void>

deleteOrgsIDMembersID

Parameters

Returns Promise<void>

deleteOrgsIDOwnersID

Parameters

Returns Promise<void>

deleteOrgsIDSecretsID

Parameters

Returns Promise<void>

getOrgs

Parameters

Returns Promise<Organizations>

getOrgsID

Parameters

Returns Promise<Organization>

getOrgsIDMembers

Parameters

Returns Promise<ResourceMembers>

getOrgsIDOwners

Parameters

Returns Promise<ResourceOwners>

getOrgsIDSecrets

Parameters

Returns Promise<SecretKeysResponse>

patchOrgsID

Parameters

Returns Promise<Organization>

patchOrgsIDSecrets

Parameters

Returns Promise<void>

postOrgs

Parameters

Returns Promise<Organization>

postOrgsIDMembers

Parameters

Returns Promise<ResourceMember>

postOrgsIDOwners

Parameters

Returns Promise<ResourceOwner>

postOrgsIDSecrets

Parameters

Returns Promise<void>

Settings

On This Page