Managing Users and Groups

Managing users and groups involves adding users to your organization and optionally creating groups for related users. You can renew invites for users whose invitation has expired. You can also activate or deactivate users and delete users when needed.
Note: If SCIM provisioning is enabled for your organization, you do not manage users and groups within Control Hub. Instead, you manage users and groups within your identity provider (IdP).

Changes to existing groups and users take effect the next time the user logs in.

Adding Users

Add users to your organization so that you can collaboratively manage pipelines as a team.

  1. In the Navigation panel, click Manage > Users.
  2. Click the Add New User icon: .
  3. In the Add Users window, type or paste one or more email addresses.
    Note: Users enter their own display name when they join the organization.
  4. Optionally, select one or more existing groups to add the users to.

    Control Hub provides a default all group that includes every user in the organization. To create additional groups, see Creating Groups.

  5. Optionally, modify the roles assigned to the users.

    Default role assignments for new users permit most tasks to encourage development and testing. Change the role assignments as needed to secure the integrity of your organization and data.

    For a description of each role, see Role Descriptions.

  6. Click Invite.
    • For IBM StreamSets as a Service - Control Hub sends an email inviting the users to join your organization.
    • For IBM StreamSets as client-managed software - Inform the users that they can access IBM StreamSets on the IBM Software Hub platform.
    Note: Users must join the organization within seven days. Otherwise, the invite expires and you must renew the invites.

User Status

When you view the list of users in the Users view, you can view the status for each user.

The following table describes each user status:
User Status Description
Active User is active and can sign in.
Deactivated User is deactivated and cannot sign in.
Invited User has been invited to join the organization, but has not accepted the invitation.
Expired User has been invited to join the organization, but the invite has expired.

Renewing Invites

When a user's invitation to join the organization expires, you can renew the invite.

  1. In the Navigation panel, click Manage > Users.
  2. Select one or more users, and then click the Renew Invites icon: .
    • For IBM StreamSets as a Service - Control Hub sends an email inviting the users to join your organization.
    • For IBM StreamSets as client-managed software - Inform the users that they can access IBM StreamSets on the IBM Software Hub platform.

    Users must join the organization within seven days.

Creating Groups

Create groups for related users so that you can more efficiently manage users.

  1. In the Navigation panel, click Manage > Groups.
  2. Click the Add New Group icon: .
  3. In the Add Group dialog box, configure the following properties:
    Group Property Description
    Display Name Unique display name for the group.

    Use a brief name that indicates the purpose of the group.

    Group names are case insensitive. For example, Control Hub considers mygroup and MyGroup as the same name.
    Group ID Unique identifier for the group.

    By default, Control Hub generates the group ID from the display name, using all lowercase characters and replacing any spaces with underscores. For example, if you enter Data Engineers as the display name, Control Hub uses data_engineers as the group ID.

    Users type the group ID when using credential functions in pipelines. As a result, you might want to edit the default group ID to make it easier to use with credential functions.

    Once saved, you cannot change the group ID.

    For more information about credential functions, see the Data Collector documentation or the Transformer documentation.
  4. Assign roles to the group. Each user account added to the group is assigned the same roles.
    Default role assignments for new users and new groups permit most tasks to encourage development and testing. Change the role assignments as needed to secure the integrity of your organization and data.

    For a description of each role, see Role Descriptions.

  5. Click Save.
    After creating the group, you can add users to the group.

Adding Users to Groups

Create groups and add user accounts to groups to more efficiently manage user accounts.

To add a user to a group, you can modify the user account or the group.

  1. In the Navigation panel, click Manage > Users, or click Manage > Groups.
  2. Click the row listing the user or group to display its details.
  3. In the bottom left corner of the details, click in the area under User Groups or Group Users, then select the group to add to the user or the user to add to the group.
  4. Click Save.

Activating or Deactivating Users

Users must be active to sign in.

You might temporarily deactivate a user to disable access to Control Hub.

  1. In the Navigation panel, click Manage > Users.
  2. Select one or more users, and then click one of the following icons:
    • Activate icon () to activate the user
    • Deactivate icon () to deactivate the user

Deleting Users

When needed, you can delete users. Deleting users permanently removes the users from your organization, including the user's email address.

Control Hub uses the email address to identify the user who last modified an object. For example, when you view the list of pipelines on the Pipelines view, the Last Modified By column lists the email address of the user who last modified the pipeline.

When you delete a user, the deleted user's email address is replaced with a random ID. As a result, you might consider deactivating users instead of deleting them.

Before you can delete a user, you must deactivate the user.

  1. In the Navigation panel, click Manage > Users.
  2. Select one or more users, and then click the Delete icon: .

    If the users are still active, the Deactivate Users confirmation dialog box prompts you to first deactivate the users. Click Deactivate Users to confirm, and then click Close.

  3. In the Delete Users confirmation dialog box, click Delete Users to confirm, and then click Close.