openapi: "3.0.3"
info:
  title: Orchestration Cluster API
  version: "0.1"
  contact:
    name: Camunda Engineering
    url: https://github.com/camunda/camunda/issues
  description: |
    API for communicating with a Camunda 8 cluster.

    ## Conventions

    ### Enum value casing

    Server-side, enum-typed request fields accept any casing of a
    documented value (for example `ACTIVE`, `active`, and `Active` are
    all accepted on input). Responses always use the canonical casing
    shown in this specification.

    This permissive request behavior is a server-side convenience and
    is **not** part of the OpenAPI enum contract — SDKs generated from
    this specification by strict generators may reject non-canonical
    casing on the client side. For portability across SDKs, always
    send the canonical casing shown in this document.
  license:
    name: Camunda License Version 1.0
    url: https://github.com/camunda/camunda/blob/main/licenses/CAMUNDA-LICENSE-1.0.txt
externalDocs:
  description: Find out more
  url: https://docs.camunda.io/docs/apis-tools/orchestration-cluster-api-rest/orchestration-cluster-api-rest-overview/
servers:
  - url: "{schema}://{host}:{port}/v2"
    variables:
      host:
        default: localhost
        description: The hostname of the Orchestration Cluster REST Gateway.
      port:
        default: "8080"
        description: The port of the Orchestration Cluster REST API server.
      schema:
        default: http
        description: The schema of the Orchestration Cluster REST API server.
tags:
  - name: Ad-hoc sub-process
  - name: Agent definition
  - name: Agent instance
  - name: Audit Log
  - name: Authentication
  - name: Authorization
  - name: Backup
  - name: Batch operation
  - name: Clock
  - name: Cluster
  - name: Cluster Variable
  - name: Conditional
  - name: Decision definition
  - name: Decision instance
  - name: Decision requirements
  - name: Document
  - name: Element instance
  - name: Exporting
  - name: Expression
  - name: Form
  - name: Global listener
  - name: Group
  - name: Incident
  - name: Job
  - name: Job metrics
  - name: License
  - name: Mapping rule
  - name: Message
  - name: Message subscription
  - name: Process definition
  - name: Process instance
  - name: Recovery
  - name: Resource
  - name: Role
  - name: Secret
  - name: Setup
  - name: Signal
  - name: System
  - name: Tenant
  - name: User
  - name: User task
  - name: Variable

