Skip to main content

Assign Role to Application

Endpoint: POST /api/applications/{applicationId}/roles/{role}

Assigns roles to an already created application in your Conductor cluster.

Path parameters

ParameterDescriptionTypeRequired/ Optional
applicationIdThe unique ID of the application to which the role will be assigned.stringRequired.
roleThe role to assign for application. Supported values:

The following roles are available to any user with access to applications:
  • WORKER: Can poll and execute tasks for which it has Execute permissions for. This role should be granted to a task worker application that is responsible for polling and executing a task.
  • METADATA_API: Can create and view workflow definitions, task definitions, and user forms. This role should be granted to an application that is responsible for retrieving and managing workflow and task definitions, such as for testing or CI/CD integration purposes.
  • APPLICATION_CREATOR: Can create and view applications. This role should be granted to an application that is responsible for managing other applications in the cluster.
The following roles can only be granted by a cluster Admin:
  • UNRESTRICTED_WORKER: Worker role with full access to poll and execute any task in the cluster.
  • METADATA_MANAGER: Can manage all workflow and task definitions in the cluster, including performing any action regardless of workflow or task ownership. Can view and manage API Gateway configurations. Can create integrations and secrets.
  • WORKFLOW_MANAGER: Can view, execute, and manage all workflow executions in the system, including start, pause, resume, rerun, retry, restart, terminate, and delete actions. Has execute and read access to workflow and task definitions.
  • APPLICATION_MANAGER: Can create, update, and delete any application in the cluster. Can also view and manage API Gateway configurations.
  • ADMIN: Full control over that particular application, including creating, viewing, modifying, deleting, and executing it.
stringRequired.

Response

  • Returns 200 OK, indicating that the role is assigned to the application.
  • Returns 404 if an invalid application ID is provided.
  • Returns 403 Forbidden if a non-admin user attempts to assign an unrestricted role.

Examples

Assign a role to an application

Request

curl -X 'POST' \
'https://<YOUR-SERVER-URL>/api/applications/243a8a88-9f77-48b2-9429-76793a123344/roles/METADATA_API' \
-H 'accept: application/json' \
-H 'X-Authorization: <TOKEN>' \
-d ''

Response

Returns 200 OK, indicating that the role is assigned to the application.