CamundaClient

Technical Preview

The C# SDK is a technical preview available from Camunda 8.9. It will become fully supported in Camunda 8.10. Its API surface may change in future releases without following semver.

Creating a Client

Factory method for creating CamundaClient instances.

public static CamundaClient CreateClient(CamundaOptions? options = null)

Create a new CamundaClient.

Parameter	Type	Description
options	CamundaOptions

Dependency Injection

Extension methods for registering in an .

AddCamundaClient(IServiceCollection)

public static IServiceCollection AddCamundaClient(this IServiceCollection services)

Registers a singleton using zero-config (environment variables only).

Parameter	Type	Description
services	IServiceCollection

AddCamundaClient(IServiceCollection, IConfiguration)

public static IServiceCollection AddCamundaClient(this IServiceCollection services, IConfiguration configurationSection)

Registers a singleton using an section.

Typically called as services.AddCamundaClient(configuration.GetSection("Camunda")). PascalCase keys in the section are mapped to canonical CAMUNDA_* env-var names internally. Environment variables still apply as a base layer; section values override them.

Parameter	Type	Description
services	IServiceCollection
configurationSection	IConfiguration

AddCamundaClient(IServiceCollection, Action)

public static IServiceCollection AddCamundaClient(this IServiceCollection services, Action<CamundaOptions> configure)

Registers a singleton with an options callback for full control.

Parameter	Type	Description
services	IServiceCollection
configure	Action<CamundaOptions>

Overview

Primary Camunda client. Provides typed methods for all Camunda 8 REST API operations.

Auto-generated operation methods are added in the Generated/ partial class files. This class provides the infrastructure: configuration, auth, retry, backpressure.

public class CamundaClient : IDisposable, IAsyncDisposable

Constructor

public CamundaClient(CamundaOptions? options = null)

Create a new CamundaClient with the given options.

Parameter	Type	Description
options	CamundaOptions

Properties

Property	Type	Description
Config	CamundaConfig	The current hydrated configuration (read-only).

Methods

Other

Create(CamundaOptions?)

public static CamundaClient Create(CamundaOptions? options = null)

Create a new CamundaClient.

Parameter	Type	Description
options	CamundaOptions

Returns: CamundaClient

Dispose()

public void Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

DisposeAsync()

public ValueTask DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

Returns: ValueTask — A task that represents the asynchronous dispose operation.

CreateAdminUserAsync(UserRequest, CancellationToken)

public Task<UserCreateResult> CreateAdminUserAsync(UserRequest body, CancellationToken ct = default)

Create admin user Creates a new user and assigns the admin role to it. This endpoint is only usable when users are managed in the Orchestration Cluster and while no user is assigned to the admin role.

Parameter	Type	Description
body	UserRequest
ct	CancellationToken

Returns: Task<UserCreateResult>

CreateGlobalTaskListenerAsync(CreateGlobalTaskListenerRequest, CancellationToken)

public Task<GlobalTaskListenerResult> CreateGlobalTaskListenerAsync(CreateGlobalTaskListenerRequest body, CancellationToken ct = default)

Create global user task listener Create a new global user task listener.

Parameter	Type	Description
body	CreateGlobalTaskListenerRequest
ct	CancellationToken

Returns: Task<GlobalTaskListenerResult>

CreateUserAsync(UserRequest, CancellationToken)

public Task<UserCreateResult> CreateUserAsync(UserRequest body, CancellationToken ct = default)

Create user Create a new user.

Parameter	Type	Description
body	UserRequest
ct	CancellationToken

Returns: Task<UserCreateResult>

DeleteGlobalTaskListenerAsync(GlobalListenerId, CancellationToken)

public Task DeleteGlobalTaskListenerAsync(GlobalListenerId id, CancellationToken ct = default)

Delete global user task listener Deletes a global user task listener.

Parameter	Type	Description
id	GlobalListenerId
ct	CancellationToken

Returns: Task

DeleteUserAsync(Username, CancellationToken)

public Task DeleteUserAsync(Username username, CancellationToken ct = default)

Delete user Deletes a user.

Parameter	Type	Description
username	Username
ct	CancellationToken

Returns: Task

EvaluateConditionalsAsync(ConditionalEvaluationInstruction, CancellationToken)

public Task<EvaluateConditionalResult> EvaluateConditionalsAsync(ConditionalEvaluationInstruction body, CancellationToken ct = default)

Evaluate root level conditional start events Evaluates root-level conditional start events for process definitions. If the evaluation is successful, it will return the keys of all created process instances, along with their associated process definition key. Multiple root-level conditional start events of the same process definition can trigger if their conditions evaluate to true.

Parameter	Type	Description
body	ConditionalEvaluationInstruction
ct	CancellationToken

Returns: Task<EvaluateConditionalResult>

EvaluateExpressionAsync(ExpressionEvaluationRequest, CancellationToken)

public Task<ExpressionEvaluationResult> EvaluateExpressionAsync(ExpressionEvaluationRequest body, CancellationToken ct = default)

Evaluate an expression Evaluates a FEEL expression and returns the result. Supports references to tenant scoped cluster variables when a tenant ID is provided.

Parameter	Type	Description
body	ExpressionEvaluationRequest
ct	CancellationToken

Returns: Task<ExpressionEvaluationResult>

GetGlobalTaskListenerAsync(GlobalListenerId, ConsistencyOptions?, CancellationToken)

public Task<GlobalTaskListenerResult> GetGlobalTaskListenerAsync(GlobalListenerId id, ConsistencyOptions<GlobalTaskListenerResult>? consistency = null, CancellationToken ct = default)

Get global user task listener Get a global user task listener by its id.

Parameter	Type	Description
id	GlobalListenerId
consistency	ConsistencyOptions<GlobalTaskListenerResult>
ct	CancellationToken

Returns: Task<GlobalTaskListenerResult>

GetStatusAsync(CancellationToken)

public Task GetStatusAsync(CancellationToken ct = default)

Get cluster status Checks the health status of the cluster by verifying if there's at least one partition with a healthy leader.

Parameter	Type	Description
ct	CancellationToken

Returns: Task

GetSystemConfigurationAsync(CancellationToken)

public Task<SystemConfigurationResponse> GetSystemConfigurationAsync(CancellationToken ct = default)

System configuration (alpha) Returns the current system configuration. The response is an envelope that groups settings by feature area.

This endpoint is an alpha feature and may be subject to change in future releases.

Parameter	Type	Description
ct	CancellationToken

Returns: Task<SystemConfigurationResponse>

GetUserAsync(Username, ConsistencyOptions?, CancellationToken)

public Task<GetUserResponse> GetUserAsync(Username username, ConsistencyOptions<GetUserResponse>? consistency = null, CancellationToken ct = default)

Get user Get a user by its username.

Parameter	Type	Description
username	Username
consistency	ConsistencyOptions<GetUserResponse>
ct	CancellationToken

Returns: Task<GetUserResponse>

