Orchestrator plugin permissions

The Orchestrator plugin uses role-based access control (RBAC) to restrict which workflows users can view and run.

Important

The orchestrator.workflow.<workflow_id> and orchestrator.workflow.use.<workflow_id> permissions are deprecated and will be removed in a future Developer Hub release. These per-workflow permissions still work in this release. There is no automatic migration. After removal, roles that rely only on these permissions lose access to the corresponding workflows.

To restrict access to specific workflows, use a conditional policy with the IS_ALLOWED_WORKFLOW_ID rule.

Name Resource type Policy Description

orchestrator.workflow

orchestrator-workflow

read

Enables a user or role to list and read all workflow definitions and their instances. Use a conditional policy with the IS_ALLOWED_WORKFLOW_ID rule to limit this access to specific workflows.

orchestrator.workflow.use

orchestrator-workflow

update

Enables a user or role to run or stop any workflow. Use a conditional policy with the IS_ALLOWED_WORKFLOW_ID rule to limit this access to specific workflows.

orchestrator.workflow.<workflow_id>

read

Deprecated. Enables a user or role to list and read a specific workflow definition and its instances. Replace this permission with a conditional policy that uses the IS_ALLOWED_WORKFLOW_ID rule.

orchestrator.workflow.use.<workflow_id>

update

Deprecated. Enables a user or role to run or stop a specific workflow. Replace this permission with a conditional policy that uses the IS_ALLOWED_WORKFLOW_ID rule.

orchestrator.workflowAdminView

read

Enables a user or role to view instance variables and the workflow definition editor.

orchestrator.instanceAdminView

read

Enables a user or role to view all workflow instances, including those created by other users.

To restrict orchestrator.workflow and orchestrator.workflow.use to specific workflows, define a conditional policy that uses the following rule:

IS_ALLOWED_WORKFLOW_ID
Limits the permission to the workflow identifiers that you list in the workflowIds parameter. The rule applies to the orchestrator-workflow resource type in the orchestrator plugin.
workflowIds
Enter one or more workflow identifiers. Each identifier must match the id field in the workflow definition.
Warning

By default, a conditional policy takes precedence over an unrestricted allow policy for orchestrator.workflow or orchestrator.workflow.use on the same role and action. The role can access only the workflows listed in workflowIds.

To grant access to all workflows, define unrestricted allow policies in the CSV file and do not add a conditional policy for that role.

During this deprecation period, access is also granted when a deprecated per-workflow permission allows it.

The [workflowId] must match the unique identifier in your workflow definition file. For example, in the workflow definition below, the identifier is greeting:

id: greeting
version: '1.0'
specVersion: '0.8'
name: Greeting workflow
description: YAML based greeting workflow
annotations:
  - 'workflow-type/infrastructure'
dataInputSchema: 'schemas/greeting.sw.input-schema.json'
extensions:
  - extensionid: workflow-output-schema
    outputSchema: schemas/workflow-output-schema.json