paths:
  # Agent definition endpoints
  /agent-definitions/{agentDefinitionKey}:
    $ref: 'agent-definitions.yaml#/paths/~1agent-definitions~1{agentDefinitionKey}'
  /agent-definitions/search:
    $ref: 'agent-definitions.yaml#/paths/~1agent-definitions~1search'

  # Agent instance endpoints
  /agent-instances:
    $ref: 'agent-instances.yaml#/paths/~1agent-instances'
  /agent-instances/{agentInstanceKey}:
    $ref: 'agent-instances.yaml#/paths/~1agent-instances~1{agentInstanceKey}'
  /agent-instances/search:
    $ref: 'agent-instances.yaml#/paths/~1agent-instances~1search'
  /agent-instances/{agentInstanceKey}/history/search:
    $ref: 'agent-instances.yaml#/paths/~1agent-instances~1{agentInstanceKey}~1history~1search'

  # Audit Log endpoints
  /audit-logs/search:
    $ref: 'audit-logs.yaml#/paths/~1audit-logs~1search'
  /audit-logs/{auditLogKey}:
    $ref: 'audit-logs.yaml#/paths/~1audit-logs~1{auditLogKey}'

  # Authentication endpoints
  /authentication/me:
    $ref: 'authentication.yaml#/paths/~1authentication~1me'
  /authentication/me/authorizations/search:
    $ref: 'authentication.yaml#/paths/~1authentication~1me~1authorizations~1search'

  # Authorization endpoints
  /authorizations:
    $ref: 'authorizations.yaml#/paths/~1authorizations'
  /authorizations/search:
    $ref: 'authorizations.yaml#/paths/~1authorizations~1search'
  /authorizations/{authorizationKey}:
    $ref: 'authorizations.yaml#/paths/~1authorizations~1{authorizationKey}'

  # Backup endpoints
  /backups/runtime:
    $ref: 'backups.yaml#/paths/~1backups~1runtime'
  /backups/runtime/state:
    $ref: 'backups.yaml#/paths/~1backups~1runtime~1state'
  /backups/runtime/state/sync:
    $ref: 'backups.yaml#/paths/~1backups~1runtime~1state~1sync'
  /backups/runtime/{backupId}:
    $ref: 'backups.yaml#/paths/~1backups~1runtime~1{backupId}'
  /backups/history:
    $ref: 'backups.yaml#/paths/~1backups~1history'
  /backups/history/{backupId}:
    $ref: 'backups.yaml#/paths/~1backups~1history~1{backupId}'

  # Batch operation endpoints
  /batch-operation-items/search:
    $ref: 'batch-operations.yaml#/paths/~1batch-operation-items~1search'
  /batch-operations/search:
    $ref: 'batch-operations.yaml#/paths/~1batch-operations~1search'
  /batch-operations/{batchOperationKey}:
    $ref: 'batch-operations.yaml#/paths/~1batch-operations~1{batchOperationKey}'
  /batch-operations/{batchOperationKey}/cancellation:
    $ref: 'batch-operations.yaml#/paths/~1batch-operations~1{batchOperationKey}~1cancellation'
  /batch-operations/{batchOperationKey}/resumption:
    $ref: 'batch-operations.yaml#/paths/~1batch-operations~1{batchOperationKey}~1resumption'
  /batch-operations/{batchOperationKey}/suspension:
    $ref: 'batch-operations.yaml#/paths/~1batch-operations~1{batchOperationKey}~1suspension'

  # Clock endpoints
  /clock:
    $ref: 'clock.yaml#/paths/~1clock'
  /clock/reset:
    $ref: 'clock.yaml#/paths/~1clock~1reset'

  # Cluster variables endpoints
  /cluster-variables/global:
    $ref: 'cluster-variables.yaml#/paths/~1cluster-variables~1global'
  /cluster-variables/global/{name}:
    $ref: 'cluster-variables.yaml#/paths/~1cluster-variables~1global~1{name}'
  /cluster-variables/search:
    $ref: 'cluster-variables.yaml#/paths/~1cluster-variables~1search'
  /cluster-variables/tenants/{tenantId}:
    $ref: 'cluster-variables.yaml#/paths/~1cluster-variables~1tenants~1{tenantId}'
  /cluster-variables/tenants/{tenantId}/{name}:
    $ref: 'cluster-variables.yaml#/paths/~1cluster-variables~1tenants~1{tenantId}~1{name}'

  # Conditional endpoints
  /conditionals/evaluation:
    $ref: 'conditionals.yaml#/paths/~1conditionals~1evaluation'

  # Message endpoints
  /correlated-message-subscriptions/search:
    $ref: 'messages.yaml#/paths/~1correlated-message-subscriptions~1search'

  # Decision definition endpoints
  /decision-definitions/evaluation:
    $ref: 'decision-definitions.yaml#/paths/~1decision-definitions~1evaluation'
  /decision-definitions/search:
    $ref: 'decision-definitions.yaml#/paths/~1decision-definitions~1search'
  /decision-definitions/{decisionDefinitionKey}:
    $ref: 'decision-definitions.yaml#/paths/~1decision-definitions~1{decisionDefinitionKey}'
  /decision-definitions/{decisionDefinitionKey}/xml:
    $ref: 'decision-definitions.yaml#/paths/~1decision-definitions~1{decisionDefinitionKey}~1xml'

  # Decision instance endpoints
  /decision-instances/search:
    $ref: 'decision-instances.yaml#/paths/~1decision-instances~1search'
  /decision-instances/{decisionEvaluationInstanceKey}:
    $ref: 'decision-instances.yaml#/paths/~1decision-instances~1{decisionEvaluationInstanceKey}'
  /decision-instances/{decisionEvaluationKey}/deletion:
    $ref: 'decision-instances.yaml#/paths/~1decision-instances~1{decisionEvaluationKey}~1deletion'
  /decision-instances/deletion:
    $ref: 'decision-instances.yaml#/paths/~1decision-instances~1deletion'

  # Decision requirements endpoints
  /decision-requirements/search:
    $ref: 'decision-requirements.yaml#/paths/~1decision-requirements~1search'
  /decision-requirements/{decisionRequirementsKey}:
    $ref: 'decision-requirements.yaml#/paths/~1decision-requirements~1{decisionRequirementsKey}'
  /decision-requirements/{decisionRequirementsKey}/xml:
    $ref: 'decision-requirements.yaml#/paths/~1decision-requirements~1{decisionRequirementsKey}~1xml'

  # Deployment/Resource endpoints
  /deployments:
    $ref: 'deployments.yaml#/paths/~1deployments'

  # Document endpoints
  /documents:
    $ref: 'documents.yaml#/paths/~1documents'
  /documents/batch:
    $ref: 'documents.yaml#/paths/~1documents~1batch'
  /documents/{documentId}:
    $ref: 'documents.yaml#/paths/~1documents~1{documentId}'
  /documents/{documentId}/links:
    $ref: 'documents.yaml#/paths/~1documents~1{documentId}~1links'

  # Element instance endpoints
  /element-instances/ad-hoc-activities/{adHocSubProcessInstanceKey}/activation:
    $ref: 'element-instances.yaml#/paths/~1element-instances~1ad-hoc-activities~1{adHocSubProcessInstanceKey}~1activation'
  /element-instances/wait-states/search:
    $ref: 'element-instances.yaml#/paths/~1element-instances~1wait-states~1search'
  /element-instances/search:
    $ref: 'element-instances.yaml#/paths/~1element-instances~1search'
  /element-instances/{elementInstanceKey}:
    $ref: 'element-instances.yaml#/paths/~1element-instances~1{elementInstanceKey}'
  /element-instances/{elementInstanceKey}/incidents/search:
    $ref: 'element-instances.yaml#/paths/~1element-instances~1{elementInstanceKey}~1incidents~1search'
  /element-instances/{elementInstanceKey}/variables:
    $ref: 'element-instances.yaml#/paths/~1element-instances~1{elementInstanceKey}~1variables'

  # Exporting endpoints
  /exporting:
    $ref: 'exporting.yaml#/paths/~1exporting'
  /exporting/pause:
    $ref: 'exporting.yaml#/paths/~1exporting~1pause'
  /exporting/resume:
    $ref: 'exporting.yaml#/paths/~1exporting~1resume'

  # Expression endpoints
  /expression/evaluation:
    $ref: 'expression.yaml#/paths/~1expression~1evaluation'

  # Form endpoints
  /forms/{formKey}:
    $ref: 'forms.yaml#/paths/~1forms~1{formKey}'

  # Global listeners endpoints
  /global-task-listeners:
    $ref: 'global-listeners.yaml#/paths/~1global-task-listeners'
  /global-task-listeners/{id}:
    $ref: 'global-listeners.yaml#/paths/~1global-task-listeners~1{id}'
  /global-task-listeners/search:
    $ref: 'global-listeners.yaml#/paths/~1global-task-listeners~1search'

  # Group endpoints
  /groups:
    $ref: 'groups.yaml#/paths/~1groups'
  /groups/search:
    $ref: 'groups.yaml#/paths/~1groups~1search'
  /groups/{groupId}:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}'
  /groups/{groupId}/clients/search:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1clients~1search'
  /groups/{groupId}/clients/{clientId}:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1clients~1{clientId}'
  /groups/{groupId}/mapping-rules/search:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1mapping-rules~1search'
  /groups/{groupId}/mapping-rules/{mappingRuleId}:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1mapping-rules~1{mappingRuleId}'
  /groups/{groupId}/roles/search:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1roles~1search'
  /groups/{groupId}/users/search:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1users~1search'
  /groups/{groupId}/users/{username}:
    $ref: 'groups.yaml#/paths/~1groups~1{groupId}~1users~1{username}'

  # Incident endpoints
  /incidents/search:
    $ref: 'incidents.yaml#/paths/~1incidents~1search'
  /incidents/{incidentKey}:
    $ref: 'incidents.yaml#/paths/~1incidents~1{incidentKey}'
  /incidents/{incidentKey}/resolution:
    $ref: 'incidents.yaml#/paths/~1incidents~1{incidentKey}~1resolution'
  /incidents/statistics/process-instances-by-definition:
    $ref: 'incidents.yaml#/paths/~1incidents~1statistics~1process-instances-by-definition'
  /incidents/statistics/process-instances-by-error:
    $ref: 'incidents.yaml#/paths/~1incidents~1statistics~1process-instances-by-error'

  # Job endpoints
  /jobs/activation:
    $ref: 'jobs.yaml#/paths/~1jobs~1activation'
  /jobs/search:
    $ref: 'jobs.yaml#/paths/~1jobs~1search'
  /jobs/{jobKey}:
    $ref: 'jobs.yaml#/paths/~1jobs~1{jobKey}'
  /jobs/{jobKey}/completion:
    $ref: 'jobs.yaml#/paths/~1jobs~1{jobKey}~1completion'
  /jobs/{jobKey}/error:
    $ref: 'jobs.yaml#/paths/~1jobs~1{jobKey}~1error'
  /jobs/{jobKey}/failure:
    $ref: 'jobs.yaml#/paths/~1jobs~1{jobKey}~1failure'
  /jobs/batch-update:
    $ref: 'jobs.yaml#/paths/~1jobs~1batch-update'

  # Job metrics endpoints
  /jobs/statistics/global:
    $ref: 'job-metrics.yaml#/paths/~1jobs~1statistics~1global'
  /jobs/statistics/by-types:
    $ref: 'job-metrics.yaml#/paths/~1jobs~1statistics~1by-types'
  /jobs/statistics/by-workers:
    $ref: 'job-metrics.yaml#/paths/~1jobs~1statistics~1by-workers'
  /jobs/statistics/time-series:
    $ref: 'job-metrics.yaml#/paths/~1jobs~1statistics~1time-series'
  /jobs/statistics/errors:
    $ref: 'job-metrics.yaml#/paths/~1jobs~1statistics~1errors'

  # License endpoints
  /license:
    $ref: 'licenses.yaml#/paths/~1license'

  # Mapping rule endpoints
  /mapping-rules:
    $ref: 'mapping-rules.yaml#/paths/~1mapping-rules'
  /mapping-rules/search:
    $ref: 'mapping-rules.yaml#/paths/~1mapping-rules~1search'
  /mapping-rules/{mappingRuleId}:
    $ref: 'mapping-rules.yaml#/paths/~1mapping-rules~1{mappingRuleId}'

  # Message endpoints
  /message-subscriptions/search:
    $ref: 'messages.yaml#/paths/~1message-subscriptions~1search'
  /messages/correlation:
    $ref: 'messages.yaml#/paths/~1messages~1correlation'
  /messages/publication:
    $ref: 'messages.yaml#/paths/~1messages~1publication'

  # Process definition endpoints
  /process-definitions/search:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1search'
  /process-definitions/statistics/message-subscriptions:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1statistics~1message-subscriptions'
  /process-definitions/statistics/process-instances:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1statistics~1process-instances'
  /process-definitions/{processDefinitionKey}:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1{processDefinitionKey}'
  /process-definitions/{processDefinitionKey}/form:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1{processDefinitionKey}~1form'
  /process-definitions/{processDefinitionKey}/statistics/element-instances:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1{processDefinitionKey}~1statistics~1element-instances'
  /process-definitions/{processDefinitionKey}/variable-names/search:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1{processDefinitionKey}~1variable-names~1search'
  /process-definitions/{processDefinitionKey}/xml:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1{processDefinitionKey}~1xml'
  /process-definitions/statistics/process-instances-by-version:
    $ref: 'process-definitions.yaml#/paths/~1process-definitions~1statistics~1process-instances-by-version'

  # Process instance endpoints
  /process-instances:
    $ref: 'process-instances.yaml#/paths/~1process-instances'
  /process-instances/cancellation:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1cancellation'
  /process-instances/deletion:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1deletion'
  /process-instances/incident-resolution:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1incident-resolution'
  /process-instances/migration:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1migration'
  /process-instances/modification:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1modification'
  /process-instances/resumption:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1resumption'
  /process-instances/search:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1search'
  /process-instances/suspension:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1suspension'
  /process-instances/{processInstanceKey}:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}'
  /process-instances/{processInstanceKey}/business-id-assignment:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1business-id-assignment'
  /process-instances/{processInstanceKey}/call-hierarchy:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1call-hierarchy'
  /process-instances/{processInstanceKey}/cancellation:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1cancellation'
  /process-instances/{processInstanceKey}/deletion:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1deletion'
  /process-instances/{processInstanceKey}/incident-resolution:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1incident-resolution'
  /process-instances/{processInstanceKey}/incidents/search:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1incidents~1search'
  /process-instances/{processInstanceKey}/migration:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1migration'
  /process-instances/{processInstanceKey}/modification:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1modification'
  /process-instances/{processInstanceKey}/resumption:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1resumption'
  /process-instances/{processInstanceKey}/sequence-flows:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1sequence-flows'
  /process-instances/{processInstanceKey}/statistics/element-instances:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1statistics~1element-instances'
  /process-instances/{processInstanceKey}/statistics/wait-states:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1statistics~1wait-states'
  /process-instances/{processInstanceKey}/suspension:
    $ref: 'process-instances.yaml#/paths/~1process-instances~1{processInstanceKey}~1suspension'

  # Resource endpoints
  /resources/search:
    $ref: 'deployments.yaml#/paths/~1resources~1search'
  /resources/{resourceKey}:
    $ref: 'deployments.yaml#/paths/~1resources~1{resourceKey}'
  /resources/{resourceKey}/content:
    $ref: 'deployments.yaml#/paths/~1resources~1{resourceKey}~1content'
  /resources/{resourceKey}/content/binary:
    $ref: 'deployments.yaml#/paths/~1resources~1{resourceKey}~1content~1binary'
  /resources/{resourceKey}/deletion:
    $ref: 'deployments.yaml#/paths/~1resources~1{resourceKey}~1deletion'

  # Role endpoints
  /roles:
    $ref: 'roles.yaml#/paths/~1roles'
  /roles/search:
    $ref: 'roles.yaml#/paths/~1roles~1search'
  /roles/{roleId}:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}'
  /roles/{roleId}/clients/search:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1clients~1search'
  /roles/{roleId}/clients/{clientId}:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1clients~1{clientId}'
  /roles/{roleId}/groups/search:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1groups~1search'
  /roles/{roleId}/groups/{groupId}:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1groups~1{groupId}'
  /roles/{roleId}/mapping-rules/search:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1mapping-rules~1search'
  /roles/{roleId}/mapping-rules/{mappingRuleId}:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1mapping-rules~1{mappingRuleId}'
  /roles/{roleId}/users/search:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1users~1search'
  /roles/{roleId}/users/{username}:
    $ref: 'roles.yaml#/paths/~1roles~1{roleId}~1users~1{username}'

  # Secret endpoints
  /secrets/resolve:
    $ref: 'secrets.yaml#/paths/~1secrets~1resolve'
  /secrets/list:
    $ref: 'secrets.yaml#/paths/~1secrets~1list'

  # Setup endpoints
  /setup/user:
    $ref: 'setup.yaml#/paths/~1setup~1user'

  # Signal endpoints
  /signals/broadcast:
    $ref: 'signals.yaml#/paths/~1signals~1broadcast'

  # Cluster status endpoints
  /status: # Legacy `/status` endpoint that is deprecated and only works for the default physical tenant
    $ref: 'cluster.yaml#/paths/~1status'

  # System endpoints
  /system/usage-metrics:
    $ref: 'system.yaml#/paths/~1system~1usage-metrics'
  /system/configuration:
    $ref: 'system.yaml#/paths/~1system~1configuration'

  # Tenant endpoints
  /tenants:
    $ref: 'tenants.yaml#/paths/~1tenants'
  /tenants/search:
    $ref: 'tenants.yaml#/paths/~1tenants~1search'
  /tenants/{tenantId}:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}'
  /tenants/{tenantId}/clients/search:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1clients~1search'
  /tenants/{tenantId}/clients/{clientId}:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1clients~1{clientId}'
  /tenants/{tenantId}/groups/search:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1groups~1search'
  /tenants/{tenantId}/groups/{groupId}:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1groups~1{groupId}'
  /tenants/{tenantId}/mapping-rules/search:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1mapping-rules~1search'
  /tenants/{tenantId}/mapping-rules/{mappingRuleId}:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1mapping-rules~1{mappingRuleId}'
  /tenants/{tenantId}/roles/search:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1roles~1search'
  /tenants/{tenantId}/roles/{roleId}:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1roles~1{roleId}'
  /tenants/{tenantId}/users/search:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1users~1search'
  /tenants/{tenantId}/users/{username}:
    $ref: 'tenants.yaml#/paths/~1tenants~1{tenantId}~1users~1{username}'

  # Cluster endpoints
  /topology:
    $ref: 'cluster.yaml#/paths/~1topology'
  /mode:
    $ref: 'cluster.yaml#/paths/~1mode'
  /restore:
    $ref: 'cluster.yaml#/paths/~1restore'

  # Cluster-wide endpoints. Path keys must stay absolute — see `cluster-admin.yaml` for why.
  /cluster/v2/exporting:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1exporting'
  /cluster/v2/exporting/pause:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1exporting~1pause'
  /cluster/v2/exporting/resume:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1exporting~1resume'
  /cluster/v2/backups/runtime:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1backups~1runtime'
  /cluster/v2/backups/runtime/state:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1backups~1runtime~1state'
  /cluster/v2/backups/runtime/state/sync:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1backups~1runtime~1state~1sync'
  /cluster/v2/backups/runtime/{backupId}:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1backups~1runtime~1{backupId}'
  /cluster/v2/backups/history:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1backups~1history'
  /cluster/v2/backups/history/{backupId}:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1backups~1history~1{backupId}'
  /cluster/v2/mode:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1mode'
  /cluster/v2/rebalance:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1rebalance'
  /cluster/v2/restore:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1restore'
  /cluster/v2/status:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1status'
  /cluster/v2/status/upgrade:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1status~1upgrade'
  /cluster/v2/topology:
    $ref: 'cluster-admin.yaml#/paths/~1cluster~1v2~1topology'

  # User endpoints
  /users:
    $ref: 'users.yaml#/paths/~1users'
  /users/search:
    $ref: 'users.yaml#/paths/~1users~1search'
  /users/{username}:
    $ref: 'users.yaml#/paths/~1users~1{username}'

  # User task endpoints
  /user-tasks/search:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1search'
  /user-tasks/{userTaskKey}:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}'
  /user-tasks/{userTaskKey}/assignee:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1assignee'
  /user-tasks/{userTaskKey}/assignment:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1assignment'
  /user-tasks/{userTaskKey}/audit-logs/search:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1audit-logs~1search'
  /user-tasks/{userTaskKey}/completion:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1completion'
  /user-tasks/{userTaskKey}/effective-variables/search:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1effective-variables~1search'
  /user-tasks/{userTaskKey}/form:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1form'
  /user-tasks/{userTaskKey}/variables/search:
    $ref: 'user-tasks.yaml#/paths/~1user-tasks~1{userTaskKey}~1variables~1search'

  # Variable endpoints
  /variables/search:
    $ref: 'variables.yaml#/paths/~1variables~1search'
  /variables/{variableKey}:
    $ref: 'variables.yaml#/paths/~1variables~1{variableKey}'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      # Conditional enforcement. The scheme is enforced when the
      # Orchestration Cluster REST API server is running in `secured` mode
      # and bypassed when in `unsecured` mode. `x-enforcement-modes` names
      # the deployment-mode axis (`auth`) whose values trigger enforcement.
      x-enforcement: conditional
      x-enforcement-modes:
        auth: [secured]
    basicAuth:
      type: http
      scheme: basic
      x-enforcement: conditional
      x-enforcement-modes:
        auth: [secured]