Interface IOrganizationsService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface IOrganizationsService : IApiAccessor
Methods
DeleteOrgsID(String, String)
Delete an organization
Declaration
void DeleteOrgsID(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to delete. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDAsync(String, String, CancellationToken)
Delete an organization
Declaration
System.Threading.Tasks.Task DeleteOrgsIDAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to delete. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to delete. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDMembersID(String, String, String)
Remove a member from an organization
Declaration
void DeleteOrgsIDMembersID(string userID, string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the member to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDMembersIDAsync(String, String, String, CancellationToken)
Remove a member from an organization
Declaration
System.Threading.Tasks.Task DeleteOrgsIDMembersIDAsync(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the member to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove a member from an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDMembersIDAsyncWithHttpInfo(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the member to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDMembersIDWithHttpInfo(String, String, String)
Remove a member from an organization
Declaration
ApiResponse<object> DeleteOrgsIDMembersIDWithHttpInfo(string userID, string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the member to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDOwnersID(String, String, String)
Remove an owner from an organization
Declaration
void DeleteOrgsIDOwnersID(string userID, string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the owner to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDOwnersIDAsync(String, String, String, CancellationToken)
Remove an owner from an organization
Declaration
System.Threading.Tasks.Task DeleteOrgsIDOwnersIDAsync(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the owner to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove an owner from an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDOwnersIDAsyncWithHttpInfo(string userID, string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the owner to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDOwnersIDWithHttpInfo(String, String, String)
Remove an owner from an organization
Declaration
ApiResponse<object> DeleteOrgsIDOwnersIDWithHttpInfo(string userID, string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of the owner to remove. |
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteOrgsIDWithHttpInfo(String, String)
Delete an organization
Declaration
ApiResponse<object> DeleteOrgsIDWithHttpInfo(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to delete. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgs(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String)
List all organizations
Declaration
Organizations GetOrgs(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.Nullable<System.Int32> | offset | (optional) |
System.Nullable<System.Int32> | limit | (optional, default to 20) |
System.Nullable<System.Boolean> | descending | (optional, default to false) |
System.String | org | Filter organizations to a specific organization name. (optional) |
System.String | orgID | Filter organizations to a specific organization ID. (optional) |
System.String | userID | Filter organizations to a specific user ID. (optional) |
Returns
Type | Description |
---|---|
Organizations | Organizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)
List all organizations
Declaration
System.Threading.Tasks.Task<Organizations> GetOrgsAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.Nullable<System.Int32> | offset | (optional) |
System.Nullable<System.Int32> | limit | (optional, default to 20) |
System.Nullable<System.Boolean> | descending | (optional, default to false) |
System.String | org | Filter organizations to a specific organization name. (optional) |
System.String | orgID | Filter organizations to a specific organization ID. (optional) |
System.String | userID | Filter organizations to a specific user ID. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Organizations> | Task of Organizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsAsyncWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)
List all organizations
Declaration
System.Threading.Tasks.Task<ApiResponse<Organizations>> GetOrgsAsyncWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.Nullable<System.Int32> | offset | (optional) |
System.Nullable<System.Int32> | limit | (optional, default to 20) |
System.Nullable<System.Boolean> | descending | (optional, default to false) |
System.String | org | Filter organizations to a specific organization name. (optional) |
System.String | orgID | Filter organizations to a specific organization ID. (optional) |
System.String | userID | Filter organizations to a specific user ID. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organizations>> | Task of ApiResponse (Organizations) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsID(String, String)
Retrieve an organization
Declaration
Organization GetOrgsID(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Organization | Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDAsync(String, String, CancellationToken)
Retrieve an organization
Declaration
System.Threading.Tasks.Task<Organization> GetOrgsIDAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Organization> | Task of Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<Organization>> GetOrgsIDAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organization>> | Task of ApiResponse (Organization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDMembers(String, String)
List all members of an organization
Declaration
ResourceMembers GetOrgsIDMembers(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceMembers | ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDMembersAsync(String, String, CancellationToken)
List all members of an organization
Declaration
System.Threading.Tasks.Task<ResourceMembers> GetOrgsIDMembersAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceMembers> | Task of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDMembersAsyncWithHttpInfo(String, String, CancellationToken)
List all members of an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetOrgsIDMembersAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>> | Task of ApiResponse (ResourceMembers) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDMembersWithHttpInfo(String, String)
List all members of an organization
Declaration
ApiResponse<ResourceMembers> GetOrgsIDMembersWithHttpInfo(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers> | ApiResponse of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDOwners(String, String)
List all owners of an organization
Declaration
ResourceOwners GetOrgsIDOwners(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceOwners | ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDOwnersAsync(String, String, CancellationToken)
List all owners of an organization
Declaration
System.Threading.Tasks.Task<ResourceOwners> GetOrgsIDOwnersAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceOwners> | Task of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)
List all owners of an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetOrgsIDOwnersAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>> | Task of ApiResponse (ResourceOwners) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDOwnersWithHttpInfo(String, String)
List all owners of an organization
Declaration
ApiResponse<ResourceOwners> GetOrgsIDOwnersWithHttpInfo(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners> | ApiResponse of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsIDWithHttpInfo(String, String)
Retrieve an organization
Declaration
ApiResponse<Organization> GetOrgsIDWithHttpInfo(string orgID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Organization> | ApiResponse of Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetOrgsWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String)
List all organizations
Declaration
ApiResponse<Organizations> GetOrgsWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, bool? descending = null, string org = null, string orgID = null, string userID = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.Nullable<System.Int32> | offset | (optional) |
System.Nullable<System.Int32> | limit | (optional, default to 20) |
System.Nullable<System.Boolean> | descending | (optional, default to false) |
System.String | org | Filter organizations to a specific organization name. (optional) |
System.String | orgID | Filter organizations to a specific organization ID. (optional) |
System.String | userID | Filter organizations to a specific user ID. (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Organizations> | ApiResponse of Organizations |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsID(String, PatchOrganizationRequest, String)
Update an organization
Declaration
Organization PatchOrgsID(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Organization | Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDAsync(String, PatchOrganizationRequest, String, CancellationToken)
Update an organization
Declaration
System.Threading.Tasks.Task<Organization> PatchOrgsIDAsync(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Organization> | Task of Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDAsyncWithHttpInfo(String, PatchOrganizationRequest, String, CancellationToken)
Update an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<Organization>> PatchOrgsIDAsyncWithHttpInfo(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organization>> | Task of ApiResponse (Organization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchOrgsIDWithHttpInfo(String, PatchOrganizationRequest, String)
Update an organization
Declaration
ApiResponse<Organization> PatchOrgsIDWithHttpInfo(string orgID, PatchOrganizationRequest patchOrganizationRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The ID of the organization to get. |
PatchOrganizationRequest | patchOrganizationRequest | Organization update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Organization> | ApiResponse of Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgs(PostOrganizationRequest, String)
Create an organization
Declaration
Organization PostOrgs(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
PostOrganizationRequest | postOrganizationRequest | Organization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
Organization | Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsAsync(PostOrganizationRequest, String, CancellationToken)
Create an organization
Declaration
System.Threading.Tasks.Task<Organization> PostOrgsAsync(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PostOrganizationRequest | postOrganizationRequest | Organization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Organization> | Task of Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsAsyncWithHttpInfo(PostOrganizationRequest, String, CancellationToken)
Create an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<Organization>> PostOrgsAsyncWithHttpInfo(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PostOrganizationRequest | postOrganizationRequest | Organization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Organization>> | Task of ApiResponse (Organization) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDMembers(String, AddResourceMemberRequestBody, String)
Add a member to an organization
Declaration
ResourceMember PostOrgsIDMembers(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceMember | ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to an organization
Declaration
System.Threading.Tasks.Task<ResourceMember> PostOrgsIDMembersAsync(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceMember> | Task of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostOrgsIDMembersAsyncWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>> | Task of ApiResponse (ResourceMember) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add a member to an organization
Declaration
ApiResponse<ResourceMember> PostOrgsIDMembersWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceMember> | ApiResponse of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDOwners(String, AddResourceMemberRequestBody, String)
Add an owner to an organization
Declaration
ResourceOwner PostOrgsIDOwners(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceOwner | ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to an organization
Declaration
System.Threading.Tasks.Task<ResourceOwner> PostOrgsIDOwnersAsync(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceOwner> | Task of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to an organization
Declaration
System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostOrgsIDOwnersAsyncWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>> | Task of ApiResponse (ResourceOwner) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add an owner to an organization
Declaration
ApiResponse<ResourceOwner> PostOrgsIDOwnersWithHttpInfo(string orgID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | orgID | The organization ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner> | ApiResponse of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostOrgsWithHttpInfo(PostOrganizationRequest, String)
Create an organization
Declaration
ApiResponse<Organization> PostOrgsWithHttpInfo(PostOrganizationRequest postOrganizationRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
PostOrganizationRequest | postOrganizationRequest | Organization to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<Organization> | ApiResponse of Organization |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |