When starting your project in ALM Octane, add users to spaces and workspaces.
After you create users, assign roles and permissions to them. For details, see Roles and permissions.
This section provides an overview of user-related tasks and who can perform them.
To manage users:
In Settings , depending on your permissions, click Site or Spaces.
Select the Users tab.
- In the Users tab, show the Filter pane , and click Add Filter. Select Roles and Workspaces > Role, and select the roles by which you want to filter.
- To further narrow down your results by workspaces, click Add Filter again, select Roles and Workspaces > Workspace, and select the workspaces by which you want to filter.
Add or edit users, depending on your role.
Note: Most roles can be customized. Roles and their permissions might be different for your organization.
User management capability Site admin (on-premises) Space admin Workspace admin Add users to the current context (site, space, or workspace). For details, see Add a user.
Note: A site admin can only add users with REST API. See the row below.
Add users to the current context (site, space, or workspace) using the REST API. For details, see POST: Create a user. Import LDAP users to a space. For details, see Add LDAP users in ALM Octane . Import IdP users for SSO authentication. For details, see Import IdP users for SSO authentication into a workspace (on-premises). Add existing users from the site into the space. For details, see Add a user. Add existing users from the space into the workspace. For details, see Add space users to a workspace. Remove roles from a workspace user. For details, see Assign and unassign roles.
Choose the fields to display in the user list, sort the list, and export the list to Microsoft Excel.
Set user passwords.
Assign additional roles to users. For details, see Assign to, or unassign roles from, existing users.
Site admin can only assign the space admin role.
Assign the site admin role to other users. For details, see Assign the site admin role to existing users (on-premises). Activate and deactivate users. For details, see Roles and permissions. SaaS: SaaS: Delete a user. For details, see Manage the site.
Add users to ALM Octane in the following ways:
|Method for adding users||Instructions|
|With ALM Octane's native user management system|
|Include existing users from the site to a space (on-premises only)||Add site users to a space|
|Include existing users from a space into a workspace||Add space users to a workspace|
|Import users from an LDAP server (on-premises)|
Import SSO users from an Identity Provider (IdP) (on-premises)
Note: The users must exist in ALM Octane, but login authentication is done by the IdP.
|Use the REST API||
Note: Version 12.60 CP10 and later: The ALLOW_WORKSPACE_USERS_CREATION configuration parameter is deprecated. This parameter used to be available for enabling or preventing the admin from adding and including users at the workspace level. Use Settings > Permissions instead.
Users can be defined:
At the space level by the space admin.
At the workspace level by the admin for the workspace.
The admin designates in which workspaces the user exists by explicitly defining the workspace when adding or modifying the user.
Note: Across all workspaces and spaces, log-in names and emails must be unique.
Add users to your spaces and workspaces.
In Settings > Spaces or Settings > Site, choose a space or a workspace in the tree on the left.
On the Users tab, click +.
If you use LDAP user management, the + button is disabled. In this case, perform user management tasks in your LDAP server. For details, see Set up LDAP.
Note: If you use LDAP authentication, you cannot use ALM Octane native user management.
Enter the user information.
If you specify a Login name, the user uses this name to log into ALM Octane. If no login name is specified, the email address is used.
You or the user can change the password at a later time. For details, see Change passwords.
Assign roles to users.
Space admins assign roles to the user by workspace.
Admins for a workspace can assign roles to the user for that workspace only.
For details, see Roles and permissions.
If you are a site admin, in the Site area, you can assign a user to be a site admin. Click the user's ID and change the Site admin value to Yes.
An admin can click the ID of a user in the Users grid to modify an existing user's details, including his own.
You cannot change your own Login name, but another admin can change that for you.
For details on assigning roles, see Roles and permissions.
For details on changing passwords, see Change passwords.
You can add existing ALM Octane site users to a space (supported for on-premises only).
To add site users to a space:
- In Settings > Spaces, select a space in the tree on the left.
- On the Users tab, click Include site users.
- Select the users to include.
- Click Add.
Note: You can disable adding site users to a space in the ENABLE_INCLUDE_SITE_USERS parameter. For details, see Configuration parameters.
You can add existing ALM Octane space users to a workspace.
To add space users to a workspace:
In Settings > Spaces, select a workspace in the tree on the left.
On the Users tab, click Include space users.
Select the users to include.
Import users that are already defined in an Identity Provider (IdP) to a workspace without having to reenter user details.
Prerequisite: Your ALM Octane server is configured for SSO authentication. For details, see Set up SSO authentication (on-premises).
To import IdP users for SSO authentication into a workspace:
In Settings > Spaces, choose a space in the tree on the left.
In the Users tab, click .
If you have not yet created an import (.csv) file for defining the IdP users, click View Import File Example to download a template. The default name for the template file is import_users.csv.
Modify the import (.csv) file that you created for defining IdP users as necessary.How to define users in the import file
The import file must have a header row.
Define, for each user, the following attributes in the order listed below.
The attributes are mandatory. Values for them must be specified. However, when the user logs in to ALM Octane, values specified in the IdP override these. For now, any values will suffice.
Attribute Description uid Corresponds to the ALM Octane UID field. Mandatory. Must be unique. Can be any unique value. name
Corresponds to the ALM Octane LOGIN NAME field. name values must be the actual names to be used for authentication. Mandatory.
This field is used to identify the user in the IdP at first login. Subsequently, the uid is used.
first_name Corresponds to the ALM Octane FIRST NAME field. Mandatory, but can be any value. last_name Corresponds to the ALM Octane LAST NAME field. Mandatory, but can be any value. Corresponds to the ALM Octane EMAIL field. Mandatory, but can be any value.
Navigate to the import file using the Browse button.
Select the workspace to which you want to import the users.
Select the role you want to assign to the users.
Tip: We recommend that you select the Viewer role now, and have the admin update roles later.
After the import
If any users were not imported successfully, review the details, make corrections, and re-import.
You can re-import the entire import file. Users that were already imported successfully are not duplicated. However if you re-import with a different role, these users retain their original role. You can update their roles later using bulk update.
You can edit only users' languages and roles.
Non-SSO users are still listed in the user list. However, they cannot log into ALM Octane because the login will fail SSO authentication.
User activation works as it does for any other type of user. If the user is not active, the user is listed but cannot log in. For details, see Activate or deactivate a user.
Activating and deactivating a user controls whether that user can access ALM Octane and how others interact with that user.
|Activate a user||The user can log into ALM Octane.|
|Deactivate a user||
Deactivated users still exist in ALM Octane. In addition, references to these users are retained.
We recommend that before you deactivate a user, check what entities assigned to the user and update them as necessary.
Note: When a user is deactivated, it does not consume a license. This is especially relevant for the Named License type.
If you reactivate a user, ALM Octane restores all existing settings for the user.
The Status column in the grid shows you the activation status of the users.
|The user is activated.|
The user is deactivated.
The user can be activated from the current space or workspace.
|Red||The user is deactivated. The user can be activated from the site, or the space in which it was originally deactivated.|
To activate or deactivate a user:
In Settings > Site > Users or Settings > Spaces > space/workspace > Users.
Right-click one or more users, and choose either Activate or Deactivate.
The Activate option is available on the level in which a user was deactivated. For example, if a user was deactivated at the space level, the user cannot be activated at the workspace level.
Click Yes to confirm.
Deleting a user removes the user from ALM Octane.
Site admins can delete a user. For details, see Manage the site.
SaaS: Make sure to perform the following:
First, the SaaS account administrator either deletes the user from MyAccount or, if enabled, removes ALM Octane from the user's list of allowed services.
Then, the ALM Octane space admin opens a support ticket to SaaS requesting that the user be deleted in ALM Octane.
When you hover over a user's avatar, by default only the email address and chat button are displayed.
To modify which contact details to display, enter any of the following values in the USER_DETAILS_BOX_OPTIONS site parameter: email, phone, chat, teams, team_leaders. Use commas to separate between values. For example, to display email address and phone number only, enter
To disable contact details display, set the USER_DETAILS_BOX_ENABLED site parameter to false.
You can view a history of user administration actions of a workspace user, such as CUD actions, deactivation, and role assignments.
To view workspace user history:
Select Settings > Spaces and choose a workspace in the tree on the left.
In the Users tab, select a user. Click the ID link or choose View Details, and then open the History tab.
For analysis of SCM commits, identify which users perform the commits and map their ALM Octane user to their SCM user. This enables you to analyze the commit information with ALM Octane tools such as widgets and filters.
If you set up ALM Octane to integrate with a CI server that works with a Source Control Management (SCM) system, ALM Octane tracks changes committed to the SCM system. For details, see Track changes committed to your Source Control Management system.
If the email address defined for an SCM user is identical to the one defined for an ALM Octane user, the users are mapped automatically when changes they commit are discovered.
Make sure that your SCM system is configured to share commit authors with your CI server. For example, in the Jenkins GIT plugin, set the option User commit author in changelog.
Otherwise, map the users manually.
ALM Octane users can also map themselves to unmapped SCM users listed in the Commits tab. This does not require admin permissions. For details, see Use the Commits tab to track committed changes.
To map an ALM Octane user to an SCM user:
In Settings > Spaces, select the space.
In the Users tab, click in the SCM users cell of a specific ALM Octane user.
Do one of the following:
Select from the list of SCM users known to ALM Octane from previous commits.
Click Add New to add an SCM user. Provide the SCM user's username and email address for identification.
This section discusses ALM Octane user management in a SaaS environment.
Tip: When adding users to ALM Octane, make sure to add them through the ALM Octane interface as described in Add a user.
In a SaaS environment, you can add users in the following ways:
Recommended: Within the administration area of the ALM Octane user interface. For details, see Manage space users. You can also customize user roles from the ALM Octane administration area. For details, see Roles and permissions.
From the MyAccount > Users area, if your permissions allow you to add users. This method is not recommended, due to the following behavior:
- If you add users in the MyAccount > Users area, they are not automatically added to the ALM Octane users.
- If the configuration allows MyAccount users to launch an ALM Octane tenant, they will automatically be assigned to the default workspace with a Viewer role. The roles you set in the MyAccount area are unrelated to the roles assigned in ALM Octane. Therefore, to allow users to perform actions, ALM Octane admins will need to reassign roles and workspaces.
If you remove a user from the MyAccount > Users area, the user will continue to exist in the space.
Space admins can deactivate a user temporarily, but not delete them. When a user is deactivated, the user no longer consumes a license. This is especially relevant for the Named License type. For details, see Activate or deactivate a user.
To permanently delete a user, submit a request through ALM Octane support.