SearchGlobalTaskListenersAsync(GlobalTaskListenerSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<GlobalTaskListenerSearchQueryResult> SearchGlobalTaskListenersAsync(GlobalTaskListenerSearchQueryRequest body, ConsistencyOptions<GlobalTaskListenerSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search global user task listeners Search for global user task listeners based on given criteria.

Parameter	Type	Description
body	GlobalTaskListenerSearchQueryRequest
consistency	ConsistencyOptions<GlobalTaskListenerSearchQueryResult>
ct	CancellationToken

Returns: Task<GlobalTaskListenerSearchQueryResult>

SearchUsersAsync(UserSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchUsersResponse> SearchUsersAsync(UserSearchQueryRequest body, ConsistencyOptions<SearchUsersResponse>? consistency = null, CancellationToken ct = default)

Search users Search for users based on given criteria.

Parameter	Type	Description
body	UserSearchQueryRequest
consistency	ConsistencyOptions<SearchUsersResponse>
ct	CancellationToken

Returns: Task<SearchUsersResponse>

UpdateGlobalTaskListenerAsync(GlobalListenerId, UpdateGlobalTaskListenerRequest, CancellationToken)

public Task<GlobalTaskListenerResult> UpdateGlobalTaskListenerAsync(GlobalListenerId id, UpdateGlobalTaskListenerRequest body, CancellationToken ct = default)

Update global user task listener Updates a global user task listener.

Parameter	Type	Description
id	GlobalListenerId
body	UpdateGlobalTaskListenerRequest
ct	CancellationToken

Returns: Task<GlobalTaskListenerResult>

UpdateUserAsync(Username, UserUpdateRequest, CancellationToken)

public Task<UpdateUserResponse> UpdateUserAsync(Username username, UserUpdateRequest body, CancellationToken ct = default)

Update user Updates a user.

Parameter	Type	Description
username	Username
body	UserUpdateRequest
ct	CancellationToken

Returns: Task<UpdateUserResponse>

Cluster

GetBackpressureState()

public BackpressureState GetBackpressureState()

Current backpressure state snapshot.

Returns: BackpressureState

GetAuthenticationAsync(CancellationToken)

public Task<CamundaUserResult> GetAuthenticationAsync(CancellationToken ct = default)

Get current user Retrieves the current authenticated user.

Parameter	Type	Description
ct	CancellationToken

Returns: Task<CamundaUserResult>

Example

private static async Task GetAuthenticationExample()
{
    using var client = CamundaClient.Create();

    var user = await client.GetAuthenticationAsync();
    Console.WriteLine($"Authenticated as: {user.Username}");
}

GetLicenseAsync(CancellationToken)

public Task<LicenseResponse> GetLicenseAsync(CancellationToken ct = default)

Get license status Obtains the status of the current Camunda license.

Parameter	Type	Description
ct	CancellationToken

Returns: Task<LicenseResponse>

GetTopologyAsync(CancellationToken)

public Task<TopologyResponse> GetTopologyAsync(CancellationToken ct = default)

Get cluster topology Obtains the current topology of the cluster the gateway is part of.

Parameter	Type	Description
ct	CancellationToken

Returns: Task<TopologyResponse>

Example

private static async Task GetTopologyExample()
{
    using var client = CamundaClient.Create();

    var topology = await client.GetTopologyAsync();

    Console.WriteLine($"Cluster size: {topology.ClusterSize}");
    Console.WriteLine($"Partitions: {topology.PartitionsCount}");
    foreach (var broker in topology.Brokers)
    {
        Console.WriteLine($"  Broker {broker.NodeId}: {broker.Host}:{broker.Port}");
    }
}

PinClockAsync(ClockPinRequest, CancellationToken)

public Task PinClockAsync(ClockPinRequest body, CancellationToken ct = default)

Pin internal clock (alpha) Set a precise, static time for the Zeebe engine's internal clock. When the clock is pinned, it remains at the specified time and does not advance. To change the time, the clock must be pinned again with a new timestamp.

This endpoint is an alpha feature and may be subject to change in future releases.

Parameter	Type	Description
body	ClockPinRequest
ct	CancellationToken

Returns: Task

ResetClockAsync(CancellationToken)

public Task ResetClockAsync(CancellationToken ct = default)

Reset internal clock (alpha) Resets the Zeebe engine's internal clock to the current system time, enabling it to tick in real-time. This operation is useful for returning the clock to normal behavior after it has been pinned to a specific time.

This endpoint is an alpha feature and may be subject to change in future releases.

Parameter	Type	Description
ct	CancellationToken

Returns: Task

Resources

DeployResourcesFromFilesAsync(string[], string?, CancellationToken)

public Task<ExtendedDeploymentResponse> DeployResourcesFromFilesAsync(string[] resourceFilePaths, string? tenantId = null, CancellationToken ct = default)

Deploy resources from local filesystem paths. Reads the specified files, infers MIME types from their extensions, and calls with the loaded content.

Parameter	Type	Description
resourceFilePaths	String[]	Absolute or relative file paths to BPMN, DMN, form, or resource files.
tenantId	String	Optional tenant ID for multi-tenant deployments.
ct	CancellationToken	Cancellation token.

Returns: Task<ExtendedDeploymentResponse> — An with typed access to deployed artifacts.

Example

private static async Task DeployResourcesFromFilesExample()
{
    using var client = CamundaClient.Create();

    var result = await client.DeployResourcesFromFilesAsync(
        new[] { "order-process.bpmn", "email-connector.bpmn" }
    );

    Console.WriteLine($"Deployment key: {result.DeploymentKey}");
    foreach (var process in result.Processes)
    {
        Console.WriteLine($"  Process: {process.ProcessDefinitionId} v{process.ProcessDefinitionVersion}");
    }
}

DeleteResourceAsync(ResourceKey, DeleteResourceRequest, CancellationToken)

public Task<DeleteResourceResponse> DeleteResourceAsync(ResourceKey resourceKey, DeleteResourceRequest body, CancellationToken ct = default)

Delete resource Deletes a deployed resource. This can be a process definition, decision requirements definition, or form definition deployed using the deploy resources endpoint. Specify the resource you want to delete in the resourceKey parameter.

Once a resource has been deleted it cannot be recovered. If the resource needs to be available again, a new deployment of the resource is required.

By default, only the resource itself is deleted from the runtime state. To also delete the historic data associated with a resource, set the deleteHistory flag in the request body to true. The historic data is deleted asynchronously via a batch operation. The details of the created batch operation are included in the response. Note that history deletion is only supported for process resources; for other resource types this flag is ignored and no history will be deleted.

Parameter	Type	Description
resourceKey	ResourceKey
body	DeleteResourceRequest
ct	CancellationToken

Returns: Task<DeleteResourceResponse>

GetResourceAsync(ResourceKey, CancellationToken)

public Task<ResourceResult> GetResourceAsync(ResourceKey resourceKey, CancellationToken ct = default)

Get resource Returns a deployed resource.

info

Currently, this endpoint only supports RPA resources.

Parameter	Type	Description
resourceKey	ResourceKey
ct	CancellationToken

Returns: Task<ResourceResult>

GetResourceContentAsync(ResourceKey, CancellationToken)

public Task<object> GetResourceContentAsync(ResourceKey resourceKey, CancellationToken ct = default)

Get resource content Returns the content of a deployed resource.

info

Currently, this endpoint only supports RPA resources.

Parameter	Type	Description
resourceKey	ResourceKey
ct	CancellationToken

Returns: Task<Object>

Jobs

CreateJobWorker(JobWorkerConfig, JobHandler)

public JobWorker CreateJobWorker(JobWorkerConfig config, JobHandler handler)

Create a job worker that polls for and processes jobs of the specified type.

The handler receives an and returns variables to auto-complete. Throw for BPMN errors, for explicit failures, or any other exception to auto-fail with retries - 1.

Parameter	Type	Description
config	JobWorkerConfig	Worker configuration (job type, timeout, concurrency).
handler	JobHandler	Async handler that processes each job. Return output variables (or null) to complete.

Returns: JobWorker — The running instance.

CreateJobWorker(JobWorkerConfig, Func<ActivatedJob, CancellationToken, Task>)

public JobWorker CreateJobWorker(JobWorkerConfig config, Func<ActivatedJob, CancellationToken, Task> handler)

Create a job worker with a handler that doesn't return output variables. The job is auto-completed with no variables on success.

Parameter	Type	Description
config	JobWorkerConfig
handler	Func<Task>

Returns: JobWorker

ActivateJobsAsync(JobActivationRequest, CancellationToken)

public Task<JobActivationResult> ActivateJobsAsync(JobActivationRequest body, CancellationToken ct = default)

Activate jobs Iterate through all known partitions and activate jobs up to the requested maximum.

Parameter	Type	Description
body	JobActivationRequest
ct	CancellationToken

Returns: Task<JobActivationResult>

CompleteJobAsync(JobKey, JobCompletionRequest, CancellationToken)

public Task CompleteJobAsync(JobKey jobKey, JobCompletionRequest body, CancellationToken ct = default)

Complete job Complete a job with the given payload, which allows completing the associated service task.

Parameter	Type	Description
jobKey	JobKey
body	JobCompletionRequest
ct	CancellationToken

Returns: Task

FailJobAsync(JobKey, JobFailRequest, CancellationToken)

public Task FailJobAsync(JobKey jobKey, JobFailRequest body, CancellationToken ct = default)

Fail job Mark the job as failed.

Parameter	Type	Description
jobKey	JobKey
body	JobFailRequest
ct	CancellationToken

Returns: Task

GetGlobalJobStatisticsAsync(DateTimeOffset, DateTimeOffset, string?, ConsistencyOptions?, CancellationToken)

public Task<GlobalJobStatisticsQueryResult> GetGlobalJobStatisticsAsync(DateTimeOffset from, DateTimeOffset to, string? jobType = null, ConsistencyOptions<GlobalJobStatisticsQueryResult>? consistency = null, CancellationToken ct = default)

Global job statistics Returns global aggregated counts for jobs. Optionally filter by the creation time window and/or jobType.

Parameter	Type	Description
from	DateTimeOffset
to	DateTimeOffset
jobType	String
consistency	ConsistencyOptions<GlobalJobStatisticsQueryResult>
ct	CancellationToken

Returns: Task<GlobalJobStatisticsQueryResult>

GetJobErrorStatisticsAsync(JobErrorStatisticsQuery, ConsistencyOptions?, CancellationToken)

public Task<JobErrorStatisticsQueryResult> GetJobErrorStatisticsAsync(JobErrorStatisticsQuery body, ConsistencyOptions<JobErrorStatisticsQueryResult>? consistency = null, CancellationToken ct = default)

Get error metrics for a job type Returns aggregated metrics per error for the given jobType.

Parameter	Type	Description
body	JobErrorStatisticsQuery
consistency	ConsistencyOptions<JobErrorStatisticsQueryResult>
ct	CancellationToken

Returns: Task<JobErrorStatisticsQueryResult>

GetJobTimeSeriesStatisticsAsync(JobTimeSeriesStatisticsQuery, ConsistencyOptions?, CancellationToken)

public Task<JobTimeSeriesStatisticsQueryResult> GetJobTimeSeriesStatisticsAsync(JobTimeSeriesStatisticsQuery body, ConsistencyOptions<JobTimeSeriesStatisticsQueryResult>? consistency = null, CancellationToken ct = default)

Get time-series metrics for a job type Returns a list of time-bucketed metrics ordered ascending by time. The from and to fields select the time window of interest. Each item in the response corresponds to one time bucket of the requested resolution.

Parameter	Type	Description
body	JobTimeSeriesStatisticsQuery
consistency	ConsistencyOptions<JobTimeSeriesStatisticsQueryResult>
ct	CancellationToken

Returns: Task<JobTimeSeriesStatisticsQueryResult>

GetJobTypeStatisticsAsync(JobTypeStatisticsQuery, ConsistencyOptions?, CancellationToken)

public Task<JobTypeStatisticsQueryResult> GetJobTypeStatisticsAsync(JobTypeStatisticsQuery body, ConsistencyOptions<JobTypeStatisticsQueryResult>? consistency = null, CancellationToken ct = default)

Get job statistics by type Get statistics about jobs, grouped by job type.

Parameter	Type	Description
body	JobTypeStatisticsQuery
consistency	ConsistencyOptions<JobTypeStatisticsQueryResult>
ct	CancellationToken

Returns: Task<JobTypeStatisticsQueryResult>

GetJobWorkerStatisticsAsync(JobWorkerStatisticsQuery, ConsistencyOptions?, CancellationToken)

public Task<JobWorkerStatisticsQueryResult> GetJobWorkerStatisticsAsync(JobWorkerStatisticsQuery body, ConsistencyOptions<JobWorkerStatisticsQueryResult>? consistency = null, CancellationToken ct = default)

Get job statistics by worker Get statistics about jobs, grouped by worker, for a given job type.

Parameter	Type	Description
body	JobWorkerStatisticsQuery
consistency	ConsistencyOptions<JobWorkerStatisticsQueryResult>
ct	CancellationToken

Returns: Task<JobWorkerStatisticsQueryResult>

SearchJobsAsync(JobSearchQuery, ConsistencyOptions?, CancellationToken)

public Task<JobSearchQueryResult> SearchJobsAsync(JobSearchQuery body, ConsistencyOptions<JobSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search jobs Search for jobs based on given criteria.

Parameter	Type	Description
body	JobSearchQuery
consistency	ConsistencyOptions<JobSearchQueryResult>
ct	CancellationToken

Returns: Task<JobSearchQueryResult>

ThrowJobErrorAsync(JobKey, JobErrorRequest, CancellationToken)

public Task ThrowJobErrorAsync(JobKey jobKey, JobErrorRequest body, CancellationToken ct = default)

Throw error for job Reports a business error (i.e. non-technical) that occurs while processing a job.

Parameter	Type	Description
jobKey	JobKey
body	JobErrorRequest
ct	CancellationToken

Returns: Task

UpdateJobAsync(JobKey, JobUpdateRequest, CancellationToken)

public Task UpdateJobAsync(JobKey jobKey, JobUpdateRequest body, CancellationToken ct = default)

Update job Update a job with the given key.

Parameter	Type	Description
jobKey	JobKey
body	JobUpdateRequest
ct	CancellationToken

Returns: Task

Job Workers

RunWorkersAsync(TimeSpan?, CancellationToken)

public Task RunWorkersAsync(TimeSpan? gracePeriod = null, CancellationToken ct = default)

Block until cancellation is requested, keeping all registered workers alive. This is the typical entry point for worker-only applications.

When the token is cancelled, all workers are stopped gracefully.

Parameter	Type	Description
gracePeriod	Nullable<TimeSpan>	Time to wait for in-flight jobs to finish during shutdown. Default: 10 seconds.
ct	CancellationToken	Cancellation token that signals shutdown.

Returns: Task

StopAllWorkersAsync(TimeSpan?)

public Task StopAllWorkersAsync(TimeSpan? gracePeriod = null)

Stop all registered workers and wait for in-flight jobs to drain.

Parameter	Type	Description
gracePeriod	Nullable<TimeSpan>

Returns: Task

GetWorkers()

public IReadOnlyList<JobWorker> GetWorkers()

Returns a snapshot of all registered workers.

Returns: IReadOnlyList<JobWorker>

Elements

ActivateAdHocSubProcessActivitiesAsync(ElementInstanceKey, AdHocSubProcessActivateActivitiesInstruction, CancellationToken)

public Task ActivateAdHocSubProcessActivitiesAsync(ElementInstanceKey adHocSubProcessInstanceKey, AdHocSubProcessActivateActivitiesInstruction body, CancellationToken ct = default)

Activate activities within an ad-hoc sub-process Activates selected activities within an ad-hoc sub-process identified by element ID. The provided element IDs must exist within the ad-hoc sub-process instance identified by the provided adHocSubProcessInstanceKey.

Parameter	Type	Description
adHocSubProcessInstanceKey	ElementInstanceKey
body	AdHocSubProcessActivateActivitiesInstruction
ct	CancellationToken

Returns: Task

GetElementInstanceAsync(ElementInstanceKey, ConsistencyOptions?, CancellationToken)

public Task<ElementInstanceResult> GetElementInstanceAsync(ElementInstanceKey elementInstanceKey, ConsistencyOptions<ElementInstanceResult>? consistency = null, CancellationToken ct = default)

Get element instance Returns element instance as JSON.

Parameter	Type	Description
elementInstanceKey	ElementInstanceKey
consistency	ConsistencyOptions<ElementInstanceResult>
ct	CancellationToken

Returns: Task<ElementInstanceResult>

SearchElementInstancesAsync(ElementInstanceSearchQuery, ConsistencyOptions?, CancellationToken)

public Task<ElementInstanceSearchQueryResult> SearchElementInstancesAsync(ElementInstanceSearchQuery body, ConsistencyOptions<ElementInstanceSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search element instances Search for element instances based on given criteria.

Parameter	Type	Description
body	ElementInstanceSearchQuery
consistency	ConsistencyOptions<ElementInstanceSearchQueryResult>
ct	CancellationToken

Returns: Task<ElementInstanceSearchQueryResult>

Groups

AssignClientToGroupAsync(string, string, CancellationToken)

public Task AssignClientToGroupAsync(string groupId, string clientId, CancellationToken ct = default)

Assign a client to a group Assigns a client to a group, making it a member of the group. Members of the group inherit the group authorizations, roles, and tenant assignments.

Parameter	Type	Description
groupId	String
clientId	String
ct	CancellationToken

Returns: Task

AssignMappingRuleToGroupAsync(string, string, CancellationToken)

public Task AssignMappingRuleToGroupAsync(string groupId, string mappingRuleId, CancellationToken ct = default)

Assign a mapping rule to a group Assigns a mapping rule to a group.

Parameter	Type	Description
groupId	String
mappingRuleId	String
ct	CancellationToken

Returns: Task

AssignUserToGroupAsync(string, Username, CancellationToken)

public Task AssignUserToGroupAsync(string groupId, Username username, CancellationToken ct = default)

Assign a user to a group Assigns a user to a group, making the user a member of the group. Group members inherit the group authorizations, roles, and tenant assignments.

Parameter	Type	Description
groupId	String
username	Username
ct	CancellationToken

Returns: Task

CreateGroupAsync(GroupCreateRequest, CancellationToken)

public Task<GroupCreateResult> CreateGroupAsync(GroupCreateRequest body, CancellationToken ct = default)

Create group Create a new group.

Parameter	Type	Description
body	GroupCreateRequest
ct	CancellationToken

Returns: Task<GroupCreateResult>

DeleteGroupAsync(string, CancellationToken)

public Task DeleteGroupAsync(string groupId, CancellationToken ct = default)

Delete group Deletes the group with the given ID.

Parameter	Type	Description
groupId	String
ct	CancellationToken

Returns: Task

GetGroupAsync(string, ConsistencyOptions?, CancellationToken)

public Task<GroupResult> GetGroupAsync(string groupId, ConsistencyOptions<GroupResult>? consistency = null, CancellationToken ct = default)

Get group Get a group by its ID.

Parameter	Type	Description
groupId	String
consistency	ConsistencyOptions<GroupResult>
ct	CancellationToken

Returns: Task<GroupResult>

SearchClientsForGroupAsync(string, SearchClientsForGroupRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchClientsForGroupResponse> SearchClientsForGroupAsync(string groupId, SearchClientsForGroupRequest body, ConsistencyOptions<SearchClientsForGroupResponse>? consistency = null, CancellationToken ct = default)

Search group clients Search clients assigned to a group.

Parameter	Type	Description
groupId	String
body	SearchClientsForGroupRequest
consistency	ConsistencyOptions<SearchClientsForGroupResponse>
ct	CancellationToken

Returns: Task<SearchClientsForGroupResponse>

SearchGroupsAsync(GroupSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<GroupSearchQueryResult> SearchGroupsAsync(GroupSearchQueryRequest body, ConsistencyOptions<GroupSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search groups Search for groups based on given criteria.

Parameter	Type	Description
body	GroupSearchQueryRequest
consistency	ConsistencyOptions<GroupSearchQueryResult>
ct	CancellationToken

Returns: Task<GroupSearchQueryResult>

SearchMappingRulesForGroupAsync(string, MappingRuleSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchMappingRulesForGroupResponse> SearchMappingRulesForGroupAsync(string groupId, MappingRuleSearchQueryRequest body, ConsistencyOptions<SearchMappingRulesForGroupResponse>? consistency = null, CancellationToken ct = default)

Search group mapping rules Search mapping rules assigned to a group.

Parameter	Type	Description
groupId	String
body	MappingRuleSearchQueryRequest
consistency	ConsistencyOptions<SearchMappingRulesForGroupResponse>
ct	CancellationToken

Returns: Task<SearchMappingRulesForGroupResponse>

SearchUsersForGroupAsync(string, SearchUsersForGroupRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchUsersForGroupResponse> SearchUsersForGroupAsync(string groupId, SearchUsersForGroupRequest body, ConsistencyOptions<SearchUsersForGroupResponse>? consistency = null, CancellationToken ct = default)

Search group users Search users assigned to a group.

Parameter	Type	Description
groupId	String
body	SearchUsersForGroupRequest
consistency	ConsistencyOptions<SearchUsersForGroupResponse>
ct	CancellationToken

Returns: Task<SearchUsersForGroupResponse>

UnassignClientFromGroupAsync(string, string, CancellationToken)

public Task UnassignClientFromGroupAsync(string groupId, string clientId, CancellationToken ct = default)

Unassign a client from a group Unassigns a client from a group. The client is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied.

Parameter	Type	Description
groupId	String
clientId	String
ct	CancellationToken

Returns: Task

UnassignMappingRuleFromGroupAsync(string, string, CancellationToken)

public Task UnassignMappingRuleFromGroupAsync(string groupId, string mappingRuleId, CancellationToken ct = default)

Unassign a mapping rule from a group Unassigns a mapping rule from a group.

Parameter	Type	Description
groupId	String
mappingRuleId	String
ct	CancellationToken

Returns: Task

UnassignUserFromGroupAsync(string, Username, CancellationToken)

public Task UnassignUserFromGroupAsync(string groupId, Username username, CancellationToken ct = default)

Unassign a user from a group Unassigns a user from a group. The user is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied.

Parameter	Type	Description
groupId	String
username	Username
ct	CancellationToken

Returns: Task

UpdateGroupAsync(string, GroupUpdateRequest, CancellationToken)

public Task<GroupUpdateResult> UpdateGroupAsync(string groupId, GroupUpdateRequest body, CancellationToken ct = default)

Update group Update a group with the given ID.

Parameter	Type	Description
groupId	String
body	GroupUpdateRequest
ct	CancellationToken

Returns: Task<GroupUpdateResult>

Tenants

AssignClientToTenantAsync(TenantId, string, CancellationToken)

public Task AssignClientToTenantAsync(TenantId tenantId, string clientId, CancellationToken ct = default)

Assign a client to a tenant Assign the client to the specified tenant. The client can then access tenant data and perform authorized actions.

Parameter	Type	Description
tenantId	TenantId
clientId	String
ct	CancellationToken

Returns: Task

AssignGroupToTenantAsync(TenantId, string, CancellationToken)

public Task AssignGroupToTenantAsync(TenantId tenantId, string groupId, CancellationToken ct = default)

Assign a group to a tenant Assigns a group to a specified tenant. Group members (users, clients) can then access tenant data and perform authorized actions.

Parameter	Type	Description
tenantId	TenantId
groupId	String
ct	CancellationToken

Returns: Task

AssignMappingRuleToTenantAsync(TenantId, string, CancellationToken)

public Task AssignMappingRuleToTenantAsync(TenantId tenantId, string mappingRuleId, CancellationToken ct = default)

Assign a mapping rule to a tenant Assign a single mapping rule to a specified tenant.

Parameter	Type	Description
tenantId	TenantId
mappingRuleId	String
ct	CancellationToken

Returns: Task

AssignRoleToTenantAsync(TenantId, string, CancellationToken)

public Task AssignRoleToTenantAsync(TenantId tenantId, string roleId, CancellationToken ct = default)

Assign a role to a tenant Assigns a role to a specified tenant. Users, Clients or Groups, that have the role assigned, will get access to the tenant's data and can perform actions according to their authorizations.

Parameter	Type	Description
tenantId	TenantId
roleId	String
ct	CancellationToken

Returns: Task

AssignUserToTenantAsync(TenantId, Username, CancellationToken)

public Task AssignUserToTenantAsync(TenantId tenantId, Username username, CancellationToken ct = default)

Assign a user to a tenant Assign a single user to a specified tenant. The user can then access tenant data and perform authorized actions.

Parameter	Type	Description
tenantId	TenantId
username	Username
ct	CancellationToken

Returns: Task

CreateTenantAsync(TenantCreateRequest, CancellationToken)

public Task<TenantCreateResult> CreateTenantAsync(TenantCreateRequest body, CancellationToken ct = default)

Create tenant Creates a new tenant.

Parameter	Type	Description
body	TenantCreateRequest
ct	CancellationToken

Returns: Task<TenantCreateResult>

DeleteTenantAsync(TenantId, CancellationToken)

public Task DeleteTenantAsync(TenantId tenantId, CancellationToken ct = default)

Delete tenant Deletes an existing tenant.

Parameter	Type	Description
tenantId	TenantId
ct	CancellationToken

Returns: Task

GetTenantAsync(TenantId, ConsistencyOptions?, CancellationToken)

public Task<TenantResult> GetTenantAsync(TenantId tenantId, ConsistencyOptions<TenantResult>? consistency = null, CancellationToken ct = default)

Get tenant Retrieves a single tenant by tenant ID.

Parameter	Type	Description
tenantId	TenantId
consistency	ConsistencyOptions<TenantResult>
ct	CancellationToken

Returns: Task<TenantResult>

GetUsageMetricsAsync(DateTimeOffset, DateTimeOffset, TenantId?, bool?, ConsistencyOptions?, CancellationToken)

public Task<UsageMetricsResponse> GetUsageMetricsAsync(DateTimeOffset startTime, DateTimeOffset endTime, TenantId? tenantId = null, bool? withTenants = null, ConsistencyOptions<UsageMetricsResponse>? consistency = null, CancellationToken ct = default)

Get usage metrics Retrieve the usage metrics based on given criteria.

Parameter	Type	Description
startTime	DateTimeOffset
endTime	DateTimeOffset
tenantId	Nullable<TenantId>
withTenants	Nullable<Boolean>
consistency	ConsistencyOptions<UsageMetricsResponse>
ct	CancellationToken

Returns: Task<UsageMetricsResponse>

SearchClientsForTenantAsync(TenantId, SearchClientsForTenantRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchClientsForTenantResponse> SearchClientsForTenantAsync(TenantId tenantId, SearchClientsForTenantRequest body, ConsistencyOptions<SearchClientsForTenantResponse>? consistency = null, CancellationToken ct = default)

Search clients for tenant Retrieves a filtered and sorted list of clients for a specified tenant.

Parameter	Type	Description
tenantId	TenantId
body	SearchClientsForTenantRequest
consistency	ConsistencyOptions<SearchClientsForTenantResponse>
ct	CancellationToken

Returns: Task<SearchClientsForTenantResponse>

SearchGroupIdsForTenantAsync(TenantId, TenantGroupSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<TenantGroupSearchResult> SearchGroupIdsForTenantAsync(TenantId tenantId, TenantGroupSearchQueryRequest body, ConsistencyOptions<TenantGroupSearchResult>? consistency = null, CancellationToken ct = default)

Search groups for tenant Retrieves a filtered and sorted list of groups for a specified tenant.

Parameter	Type	Description
tenantId	TenantId
body	TenantGroupSearchQueryRequest
consistency	ConsistencyOptions<TenantGroupSearchResult>
ct	CancellationToken

Returns: Task<TenantGroupSearchResult>

SearchMappingRulesForTenantAsync(TenantId, MappingRuleSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchMappingRulesForTenantResponse> SearchMappingRulesForTenantAsync(TenantId tenantId, MappingRuleSearchQueryRequest body, ConsistencyOptions<SearchMappingRulesForTenantResponse>? consistency = null, CancellationToken ct = default)

Search mapping rules for tenant Retrieves a filtered and sorted list of MappingRules for a specified tenant.

Parameter	Type	Description
tenantId	TenantId
body	MappingRuleSearchQueryRequest
consistency	ConsistencyOptions<SearchMappingRulesForTenantResponse>
ct	CancellationToken

Returns: Task<SearchMappingRulesForTenantResponse>

SearchRolesForTenantAsync(TenantId, RoleSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchRolesForTenantResponse> SearchRolesForTenantAsync(TenantId tenantId, RoleSearchQueryRequest body, ConsistencyOptions<SearchRolesForTenantResponse>? consistency = null, CancellationToken ct = default)

Search roles for tenant Retrieves a filtered and sorted list of roles for a specified tenant.

Parameter	Type	Description
tenantId	TenantId
body	RoleSearchQueryRequest
consistency	ConsistencyOptions<SearchRolesForTenantResponse>
ct	CancellationToken

Returns: Task<SearchRolesForTenantResponse>

SearchTenantsAsync(TenantSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<TenantSearchQueryResult> SearchTenantsAsync(TenantSearchQueryRequest body, ConsistencyOptions<TenantSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search tenants Retrieves a filtered and sorted list of tenants.

Parameter	Type	Description
body	TenantSearchQueryRequest
consistency	ConsistencyOptions<TenantSearchQueryResult>
ct	CancellationToken

Returns: Task<TenantSearchQueryResult>

SearchUsersForTenantAsync(TenantId, SearchUsersForTenantRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchUsersForTenantResponse> SearchUsersForTenantAsync(TenantId tenantId, SearchUsersForTenantRequest body, ConsistencyOptions<SearchUsersForTenantResponse>? consistency = null, CancellationToken ct = default)

Search users for tenant Retrieves a filtered and sorted list of users for a specified tenant.

Parameter	Type	Description
tenantId	TenantId
body	SearchUsersForTenantRequest
consistency	ConsistencyOptions<SearchUsersForTenantResponse>
ct	CancellationToken

Returns: Task<SearchUsersForTenantResponse>

UnassignClientFromTenantAsync(TenantId, string, CancellationToken)

public Task UnassignClientFromTenantAsync(TenantId tenantId, string clientId, CancellationToken ct = default)

Unassign a client from a tenant Unassigns the client from the specified tenant. The client can no longer access tenant data.

Parameter	Type	Description
tenantId	TenantId
clientId	String
ct	CancellationToken

Returns: Task

UnassignGroupFromTenantAsync(TenantId, string, CancellationToken)

public Task UnassignGroupFromTenantAsync(TenantId tenantId, string groupId, CancellationToken ct = default)

Unassign a group from a tenant Unassigns a group from a specified tenant. Members of the group (users, clients) will no longer have access to the tenant's data - except they are assigned directly to the tenant.

Parameter	Type	Description
tenantId	TenantId
groupId	String
ct	CancellationToken

Returns: Task

UnassignMappingRuleFromTenantAsync(TenantId, string, CancellationToken)

public Task UnassignMappingRuleFromTenantAsync(TenantId tenantId, string mappingRuleId, CancellationToken ct = default)

Unassign a mapping rule from a tenant Unassigns a single mapping rule from a specified tenant without deleting the rule.

Parameter	Type	Description
tenantId	TenantId
mappingRuleId	String
ct	CancellationToken

Returns: Task

UnassignRoleFromTenantAsync(TenantId, string, CancellationToken)

public Task UnassignRoleFromTenantAsync(TenantId tenantId, string roleId, CancellationToken ct = default)

Unassign a role from a tenant Unassigns a role from a specified tenant. Users, Clients or Groups, that have the role assigned, will no longer have access to the tenant's data - unless they are assigned directly to the tenant.

Parameter	Type	Description
tenantId	TenantId
roleId	String
ct	CancellationToken

Returns: Task

UnassignUserFromTenantAsync(TenantId, Username, CancellationToken)

public Task UnassignUserFromTenantAsync(TenantId tenantId, Username username, CancellationToken ct = default)

Unassign a user from a tenant Unassigns the user from the specified tenant. The user can no longer access tenant data.

Parameter	Type	Description
tenantId	TenantId
username	Username
ct	CancellationToken

Returns: Task

UpdateTenantAsync(TenantId, TenantUpdateRequest, CancellationToken)

public Task<TenantUpdateResult> UpdateTenantAsync(TenantId tenantId, TenantUpdateRequest body, CancellationToken ct = default)

Update tenant Updates an existing tenant.

Parameter	Type	Description
tenantId	TenantId
body	TenantUpdateRequest
ct	CancellationToken

Returns: Task<TenantUpdateResult>

Roles

AssignRoleToClientAsync(string, string, CancellationToken)

public Task AssignRoleToClientAsync(string roleId, string clientId, CancellationToken ct = default)

Assign a role to a client Assigns the specified role to the client. The client will inherit the authorizations associated with this role.

Parameter	Type	Description
roleId	String
clientId	String
ct	CancellationToken

Returns: Task

AssignRoleToGroupAsync(string, string, CancellationToken)

public Task AssignRoleToGroupAsync(string roleId, string groupId, CancellationToken ct = default)

Assign a role to a group Assigns the specified role to the group. Every member of the group (user or client) will inherit the authorizations associated with this role.

Parameter	Type	Description
roleId	String
groupId	String
ct	CancellationToken

Returns: Task

AssignRoleToMappingRuleAsync(string, string, CancellationToken)

public Task AssignRoleToMappingRuleAsync(string roleId, string mappingRuleId, CancellationToken ct = default)

Assign a role to a mapping rule Assigns a role to a mapping rule.

Parameter	Type	Description
roleId	String
mappingRuleId	String
ct	CancellationToken

Returns: Task

AssignRoleToUserAsync(string, Username, CancellationToken)

public Task AssignRoleToUserAsync(string roleId, Username username, CancellationToken ct = default)

Assign a role to a user Assigns the specified role to the user. The user will inherit the authorizations associated with this role.

Parameter	Type	Description
roleId	String
username	Username
ct	CancellationToken

Returns: Task

CreateRoleAsync(RoleCreateRequest, CancellationToken)

public Task<RoleCreateResult> CreateRoleAsync(RoleCreateRequest body, CancellationToken ct = default)

Create role Create a new role.

Parameter	Type	Description
body	RoleCreateRequest
ct	CancellationToken

Returns: Task<RoleCreateResult>

DeleteRoleAsync(string, CancellationToken)

public Task DeleteRoleAsync(string roleId, CancellationToken ct = default)

Delete role Deletes the role with the given ID.

Parameter	Type	Description
roleId	String
ct	CancellationToken

Returns: Task

GetRoleAsync(string, ConsistencyOptions?, CancellationToken)

public Task<RoleResult> GetRoleAsync(string roleId, ConsistencyOptions<RoleResult>? consistency = null, CancellationToken ct = default)

Get role Get a role by its ID.

Parameter	Type	Description
roleId	String
consistency	ConsistencyOptions<RoleResult>
ct	CancellationToken

Returns: Task<RoleResult>

SearchClientsForRoleAsync(string, SearchClientsForRoleRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchClientsForRoleResponse> SearchClientsForRoleAsync(string roleId, SearchClientsForRoleRequest body, ConsistencyOptions<SearchClientsForRoleResponse>? consistency = null, CancellationToken ct = default)

Search role clients Search clients with assigned role.

Parameter	Type	Description
roleId	String
body	SearchClientsForRoleRequest
consistency	ConsistencyOptions<SearchClientsForRoleResponse>
ct	CancellationToken

Returns: Task<SearchClientsForRoleResponse>

SearchGroupsForRoleAsync(string, RoleGroupSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<RoleGroupSearchResult> SearchGroupsForRoleAsync(string roleId, RoleGroupSearchQueryRequest body, ConsistencyOptions<RoleGroupSearchResult>? consistency = null, CancellationToken ct = default)

Search role groups Search groups with assigned role.

Parameter	Type	Description
roleId	String
body	RoleGroupSearchQueryRequest
consistency	ConsistencyOptions<RoleGroupSearchResult>
ct	CancellationToken

Returns: Task<RoleGroupSearchResult>

SearchMappingRulesForRoleAsync(string, MappingRuleSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchMappingRulesForRoleResponse> SearchMappingRulesForRoleAsync(string roleId, MappingRuleSearchQueryRequest body, ConsistencyOptions<SearchMappingRulesForRoleResponse>? consistency = null, CancellationToken ct = default)

Search role mapping rules Search mapping rules with assigned role.

Parameter	Type	Description
roleId	String
body	MappingRuleSearchQueryRequest
consistency	ConsistencyOptions<SearchMappingRulesForRoleResponse>
ct	CancellationToken

Returns: Task<SearchMappingRulesForRoleResponse>

SearchRolesAsync(RoleSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<RoleSearchQueryResult> SearchRolesAsync(RoleSearchQueryRequest body, ConsistencyOptions<RoleSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search roles Search for roles based on given criteria.

Parameter	Type	Description
body	RoleSearchQueryRequest
consistency	ConsistencyOptions<RoleSearchQueryResult>
ct	CancellationToken

Returns: Task<RoleSearchQueryResult>

SearchRolesForGroupAsync(string, RoleSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchRolesForGroupResponse> SearchRolesForGroupAsync(string groupId, RoleSearchQueryRequest body, ConsistencyOptions<SearchRolesForGroupResponse>? consistency = null, CancellationToken ct = default)

Search group roles Search roles assigned to a group.

Parameter	Type	Description
groupId	String
body	RoleSearchQueryRequest
consistency	ConsistencyOptions<SearchRolesForGroupResponse>
ct	CancellationToken

Returns: Task<SearchRolesForGroupResponse>

SearchUsersForRoleAsync(string, SearchUsersForRoleRequest, ConsistencyOptions?, CancellationToken)

public Task<SearchUsersForRoleResponse> SearchUsersForRoleAsync(string roleId, SearchUsersForRoleRequest body, ConsistencyOptions<SearchUsersForRoleResponse>? consistency = null, CancellationToken ct = default)

Search role users Search users with assigned role.

Parameter	Type	Description
roleId	String
body	SearchUsersForRoleRequest
consistency	ConsistencyOptions<SearchUsersForRoleResponse>
ct	CancellationToken

Returns: Task<SearchUsersForRoleResponse>

UnassignRoleFromClientAsync(string, string, CancellationToken)

public Task UnassignRoleFromClientAsync(string roleId, string clientId, CancellationToken ct = default)

Unassign a role from a client Unassigns the specified role from the client. The client will no longer inherit the authorizations associated with this role.

Parameter	Type	Description
roleId	String
clientId	String
ct	CancellationToken

Returns: Task

UnassignRoleFromGroupAsync(string, string, CancellationToken)

public Task UnassignRoleFromGroupAsync(string roleId, string groupId, CancellationToken ct = default)

Unassign a role from a group Unassigns the specified role from the group. All group members (user or client) no longer inherit the authorizations associated with this role.

Parameter	Type	Description
roleId	String
groupId	String
ct	CancellationToken

Returns: Task

UnassignRoleFromMappingRuleAsync(string, string, CancellationToken)

public Task UnassignRoleFromMappingRuleAsync(string roleId, string mappingRuleId, CancellationToken ct = default)

Unassign a role from a mapping rule Unassigns a role from a mapping rule.

Parameter	Type	Description
roleId	String
mappingRuleId	String
ct	CancellationToken

Returns: Task

UnassignRoleFromUserAsync(string, Username, CancellationToken)

public Task UnassignRoleFromUserAsync(string roleId, Username username, CancellationToken ct = default)

Unassign a role from a user Unassigns a role from a user. The user will no longer inherit the authorizations associated with this role.

Parameter	Type	Description
roleId	String
username	Username
ct	CancellationToken

Returns: Task

UpdateRoleAsync(string, RoleUpdateRequest, CancellationToken)

public Task<RoleUpdateResult> UpdateRoleAsync(string roleId, RoleUpdateRequest body, CancellationToken ct = default)

Update role Update a role with the given ID.

Parameter	Type	Description
roleId	String
body	RoleUpdateRequest
ct	CancellationToken

Returns: Task<RoleUpdateResult>

User Tasks

AssignUserTaskAsync(UserTaskKey, UserTaskAssignmentRequest, CancellationToken)

public Task AssignUserTaskAsync(UserTaskKey userTaskKey, UserTaskAssignmentRequest body, CancellationToken ct = default)

Assign user task Assigns a user task with the given key to the given assignee. Assignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats.

Parameter	Type	Description
userTaskKey	UserTaskKey
body	UserTaskAssignmentRequest
ct	CancellationToken

Returns: Task

CompleteUserTaskAsync(UserTaskKey, UserTaskCompletionRequest, CancellationToken)

public Task CompleteUserTaskAsync(UserTaskKey userTaskKey, UserTaskCompletionRequest body, CancellationToken ct = default)

Complete user task Completes a user task with the given key. Completion waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats.

Parameter	Type	Description
userTaskKey	UserTaskKey
body	UserTaskCompletionRequest
ct	CancellationToken

Returns: Task

GetUserTaskAsync(UserTaskKey, ConsistencyOptions?, CancellationToken)

public Task<UserTaskResult> GetUserTaskAsync(UserTaskKey userTaskKey, ConsistencyOptions<UserTaskResult>? consistency = null, CancellationToken ct = default)

Get user task Get the user task by the user task key.

Parameter	Type	Description
userTaskKey	UserTaskKey
consistency	ConsistencyOptions<UserTaskResult>
ct	CancellationToken

Returns: Task<UserTaskResult>

GetUserTaskFormAsync(UserTaskKey, ConsistencyOptions?, CancellationToken)

public Task<FormResult> GetUserTaskFormAsync(UserTaskKey userTaskKey, ConsistencyOptions<FormResult>? consistency = null, CancellationToken ct = default)

Get user task form Get the form of a user task. Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.

Parameter	Type	Description
userTaskKey	UserTaskKey
consistency	ConsistencyOptions<FormResult>
ct	CancellationToken

Returns: Task<FormResult>

SearchUserTaskAuditLogsAsync(UserTaskKey, UserTaskAuditLogSearchQueryRequest, ConsistencyOptions?, CancellationToken)

public Task<AuditLogSearchQueryResult> SearchUserTaskAuditLogsAsync(UserTaskKey userTaskKey, UserTaskAuditLogSearchQueryRequest body, ConsistencyOptions<AuditLogSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search user task audit logs Search for user task audit logs based on given criteria.

Parameter	Type	Description
userTaskKey	UserTaskKey
body	UserTaskAuditLogSearchQueryRequest
consistency	ConsistencyOptions<AuditLogSearchQueryResult>
ct	CancellationToken

Returns: Task<AuditLogSearchQueryResult>

SearchUserTaskVariablesAsync(UserTaskKey, SearchUserTaskVariablesRequest, bool?, ConsistencyOptions?, CancellationToken)

public Task<VariableSearchQueryResult> SearchUserTaskVariablesAsync(UserTaskKey userTaskKey, SearchUserTaskVariablesRequest body, bool? truncateValues = null, ConsistencyOptions<VariableSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search user task variables Search for user task variables based on given criteria. This endpoint returns all variables visible from the user task's scope, including variables from parent scopes in the scope hierarchy. By default, long variable values in the response are truncated.

Parameter	Type	Description
userTaskKey	UserTaskKey
body	SearchUserTaskVariablesRequest
truncateValues	Nullable<Boolean>
consistency	ConsistencyOptions<VariableSearchQueryResult>
ct	CancellationToken

Returns: Task<VariableSearchQueryResult>

SearchUserTasksAsync(UserTaskSearchQuery, ConsistencyOptions?, CancellationToken)

public Task<UserTaskSearchQueryResult> SearchUserTasksAsync(UserTaskSearchQuery body, ConsistencyOptions<UserTaskSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search user tasks Search for user tasks based on given criteria.

Parameter	Type	Description
body	UserTaskSearchQuery
consistency	ConsistencyOptions<UserTaskSearchQueryResult>
ct	CancellationToken

Returns: Task<UserTaskSearchQueryResult>

UnassignUserTaskAsync(UserTaskKey, CancellationToken)

public Task UnassignUserTaskAsync(UserTaskKey userTaskKey, CancellationToken ct = default)

Unassign user task Removes the assignee of a task with the given key. Unassignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats.

Parameter	Type	Description
userTaskKey	UserTaskKey
ct	CancellationToken

Returns: Task

UpdateUserTaskAsync(UserTaskKey, UserTaskUpdateRequest, CancellationToken)

public Task UpdateUserTaskAsync(UserTaskKey userTaskKey, UserTaskUpdateRequest body, CancellationToken ct = default)

Update user task Update a user task with the given key. Updates wait for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats.

Parameter	Type	Description
userTaskKey	UserTaskKey
body	UserTaskUpdateRequest
ct	CancellationToken

Returns: Task

Signals

BroadcastSignalAsync(SignalBroadcastRequest, CancellationToken)

public Task<SignalBroadcastResult> BroadcastSignalAsync(SignalBroadcastRequest body, CancellationToken ct = default)

Broadcast signal Broadcasts a signal.

Parameter	Type	Description
body	SignalBroadcastRequest
ct	CancellationToken

Returns: Task<SignalBroadcastResult>

Batch Operations

CancelBatchOperationAsync(BatchOperationKey, CancellationToken)

public Task CancelBatchOperationAsync(BatchOperationKey batchOperationKey, CancellationToken ct = default)

Cancel Batch operation Cancels a running batch operation. This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Parameter	Type	Description
batchOperationKey	BatchOperationKey
ct	CancellationToken

Returns: Task

GetBatchOperationAsync(BatchOperationKey, ConsistencyOptions?, CancellationToken)

public Task<BatchOperationResponse> GetBatchOperationAsync(BatchOperationKey batchOperationKey, ConsistencyOptions<BatchOperationResponse>? consistency = null, CancellationToken ct = default)

Get batch operation Get batch operation by key.

Parameter	Type	Description
batchOperationKey	BatchOperationKey
consistency	ConsistencyOptions<BatchOperationResponse>
ct	CancellationToken

Returns: Task<BatchOperationResponse>

ResumeBatchOperationAsync(BatchOperationKey, CancellationToken)

public Task ResumeBatchOperationAsync(BatchOperationKey batchOperationKey, CancellationToken ct = default)

Resume Batch operation Resumes a suspended batch operation. This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Parameter	Type	Description
batchOperationKey	BatchOperationKey
ct	CancellationToken

Returns: Task

SearchBatchOperationItemsAsync(BatchOperationItemSearchQuery, ConsistencyOptions?, CancellationToken)

public Task<BatchOperationItemSearchQueryResult> SearchBatchOperationItemsAsync(BatchOperationItemSearchQuery body, ConsistencyOptions<BatchOperationItemSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search batch operation items Search for batch operation items based on given criteria.

Parameter	Type	Description
body	BatchOperationItemSearchQuery
consistency	ConsistencyOptions<BatchOperationItemSearchQueryResult>
ct	CancellationToken

Returns: Task<BatchOperationItemSearchQueryResult>

SearchBatchOperationsAsync(BatchOperationSearchQuery, ConsistencyOptions?, CancellationToken)

public Task<BatchOperationSearchQueryResult> SearchBatchOperationsAsync(BatchOperationSearchQuery body, ConsistencyOptions<BatchOperationSearchQueryResult>? consistency = null, CancellationToken ct = default)

Search batch operations Search for batch operations based on given criteria.

Parameter	Type	Description
body	BatchOperationSearchQuery
consistency	ConsistencyOptions<BatchOperationSearchQueryResult>
ct	CancellationToken

Returns: Task<BatchOperationSearchQueryResult>

SuspendBatchOperationAsync(BatchOperationKey, CancellationToken)

public Task SuspendBatchOperationAsync(BatchOperationKey batchOperationKey, CancellationToken ct = default)

Suspend Batch operation Suspends a running batch operation. This is done asynchronously, the progress can be tracked using the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Parameter	Type	Description
batchOperationKey	BatchOperationKey
ct	CancellationToken

Returns: Task

Process Instances

CancelProcessInstanceAsync(ProcessInstanceKey, CancelProcessInstanceRequest, CancellationToken)

public Task CancelProcessInstanceAsync(ProcessInstanceKey processInstanceKey, CancelProcessInstanceRequest body, CancellationToken ct = default)

Cancel process instance Cancels a running process instance. As a cancellation includes more than just the removal of the process instance resource, the cancellation resource must be posted. Cancellation can wait on listener-related processing; when that processing does not complete in time, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats.

Parameter	Type	Description
processInstanceKey	ProcessInstanceKey
body	CancelProcessInstanceRequest
ct	CancellationToken

Returns: Task

CancelProcessInstancesBatchOperationAsync(ProcessInstanceCancellationBatchOperationRequest, CancellationToken)

public Task<BatchOperationCreatedResult> CancelProcessInstancesBatchOperationAsync(ProcessInstanceCancellationBatchOperationRequest body, CancellationToken ct = default)

Cancel process instances (batch) Cancels multiple running process instances. Since only ACTIVE root instances can be cancelled, any given filters for state and parentProcessInstanceKey are ignored and overridden during this batch operation. This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Parameter	Type	Description
body	ProcessInstanceCancellationBatchOperationRequest
ct	CancellationToken

Returns: Task<BatchOperationCreatedResult>

CreateProcessInstanceAsync(ProcessInstanceCreationInstruction, CancellationToken)

public Task<CreateProcessInstanceResult> CreateProcessInstanceAsync(ProcessInstanceCreationInstruction body, CancellationToken ct = default)

Create process instance Creates and starts an instance of the specified process. The process definition to use to create the instance can be specified either using its unique key (as returned by Deploy resources), or using the BPMN process id and a version.

Waits for the completion of the process instance before returning a result when awaitCompletion is enabled.

Parameter	Type	Description
body	ProcessInstanceCreationInstruction
ct	CancellationToken

Returns: Task<CreateProcessInstanceResult>

DeleteProcessInstanceAsync(ProcessInstanceKey, DeleteProcessInstanceRequest, CancellationToken)

public Task DeleteProcessInstanceAsync(ProcessInstanceKey processInstanceKey, DeleteProcessInstanceRequest body, CancellationToken ct = default)

Delete process instance Deletes a process instance. Only instances that are completed or terminated can be deleted.

Parameter	Type	Description
processInstanceKey	ProcessInstanceKey
body	DeleteProcessInstanceRequest
ct	CancellationToken

Returns: Task

DeleteProcessInstancesBatchOperationAsync(ProcessInstanceDeletionBatchOperationRequest, CancellationToken)

public Task<BatchOperationCreatedResult> DeleteProcessInstancesBatchOperationAsync(ProcessInstanceDeletionBatchOperationRequest body, CancellationToken ct = default)

Delete process instances (batch) Delete multiple process instances. This will delete the historic data from secondary storage. Only process instances in a final state (COMPLETED or TERMINATED) can be deleted. This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Parameter	Type	Description
body	ProcessInstanceDeletionBatchOperationRequest
ct	CancellationToken

Returns: Task<BatchOperationCreatedResult>

GetProcessInstanceAsync(ProcessInstanceKey, ConsistencyOptions?, CancellationToken)

public Task<ProcessInstanceResult> GetProcessInstanceAsync(ProcessInstanceKey processInstanceKey, ConsistencyOptions<ProcessInstanceResult>? consistency = null, CancellationToken ct = default)

Get process instance Get the process instance by the process instance key.

Parameter	Type	Description
processInstanceKey	ProcessInstanceKey
consistency	ConsistencyOptions<ProcessInstanceResult>
ct	CancellationToken

Returns: Task<ProcessInstanceResult>

GetProcessInstanceCallHierarchyAsync(ProcessInstanceKey, ConsistencyOptions