• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

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

In This Article
Back to top Generated by DocFX