Manage members and groups
Manage members and groups
This is for:
System AdministratorThe members of your Coveo organization are organized by groups to ease privilege management. The members of a group are granted a set of privileges, which determines which features and data of Coveo these group members can access.
Coveo organizations come with built-in groups, which you can use, duplicate, or edit. You can also create your own groups.
The following is an overview of these original tasks but, as mentioned previously, you can edit the privilege set of a group at any moment. You can also refer to the comparison tables to review the privileges granted to each template.
Built-in groups
A Coveo organization comes with several built-in member groups. Each group is granted a set of privileges that gives the members access to the tools required to accomplish their tasks in the Coveo Administration Console.
The Coveo built-in groups have already been granted a set of privileges that’s appropriate for their duties. You can edit these groups and add members to them.
|
|
Leading practice
Before adding members to a built-in group, you should review the default privilege set of that group to ensure that it’s in accordance with your business' hierarchy of responsibilities. |
Alternatively, when granting privileges to a group created from scratch, you can start from these privilege sets.
The Coveo built-in groups have been created with specific duties in mind. The following is an overview of these original tasks but, as mentioned previously, you can edit a group’s privileges at any moment.
Administrators
Members of the Administrators group have the highest access level for all privileges and can create resources in all domains. You should therefore only allow a few select users in the Administrators group of your Coveo organization.
The Administrators group is the only one that can manage search pages. They can modify your organization settings and implement a single sign-on method for organization members to use at login. Furthermore, administrators can access all the indexed content and query logs for troubleshooting purposes. They can also receive notifications about any type of activity occurring in the organization.
Analytics managers
Analytics managers can manage usage analytics, that is, edit dimensions, named filters, reports, etc.
Analytics viewers
Members of the Analytics Viewers group can access the reports that the analytics managers allowed them to see, but can’t edit these reports. The analytics viewers' job typically requires them to review your organization usage analytics and draw conclusions.
Content managers
Content managers have the privileges required to index content and customize how and what’s retrieved. They can edit sources, fields, and indexing pipeline extensions. They can also execute queries in the Content Browser to ensure data is adequately indexed. Moreover, if you have sources that index the permission system of the original repository, content managers can manage and troubleshoot security identities and security identity providers.
Relevance managers
Relevance managers are typically responsible for optimizing the capabilities of your Coveo solution. They can fine-tune query pipeline components such as ranking rules and featured result rules, create Coveo Machine Learning (Coveo ML) models that will learn from user behavior and help return the most relevant content, and create reports to analyze the impact of their changes.
Users
Members of the Users group can access and use your Coveo-powered search interfaces, but can’t make any changes in the Coveo Administration Console.
|
|
Merchandisers group
Merchandisers shape the presentation and visibility of product content within Coveo. Their responsibilities often include influencing the appearance and ranking of search results, managing product recommendations, and optimizing the overall user search experience. Coveo doesn’t come with a merchandiser built-in group yet. However, you can create your own merchandiser-specific group and grant it the privileges they need through the Merchandisers template. |
Add a group
|
|
Note
Coveo Support employees aren’t authorized to grant privileges to customers in a Coveo organization. If you want to be granted access to a Coveo organization, you must follow the access request workflows of your company. |
On the Groups (platform-ca | platform-eu | platform-au) page, click Add group to add a new group. To edit a group, on the Groups (platform-ca | platform-eu | platform-au) page, select the desired group from the list, and then click Edit in the Action bar.
-
In the Configuration step, enter a name for your group, and then click Next.
-
In the Members step, add members to your group, and then click Next. There are two ways to add members:
-
Selecting identity sets under Include the following identities. An identity set is a group of identities from your SSO identity provider. All identities in a set will be added to the group at once.
Click for details on selecting identity sets
-
You must be logged in with a user from the same SSO as the users you want to add. For example, to add groups from a Okta custom SSO as your identity sets, you must be logged in to the Coveo Administration Console with an Okta account. To add identity sets from another SSO, you must then save your group, log out, log back in with an account in the other SSO, and then edit the group to add your additional identity sets.
-
The SSO provider groups displayed in the Include the following identities menu are the groups provided in the
user.groupsattribute of the identity provider assertion. Therefore, only SSO provider groups in which your account is included are available; as an administrator, you may therefore want to be a member of all groups. This limitation doesn’t apply when configuring this feature via API calls rather than with the Coveo Administration Console. -
Although the users in the identity sets you import into your organization can access Coveo, they don’t appear on the organization member list.
-
-
Picking individual members. Select the identity provider with which they log in to Coveo, enter their email address, and then click Add to group. The selected member then appears in the list under the button and will be invited once you save the group.
-
-
In the Privilege templates step, select a set of privileges to grant to the group members, and then click Next. For a list of the privileges granted with each role-based template, see Privilege template comparison. To manually pick privileges, select Custom. You’ll then be able to set the desired access level on each domain.
If you select Custom
See Navigating the privileges menu and Grant privileges for more information on how privileges are organized. Also see Privilege reference for an exhaustive list of the abilities associated with each domain and access level. Coveo recommends reviewing the rest of the Manage privileges documentation before granting or revoking any privilege.
Leading practices-
Grant only the minimal privileges required for members of a group to perform their Coveo organization tasks.
-
Grant the privilege to edit groups (that is, the Edit access level on the Groups domain) only to the smallest possible number of people, ideally the authority in your company that manages access rights in corporate systems, to ensure only legitimate members have the power to assign privileges to other members.
-
-
On the Access tab, specify whether each group (and API key, if applicable) in your Coveo organization can view or edit the current group.
For example, when creating a new group, you could decide that members of Group A can edit its configuration, while Group B can only view it.
For more information, see Custom access level.
-
Click Add group.
Remove members from a group
-
On the Groups (platform-ca | platform-eu | platform-au) page, select the group, and then click Edit in the Action bar.
-
On the Members tab, select the member you want to remove from the group, and then click Delete in the Action bar.
-
Click Delete to confirm.
-
Click Save.
Add members to a group
There are two ways to add members to a group:
Add individual members to a group
You can select individual members to add to a group.
-
On the Groups (platform-ca | platform-eu | platform-au) page, create or edit the group you want to import you users into.
-
In the Members section, under Additional members, select the identity provider with which they log in to Coveo, enter their email address, and then click Add to group. The selected member then appears in the list under the button and will be invited once you save the group.
-
Click Save.
Import users into a Coveo group
To grant access to Coveo to several users at once, you can import Google, Microsoft, Salesforce, or single sign-on (SSO) users into a Coveo group. These users will then log in to your organization using their credentials from this system.
-
Log in to Coveo (platform-ca | platform-eu | platform-au) with a user account from the same domain or identity provider as the users you want to add. For example, to add user groups from an SSO identity provider you’ve configured, log in using the SSO.
-
On the Groups (platform-ca | platform-eu | platform-au) page, create or edit the group you want to import you users into.
-
In the Members section, under Include the following identities, select the user groups to add to the Coveo group.
-
Click Save.
|
|
Note
Although the users in the identity sets you import into your organization can access Coveo, they don’t appear on the organization member list. |
Duplicate a group
On the Groups (platform-ca | platform-eu | platform-au) page, click the group that you want to duplicate, and then click Duplicate in the Action bar.
The duplicate of the original group has a name in the following format: [OriginalGroupName]_copy.
Back on the Groups page, you can edit this group to change its name or any other aspect of its configuration.
|
|
Note
You can only duplicate groups that are granted fewer privileges than yours. |
Your group has been granted the four following privileges:
| Service | Domain | Access level |
|---|---|---|
Analytics |
View all reports |
Allowed |
Organization |
Activities |
View |
Organization |
Groups |
Edit |
Organization |
Organization |
View |
You can therefore duplicate groups that have three or fewer privileges.
Delete a group
|
|
Note
You can’t delete the Administrators group. |
-
On the Groups (platform-ca | platform-eu | platform-au) page, click the group you want to remove from your organization, and then click Delete in the Action bar.
-
Click Delete to confirm.
Review the activity regarding groups
As part of your duties, you may need to review activities related to groups for investigation or troubleshooting purposes.
To do so, in the upper-right corner of the Groups (platform-ca | platform-eu | platform-au) page, click .
See Review resource activity for details on activities and alternative ways to access this information.
Required privileges
By default, members of the Administrators built-in group can create and edit groups. See Manage privileges for more information on API key or member group privileges.
See Privilege reference for more information on typical privilege grantees and grantee abilities for each domain.
The following table indicates the privileges required to view or edit elements of the Groups (platform-ca | platform-eu | platform-au) page and associated subpages.
| Action | Service | Domain | Required access level |
|---|---|---|---|
View groups |
Organization |
Activities |
View |
Groups |
|||
Organization |
|||
Edit groups |
Organization |
Activities |
View |
Organization |
|||
Groups |
Edit |
|
|
A member with the View access level on the Activities domain can access the Activity Browser. This member can therefore see all activities taking place in the organization, including those from Coveo Administration Console pages that they can’t access. |