Skip to main content

Managing Users and Groups

info

This feature is only available to Admins.

Create and manage users and groups on your Conductor cluster, so as to ensure secure access.

Users​

A user represents a human user that interacts with Conductor. Users are authenticated using SSO providers or email/password. Each user has one or more roles assigned to them.

Adding users​​

Users must be added to your Orkes Conductor cluster before they can sign up or log in.

To add a user to your cluster:

  1. In the left navigation menu, go to Access Control > Users.
  2. Select (+) Create user.
  3. Enter the following details:
FieldDescription
User IdThe user’s email address. This cannot be changed later.
NameThe username.
RolesThe user’s role(s), which governs the basic access level for the user. The available roles are:
  • Admin—Superuser. Full access to the system and resources. Can manage users and groups.
  • User—Can only access resources created by them.
  • Metadata Manager—Can read, update, and delete all metadata in the system.
  • Workflow Manager—Can view and execute all workflows in the system.
  • Read Only User—Can access all metadata and workflows in the system as read-only. Cannot modify or execute workflows.
GroupsThe groups that the user should be part of. This provides additional group-level permissions to the user.
  1. Select Save.

Editing user information​

You can edit a user’s name, role, or group anytime.

To edit a user:

  1. In the left navigation menu, go to Access Control > Users.
  2. Select the Edit button located next to the user.

    Editing user roles in Orkes Platform

  3. Update the user’s name, roles, or groups as desired.
  4. Select Save.

Deleting users​

To delete a user from your cluster:

  1. In the left navigation menu, go to Access Control > Users.
  2. Select the Delete icon located next to the user.
  3. Confirm the action by entering the user’s ID and selecting Confirm.

Groups​

A group is a set of users. Groups are a way to quickly share roles and permissions among multiple users.

When a user is added to a group, the user automatically inherits the roles and permissions of a group. Likewise, when a user is removed from a group, the roles and permissions are automatically removed from the user.

note

Read Only Users cannot be added to any groups.

Configuring groups​​

To configure a group:

  1. Create a group.
    1. In the left navigation menu, go to Access Control > Groups.
    2. Select (+) Create group.
    3. Enter the following details:
FieldDescription
NameA name to identify your group. For example, “Engineering”. This cannot be changed later.
DescriptionA description of the group.
Default group roleOptional. The role(s) that all members of the group will inherit, on top of their individually defined role(s). The available roles are:
  • Admin—Superuser. Full access to the system and resources. Can manage users and groups.
  • User—Can only access resources that they created.
  • Metadata Manager—Can read, update, and delete all metadata in the system.
  • Workflow Manager—Can view and execute all workflows in the system.
  • Read Only User—Can access all metadata and workflows in the system as read-only. Cannot modify or execute workflows.

   iv. Select Save.
  The group has been created. You can proceed to add members or permissions to the group.

Group configuration screen in Orkes Platform.

  1. Add members to the group.

    1. In the Members section, select + Add User to add an existing user to the group. If the user you are looking for does not exist, you must first add them to your cluster.

  2. Add permissions to grant group-level access to resources.

    1. In the Permissions section, select + Add Permission.

      Granting access to specific tasks and workflows

    2. Toggle between each resource type and select the resources to provide access to.
    3. Toggle the access levels for your selected resource:
      • Read—Users will be able to view the resource.
      • Update—Users will be able to update the resource.
      • Execute—Users will be able to execute the resource.
      • Delete—Users will be able to delete the resource.

    All group members will now have these roles and permissions, on top of their existing user-based permissions.

tip

You can grant permissions to tags, rather than to individual resources. Tags can be added to multiple resources, so that when you grant a permission to a tag, it instantly provides access to all tagged resources. Learn more about tags in Managing Tags.


Editing group information​

You can edit a group’s description, default roles, members, or permissions anytime.

To edit a group:

  1. In the left navigation menu, go to Access Control > Groups.
  2. Select the group name or the Edit icon located next to the group name.
  3. Update the group’s description, roles, members, or permissions as desired.

Deleting groups​

To delete a group:

  1. Select the Delete icon located next to the group name.
  2. Confirm the action by entering the group name and selecting Confirm.