12.4. Edit/delete a user

User shall have ROLE_ADMIN to edit/delete users.

Edit a user

For edit a user:

  1. Open Users tab on User management section of system-level settings.
  2. Find a user.
  3. Click Edit button in the row opposite the user name:
    CP_EditDeleteUsers
  4. Pop-up window will be shown:
    CP_EditDeleteUsers

On this form there are several blocks of the settings for a user.

Default data storage

Here you can select default data storage for a user:
CP_EditDeleteUsers

Groups (roles) management

In this block you can set groups and roles for the selected user:
CP_EditDeleteUsers

For more information about changing a set of the roles/groups for the specific user see 12.8. Change a set of roles/groups for a user.

Attributes

CP_EditDeleteUsers

In this block you can set metadata tags (attributes) for a user. These tags represent key/value pairs, same as pipeline/folder tags. For more information see 17. CP objects tagging by additional attributes.

"Blocking" notifications track

One of the special attribute that is set automatically - information about the notifications confirmation:
CP_EditDeleteUsers
Via that attribute you can view, which "blocking" notifications were confirmed by the user (about system notifications see here).
This attribute is shown only for users that confirmed at least one "blocking" notification.
By default, this attribute has the following pair:

  • KEY - confirmed_notifications (that name could be changed via the system-level preference system.events.confirmation.metadata.key)
  • VALUE - link that shows summary count of confirmed notifications for the user

To open the detailed table with confirmed notifications for the user:

  1. Click the VALUE link:
    CP_EditDeleteUsers
  2. Here you can view detailed information about confirmed notifications - their titles, messages and datetime of the confirmation:
    CP_EditDeleteUsers
  3. Also you can open "raw" JSON view of the detailed table, if necessary. For that, click the EDIT button under the detailed table:
    CP_EditDeleteUsers
  4. Here you can edit the contents. Click the SAVE button to save changes:
    CP_EditDeleteUsers

Launch options

CP_EditDeleteUsers

In this block you can specify some restrictions for a user on allowed instance types and price types. Here you can specify:

Field Description Example
Allowed instance types mask This mask restrict for a specific user allowed instance types for launching tools, pipelines and configurations If you want user will be able to launch runs with only "m5..." instances types, mask would be m5*:
CP_EditDeleteUsers
In that case, before launching tool, pipeline or configuration, dropdown list of available node types will be look like this:
CP_EditDeleteUsers
Allowed tool instance types mask This mask restrict for a specific user allowed instance types only for tools - launching from tools menu or main dashboard. This mask has higher priority for launching tool than Allowed instance types mask. It's meaning that in case when both masks are set - for the launching tool will be applied Allowed tool instance types mask. If you want user will be able to launch tools with only some of "large m5..." instances types, mask would be m5*.large*:
CP_EditDeleteUsers
In that case, before launching tool, dropdown list of available node types will be look like this:
CP_EditDeleteUsers
Allowed price types In this field you may restrict, what price types will be allowed for a user. If you want user will be able to launch only "On-demand" runs, select it in the dropdown list:
CP_EditDeleteUsers
In that case, before launching tool, dropdown list of price types will be look like this:
CP_EditDeleteUsers
Jobs visibility In this field you may restrict the visibility of running jobs on the Active Runs page for non-owner users. If you want user will be able to view all pipeline runs (for that pipelines on which user has corresponding permissions), select "Inherit" in this dropdown list:
CP_EditDeleteUsers
If you want user can view only runs he launched, select "Only owner":
CP_EditDeleteUsers

To apply set restrictions for a user click CP_EditDeleteUsers

Setting restrictions on allowed instance types/price types is a convenient way to minimize a number of invalid configurations runs.
Such restrictions could be set not only for a user, but on another levels too.
In CP platform next hierarchy is set for applying of inputted allowed instance types (sorted by priority):

  • User level (specified for a user on "User management" tab) (see above)
  • User group level (specified for a group (role) on "User management" tab. If a user is a member of several groups - list of allowed instances will be summarized across all the groups) (see 12.6. Edit a group/role)
  • Tool level (specified for a tool on "Instance management" panel) (see 10.5. Launch a Tool)
  • (global) cluster.allowed.instance.types.docker (specified on "Cluster" tab in "Preferences" section of system-level settings) (see 12.10. Manage system-level settings)
  • (global) cluster.allowed.instance.types (specified on "Cluster" tab in "Preferences" section of system-level settings) (see 12.10. Manage system-level settings)

After specifying allowed instance types, all GUI forms that allow to select the list of instance types (configurations/launch forms) - will display only valid instance type, according to hierarchy above.
For price type specifying - if it is set for the user/group/tool - GUI will allow to select only that price type.

In CP platform next hierarchy is set for applying of jobs visibility (sorted by priority):

Possibility to revert changes

In certain cases, there could be convenient to undo all changes in a user profile when modifying it - without closing the form.

The admin has such ability:

  • open the User management tab
  • select the desired user to modify, click the Edit button to open the popup with the user's settings
  • edit some settings
  • if needed to revert done changes - click the REVERT button at the bottom of the form (Note: it's possible only before saving!):
    CP_EditDeleteUsers
  • all done unsaved changes are reverted. The REVERT button becomes disabled:
    CP_EditDeleteUsers

Note: in such way all unsaved changes of user settings could be reverted - Default data storage, Roles & Groups list, Attributes and Launch options.

Block/unblock a user

To block user:

  1. Open Users tab on User management section of system-level settings.
  2. Find a user.
  3. Click Edit button in the row opposite the user name.
  4. In the opened pop-up window click the BLOCK button in the left bottom corner.
    CP_EditDeleteUsers
  5. Confirm the blocking:
    CP_EditDeleteUsers

To unblock user:

  1. Open Users tab on User management section of system-level settings.
  2. Find a user.
  3. Click Edit button in the row opposite the user name.
  4. In the opened pop-up window click the UNBLOCK button in the left bottom corner.
    CP_EditDeleteUsers
  5. Confirm the unblocking:
    CP_EditDeleteUsers

Delete a user

To delete a user:

  1. Open Users tab on User management section of system-level settings.
  2. Find a user.
  3. Click Edit button in the row opposite the user name.
  4. In the opened pop-up window click Delete button in the left bottom corner.
  5. Confirm the deletion:
    CP_EditDeleteUsers