Role Descriptions

The following table describes the tasks that each role can perform.
Note: Users created in the default system organization can be assigned additional administrator roles that are not available for any other organization. For a description of those roles, see Administrator Roles.
Role Description
Auth Token Administrator

Register, unregister, and deactivate execution engines using Control Hub. Regenerate authentication tokens and delete unregistered authentication tokens.

Provides full access to all registered execution engines in the organization.

Connection Editor Manage connections, including creating, editing, and deleting connections.
Connection User View connection names and descriptions. Use connections when configuring pipelines and pipeline fragments. Start jobs for pipelines that use connections.

Requires the Pipeline Editor role to use connections when configuring pipelines and fragments. Requires the Job Operator role to start jobs.

Control Hub Authentication Use Control Hub credentials to log in when SAML authentication is enabled.

Assign to user accounts that must complete tasks that require Control Hub credentials.

Available only when SAML authentication is enabled for the organization.

Data SLA Editor Manage data SLAs, including creating and modifying data SLAs.

Requires one of the topology roles, one of the pipeline roles, the Job Operator role, and the Time Series ReaderMetrics Reader role.

Data SLA User View and monitor data SLAs.

Requires one of the topology roles, one of the pipeline roles, the Job Operator role, and the Time Series ReaderMetrics Reader role.

Deployment Manager Manage deployments, including creating, starting, stopping, editing, and deleting deployments.
Engine Administrator

Perform all tasks in registered Data Collectors and Transformers, including installing external libraries and additional Data Collector libraries for the selected authoring engine.

Equivalent to the Data Collector or Transformer Admin role.

Perform all tasks in the pipeline canvas, including installing external libraries and additional stage libraries for the selected authoring engine. Monitor engines in the Engines view.

Requires the Pipeline Editor role for the pipeline canvas tasks. Requires the Job Operator role to access the Engines view.

Engine Creator

Configure pipelines in registered Data Collectors and Transformers, including configuring alerts, previewing data, and monitoring pipelines.

Equivalent to the Data Collector or Transformer Creator role.

Design pipelines in the pipeline canvas, including configuring alerts and previewing data.

Requires the Pipeline Editor role.

Engine Manager

Manage pipelines in registered Data Collectors and Transformers, including starting and stopping pipelines, monitoring pipelines, configuring and resetting alerts, and reviewing snapshots.

Equivalent to the Data Collector or Transformer Manager role.

Manage pipeline test runs in the pipeline canvas, including starting, stopping, and monitoring test runs, configuring and resetting alerts for test runs, and reviewing snapshots for test runs.

Requires the Pipeline Editor role.

Engine Guest

View pipeline and alert configuration, and view general monitoring and log information in registered Data Collectors and Transformers.

Equivalent to the Data Collector or Transformer Guest role.

Environment Manager Manage environments, including creating, activating, deactivating, editing, and deleting environments.
Job Operator Manage jobsjob instances and job templates, including creating, editing, importing, exporting, uploading initial offset files, and starting jobs, but not monitoring jobs.

Requires one of the pipeline roles.

Notification User View and acknowledge data SLA alerts in the Alerts view. Manage subscriptions in the Subscriptions view.
Organization Administrator

Access Control Hub. Register, unregister, and deactivate Data Collectors using Control Hub. Regenerate authentication tokens and delete unregistered authentication tokens. Configure users and groups for the organization. View active sessions and audit entries for the organization. View connections, pipelines, jobs, and topologies for the organization. Upload initial offset files for jobs. Configure the organization.

Provides full access to all objects in the organization. Grant other users and groups permission to access the objects.

Configure organization details. Manage users and groups. View active sessions and audit entries. Perform all tasks granted by all other roles. Provides full access to all objects in the organization.

Requires one of the engine roles to complete the following tasks:
  • Design pipelines in the pipeline canvas.
  • Capture and view snapshots, view real-time statistics, error records, and the engine log while monitoring a job.
  • View engine configuration details while monitoring an engine.
Organization User Access Control Hub, view user account details, reset the personal password.
Pipeline Editor Design, publish, and manage pipelines and pipeline fragments. Includes importing and exporting pipelines and fragments, and configuring tags.

Requires the Engine Creator or Engine Administrator role.

Pipeline User View information about existing pipelines and fragments. Export pipelines and fragments.
Provisioning Operator Manage Provisioning Agents and legacy Kubernetes deployments.
Reporting Operator Manage reports, including creating, editing, generating, and viewing reports.
Rules Editor Not used at this time.
Scheduler Operator Manage scheduled tasks, including creating, editing, and monitoring scheduled tasks.
Time Series ReaderMetrics Reader Monitor jobs and view pipeline metrics.
Time Series Writer Work with metrics using the REST API.
Topology Editor Manage topologies, including creating, monitoring, importing, and exporting topologies.

Requires the Job Operator and Pipeline Editor role.

Topology User View topologies.

Requires the Job Operator role and one of the pipeline roles.