Interface IOrganizationsApi

Namespace: InfluxDB.Client

Assembly: InfluxDB.Client.dll

Syntax

public interface IOrganizationsApi

Methods

AddMemberAsync(User, Organization, CancellationToken)

Add organization member.

Declaration

Task<ResourceMember> AddMemberAsync(User member, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	member	the member of an organization
Organization	organization	the organization of a member
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceMember>	created mapping

AddMemberAsync(String, String, CancellationToken)

Add organization member.

Declaration

Task<ResourceMember> AddMemberAsync(string memberId, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	memberId	the ID of a member
System.String	orgId	the ID of an organization
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceMember>	created mapping

AddOwnerAsync(User, Organization, CancellationToken)

Add organization owner.

Declaration

Task<ResourceOwner> AddOwnerAsync(User owner, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	owner	the owner of an organization
Organization	organization	the organization of a owner
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceOwner>	created mapping

AddOwnerAsync(String, String, CancellationToken)

Add organization owner.

Declaration

Task<ResourceOwner> AddOwnerAsync(string ownerId, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ownerId	the ID of a owner
System.String	orgId	the ID of an organization
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceOwner>	created mapping

CloneOrganizationAsync(String, Organization, CancellationToken)

Clone an organization.

Declaration

Task<Organization> CloneOrganizationAsync(string clonedName, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	clonedName	name of cloned organization
Organization	organization	organization to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Organization>	cloned organization

CloneOrganizationAsync(String, String, CancellationToken)

Clone an organization.

Declaration

Task<Organization> CloneOrganizationAsync(string clonedName, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	clonedName	name of cloned organization
System.String	orgId	ID of organization to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Organization>	cloned organization

CreateOrganizationAsync(Organization, CancellationToken)

Creates a new organization and sets Id with the new identifier.

Declaration

Task<Organization> CreateOrganizationAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	the organization to create
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Organization>	created organization

CreateOrganizationAsync(String, CancellationToken)

Creates a new organization and sets Id with the new identifier.

Declaration

Task<Organization> CreateOrganizationAsync(string name, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Organization>	Created organization

DeleteMemberAsync(User, Organization, CancellationToken)

Removes a member from an organization.

Declaration

Task DeleteMemberAsync(User member, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	member	the member of an organization
Organization	organization	the organization of a member
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

DeleteMemberAsync(String, String, CancellationToken)

Removes a member from an organization.

Declaration

Task DeleteMemberAsync(string memberId, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	memberId	the ID of a member
System.String	orgId	the ID of an organization
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

DeleteOrganizationAsync(Organization, CancellationToken)

Delete an organization.

Declaration

Task DeleteOrganizationAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	organization to delete
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteOrganizationAsync(String, CancellationToken)

Delete an organization.

Declaration

Task DeleteOrganizationAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	ID of organization to delete
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteOwnerAsync(User, Organization, CancellationToken)

Removes a owner from an organization.

Declaration

Task DeleteOwnerAsync(User owner, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	owner	the owner of an organization
Organization	organization	the organization of a owner
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

DeleteOwnerAsync(String, String, CancellationToken)

Removes a owner from an organization.

Declaration

Task DeleteOwnerAsync(string ownerId, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ownerId	the ID of a owner
System.String	orgId	the ID of an organization
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

DeleteSecretsAsync(SecretKeys, String, CancellationToken)

Delete provided secrets.

Declaration

Task DeleteSecretsAsync(SecretKeys secrets, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
SecretKeys	secrets	secrets to delete
System.String	orgId	the organization for delete secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	keys successfully patched

DeleteSecretsAsync(List<String>, Organization, CancellationToken)

Delete provided secrets.

Declaration

Task DeleteSecretsAsync(List<string> secrets, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
List<System.String>	secrets	secrets to delete
Organization	organization	the organization for delete secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	keys successfully patched

DeleteSecretsAsync(List<String>, String, CancellationToken)

Delete provided secrets.

Declaration

Task DeleteSecretsAsync(List<string> secrets, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
List<System.String>	secrets	secrets to delete
System.String	orgId	the organization for delete secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	keys successfully patched

FindOrganizationByIdAsync(String, CancellationToken)

Retrieve an organization.

Declaration

Task<Organization> FindOrganizationByIdAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	ID of organization to get
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Organization>	organization details

FindOrganizationsAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, CancellationToken)

List all organizations.

Declaration

Task<List<Organization>> FindOrganizationsAsync(int? limit = null, int? offset = null, bool? descending = null, string org = null, string orgID = null, string userID = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.Nullable<System.Int32>	offset	(optional)
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
Task<List<Organization>>	List all organizations

GetMembersAsync(Organization, CancellationToken)

List all members of an organization.

Declaration

Task<List<ResourceMember>> GetMembersAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	organization of the members
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceMember>>	the List all members of an organization

GetMembersAsync(String, CancellationToken)

List all members of an organization.

Declaration

Task<List<ResourceMember>> GetMembersAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	ID of organization to get members
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceMember>>	the List all members of an organization

GetOwnersAsync(Organization, CancellationToken)

List all owners of an organization.

Declaration

Task<List<ResourceOwner>> GetOwnersAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	organization of the owners
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceOwner>>	the List all owners of an organization

GetOwnersAsync(String, CancellationToken)

List all owners of an organization.

Declaration

Task<List<ResourceOwner>> GetOwnersAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	ID of organization to get owners
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceOwner>>	the List all owners of an organization

GetSecretsAsync(Organization, CancellationToken)

List of secret keys the are stored for Organization. For example:

github_api_key,
some_other_key,
a_secret_key

Declaration

Task<List<string>> GetSecretsAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	the organization for get secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<System.String>>	the secret keys

GetSecretsAsync(String, CancellationToken)

List of secret keys the are stored for Organization. For example:

github_api_key,
some_other_key,
a_secret_key

Declaration

Task<List<string>> GetSecretsAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	the organization for get secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<System.String>>	the secret keys

PutSecretsAsync(Dictionary<String, String>, Organization, CancellationToken)

Patches all provided secrets and updates any previous values.

Declaration

Task PutSecretsAsync(Dictionary<string, string> secrets, Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	secrets	secrets to update/add
Organization	organization	the organization for put secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

PutSecretsAsync(Dictionary<String, String>, String, CancellationToken)

Patches all provided secrets and updates any previous values.

Declaration

Task PutSecretsAsync(Dictionary<string, string> secrets, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	secrets	secrets to update/add
System.String	orgId	the organization for put secrets
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task

UpdateOrganizationAsync(Organization, CancellationToken)

Update an organization.

Declaration

Task<Organization> UpdateOrganizationAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	organization update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Organization>	updated organization