Privilege reference

This is for:

In this article

Analytics service
Commerce service
Content service
Customer service
Machine Learning service
Organization service
Search service

In the Coveo privilege system, each domain can be associated to one or more access level to form a privilege, which allows an API key or a group of users to perform certain operations in the Coveo Administration Console. See Manage privileges and Navigate the "Privileges" tab for more information.

However, although many domains offer a View and an Edit access level, the abilities represented by these access levels may differ from domain to domain. Some domains also offer different access level options such as Allowed or Push. So, to help you grant the appropriate privilege to groups of users or API keys, this page details what your grantee can do when granted each access level option for each domain. In the Coveo Administration Console, domains of privilege are grouped by service, and this page uses the same arrangement. Use the In this article menu on the right side of the page to browse the services and domains.

The operation of granting privileges isn’t to be taken lightly, as insufficient privileges can hinder task accomplishment, while inadequate or unnecessary privileges could lead to accidents or misuse. When allowed to delegate powers, you should have a good understanding of how the Coveo privilege system works and be well aware of the implications of each choice you make. In this regard, we recommend thoroughly reading the privilege documentation before granting privileges or editing a privilege set, and enforcing the principle of least privilege, i.e., granting just enough privileges for the grantee to perform their tasks (see Manage privileges and Principle of Least Privilege).

In the tables below, the typical grantees associated to a privilege are mostly the built-in groups that are granted this access level by default. However, they could also include typical groups of users that should have the privilege granted to them (e.g., support agents). Members of the Administrators group are always granted the highest access level. Similarly, the Typical grantee column shows which API key presets are granted each access level.

Analytics service

Administrate domain

Access level

Grantee abilities

Typical grantees

Allowed

Manage the organization usage analytics data:
- Add and delete test usage analytics data in the account
- Edit, get, delete, and disable the organization account
Define IP addresses whose events are flagged as internal

This privilege is especially potent since grantees can delete usage analytics data and could inadvertently corrupt it as well.

Administrators
Admin API keys
Analytics API keys

Analytics Data domain

Access level	Grantee abilities	Typical grantees
View	View reports View dimensions View named filters View permission filters View usage analytics data exports	Analytics managers Analytics viewers Relevance managers Admin API keys Monitoring API keys
Push	Send analytics events to Coveo Usage Analytics (Coveo UA)	OAuth tokens, API keys, and search tokens assigned to a process such as a search interface Anonymous search API keys Search API keys
Push and view	View reports View dimensions View named filters View permission filters View usage analytics data exports Send analytics events to Coveo UA	Administrators Analytics API keys

Data Exports domain

The Data exports domain access levels are ineffective without the View access level on the Analytics data domain

Access level	Grantee abilities	Typical grantees
View	View and download usage analytics data exports containing clicks, groups, keywords, searches, and custom events meeting the specified criteria for a specific date range	Monitoring API keys
Edit	Add, edit, or delete analytics data exports from the specified user visits Review user visits	Administrators Analytics managers Analytics viewers Relevance managers Admin API keys Analytics API keys

Data Health domain

The Data Health domain access level is ineffective without the View access level on the Tableau Reports domain.

Access level	Grantee abilities	Typical grantees
View	View organizational data health for a specific date range.	Administrators

Delete User Data domain

Access level

Grantee abilities

Typical grantees

Allowed

Delete usage analytics user data

This privilege is especially potent since grantees can delete usage analytics user data. This can break existing reports and also render some datasets inaccurate.

Administrators
Admin API keys
Analytics API keys

Dimensions domain

The Dimensions domain access levels are ineffective without the View access level on the Analytics data domain.

Access level	Grantee abilities	Typical grantees
View	View dimensions View reports View named filters View permission filters	Analytics viewers Monitoring API keys
Edit	Add, edit, or delete dimensions created by Coveo organization members	Administrators Analytics managers Admin API keys

Impersonate domain

Access level	Grantee abilities	Typical grantees
Allowed	Allow a custom process or bot to push usage analytics events with different identities	Administrators Admin API keys Analytics API keys

Incoherent Events domain

Access level	Grantee abilities	Typical grantees
View	View incoherent usage analytics events	Administrators Admin API keys Analytics API keys Monitoring API keys

Named Filters domain

The Named filters domain access levels are ineffective without the View access level on the Analytics data and Dimensions domains.

Access level	Grantee abilities	Typical grantees
View	View named filters	Analytics viewers Monitoring API keys
Edit	Add, edit, or delete named filters	Administrators Analytics managers Relevance managers Admin API keys Analytics API keys

Permission Filters domain

The Permission filters domain access levels are ineffective without the View access level on the Analytics data and Dimensions domains.

Access level

Grantee abilities

Typical grantees

View

View permission filters restricting the usage analytics data that analysts can review in reports

Note

Without the View access level, you can’t see the permissions filters that are assigned to your identity in reports.

Analytics viewers
Analytics managers
Relevance managers
Monitoring API keys

Edit

Add, edit, or delete permission filters

Note

The Edit access level is ineffective without the View access level on the Groups domain.

Administrators
Admin API keys
Analytics API keys

Reports domain

The Reports domain access levels are ineffective without the View access level on the Analytics data and Dimensions domains.

Access level

Grantee abilities

Typical grantees

View

View usage analytics reports (dashboards and explorers)

Analytics viewers
Monitoring API keys

Edit

Add, edit, or delete usage analytics reports (dashboards and explorers)

Note

The Edit access level is ineffective without the Allowed access level on the Administrate domain.

Administrators
Analytics managers
Relevance managers
Admin API keys
Analytics API keys

Snowflake Management domain

The Edit access level is ineffective without the Allowed access level on the Administrate domain.

Access level	Grantee abilities	Typical grantees
View	View and export usage analytics data through the Snowflake Reader Account View Snowflake reader account monthly credit consumption	Administrators Analytics managers Analytics viewers Relevance managers Monitoring API keys
Edit	Add or edit Snowflake reader accounts Add or block IP addresses Share Data with other Snowflake accounts	Administrators Analytics managers Relevance managers Admin API keys Analytics API keys

Tableau Reports domain

The Tableau Reports domain access level is ineffective without the View access level on the Analytics Data and the Reports domains.

Access level	Grantee abilities	Typical grantees
View	View advanced reports	Administrators Monitoring API keys

View All Reports domain

Access level

Grantee abilities

Typical grantees

Allowed

View all reports, regardless of report accesses. Members that don’t have this access level can only review the reports they’re explicitly allowed to access.

This privilege is especially potent since grantees bypass report permissions and could therefore access sensitive information that they wouldn’t be allowed to access otherwise.

Administrators
Analytics managers
Admin API keys
View all reports

Commerce service

Catalog domain

Access level	Grantee abilities	Typical grantees
View	View catalogs and catalog configuration	Monitoring API keys
Edit	Add, edit, or delete catalogs	Administrators Admin API keys

Product Listing domain

Access level	Grantee abilities	Typical grantees
View	View product listings	Monitoring API keys
Edit	Add, edit, or delete product listings	Administrators Admin API keys

Content service

Connectivity Diagnostic Logs domain

Access level	Grantee abilities	Typical grantees
View	Download update logs	Administrators Content managers Admin API keys Monitoring API keys

Crawling Module domain

Access level

Grantee abilities

Typical grantees

View

Access the Crawling Modules (platform-ca | platform-eu | platform-au) page
Select the Crawling Module instance responsible for crawling a source

Content managers
Users
Monitoring API keys

Note

Only content managers and users of organizations created after November 19th, 2019 are granted this privilege by default. Content managers and users of older organizations can be granted this privilege manually if needed.

Edit

This access level allows a Crawling Module instance to report its status to Coveo. This status is then displayed on the Crawling Modules (platform-ca | platform-eu | platform-au) page. Granting this access level to groups of users doesn’t give them any additional capabilities.

Administrators
Admin API keys
Crawling Module API keys

Note

Administrators are granted the highest access level for all domains, including Crawling Module. However, in this case, having the Edit access level instead of View doesn’t grant them any additional capabilities. It only makes a difference for Crawling Module API keys, which require the Edit access level.

Crawling Module Log Request

Access level

Grantee abilities

Typical grantees

View

Granting this privilege to groups of users or API keys doesn’t give them any additional capabilities.

Edit

Download Crawling Module logs from the Activity panel

This privilege is especially potent since grantees can use it to access logs that are normally available to the host server’s administrators only. Although the logs contain no sensitive information such as passwords and no indexed content, they still show the hostname of the Crawling Module host server, the accessed URLs, etc.

Administrators
Admin API keys

Extensions domain

Access level		Grantee abilities	Typical grantees
View all		View the code and usage statistics of available extensions assigned to sources. This is especially useful when troubleshooting cases such as item indexing issues.	Monitoring API keys
Custom	View	View the code and usage statistics of the specified extensions. This is especially useful when troubleshooting cases such as item indexing issues.
Custom	Edit	Add code snippets to apply transformations to indexed items such as adding or modifying metadata. We recommend that you grant this privilege to developers only.
Edit all		Add code snippets to apply transformations to indexed items such as adding or modifying metadata. We recommend that you grant this privilege to developers only.	Administrators Content managers Admin API keys

Fields domain

Access level	Grantee abilities	Typical grantees
View	View fields and field configuration	Users Monitoring API keys
Edit	Add, edit, or delete fields Add, update, or delete fields in batches	Administrators Content managers Admin API keys

Logical Indexes domain

Access level	Grantee abilities	Typical grantees
View	When your organization has more than one index: On the Sources page, see in which index the content of each source is stored When adding a source, select the index in which the retrieved content will be stored	Monitoring API keys
Edit	This access level doesn't give its grantee any additional capabilities.	Administrators Content managers Admin API keys

Security Identities domain

The Security identities domain access levels are ineffective without the View access level on the Security identity providers domain.

Access level	Grantee abilities	Typical grantees
View	View security identity provider update status, statistics, and refresh schedule View security identity provider references such as provider IDs and the sources that use each provider View the permissions and effective permissions on Coveo organization items View security identities and their status inside each security provider	Monitoring API keys
Edit	Only required by certain API calls (e.g., enable all disabled entities in security cache). Granting this access level to groups of users doesn't give them any additional capabilities.	Administrators Admin API keys

Security Identity Providers domain

Access level	Grantee abilities	Typical grantees
View	View security identity provider update status, statistics, and refresh schedule View security identity provider references such as provider IDs and the sources that use each provider View security identities and their status inside each security provider	Monitoring API keys
Edit	Refresh security identity providers Configure security identity refresh schedules Edit a security identity provider	Administrators Admin API keys

Source Metadata domain

Access level

Grantee abilities

Typical grantees

View

View a sample of the metadata discovered while indexing a source

This privilege is especially potent since grantees bypass the content permissions of the sources they can edit. They can therefore access sensitive index content that they can’t normally access in the original repository.

Administrators
Admin API keys

Sources domain

Notes

To review source content in the Content Browser, you must have the Allowed access level on the Execute queries domain.
Unlike for other resources, the ability to create sources can be granted without the Edit access level. You can therefore grant a group or API key the View all or Custom access level for the Sources domain and check the Can Create checkbox to allow users to create resources in this domain.

Access level		Grantee abilities	Typical grantees
View all		View all sources View configuration of all sources View all source logs Subscribe to source notifications	Users
Custom	View	View source View source configuration View source logs Subscribe to source notifications	Monitoring API keys
Custom	Edit	Edit or delete specific sources Schedule source updates Edit specific source mappings Launch, pause, resume, and cancel specific source updates Use the push API to send content to Coveo Subscribe to source notifications	Monitoring API keys
Edit all		Add sources Edit or delete all sources Edit all source update schedules Edit all source mappings Launch, pause, resume, and cancel all source updates Use the push API to send content to Coveo Subscribe to source notifications	Administrators Content managers Admin API keys

Customer service

Case Assist Configuration domain

Access level	Grantee abilities	Typical grantees
View	View elements of the Case Assist (platform-ca \| platform-eu \| platform-au) page	Monitoring API keys
Edit	Manage elements of the Case Assist (platform-ca \| platform-eu \| platform-au) page	Administrators Admin API keys

Use Case Assist domain

Access level	Grantee abilities	Typical grantees
Allowed	Leverage case assist configurations in support cases	Administrators Content managers Relevance managers Users

Insight Panel Configuration domain

Access level	Grantee abilities	Typical grantees
View	View elements of the Insight Panel (platform-ca \| platform-eu \| platform-au) page	Monitoring API keys
Edit	Manage elements of the Insight Panel (platform-ca \| platform-eu \| platform-au) page	Administrators Admin API keys

Insight Panel Interface domain

Access level	Grantee abilities	Typical grantees
View	View an Insight Panel interface in a Customer Relationship Management (CRM) system	Monitoring API keys
Edit	Create, update, or delete an Insight Panel interface	Administrators Admin API keys

Insight Panel Items domain

Access level	Grantee abilities	Typical grantees
View	View items that are relevant to a case in an Insight Panel interface	Administrators Support agents Admin API keys Monitoring API keys

Machine Learning service

Allow Content Preview domain

Access level

Grantee abilities

Typical grantees

Enable

Inspect the resources available to create content-based Coveo Machine Learning models

This privilege gives grantees indirect access to index content. Grantees could therefore have access to sensitive content to which they wouldn’t have under normal conditions.

Administrators
Relevance managers
Admin API keys

Models domain

Access level	Grantee abilities	Typical grantees
View	View Coveo Machine Learning models	Monitoring API keys
Edit	Add, edit, or delete machine learning models, and therefore optimize search results relevance and search experience in general	Administrators Relevance managers Admin API keys

User Profiles domain

Access level	Grantee abilities	Typical grantees
View	View the Coveo Machine Learning user profile made for each user or visitor ID	Monitoring API keys
Edit	Edit the Coveo Machine Learning user profile made for each user or visitor ID	Administrators Admin API keys

Organization service

API Keys domain

Note

This domain is only available when configuring groups, as API keys can’t be granted the privilege to view or edit other API keys.

Access level		Grantee abilities	Typical grantees
View all		View in read-only mode the configuration of all API keys	Content managers Relevance managers Monitoring API keys
Custom	View	View in read-only mode the configuration of specific API keys
Custom	Edit	Edit, delete, activate, and disable specific API keys
Edit all		Add, edit, delete, activate, and disable all API keys	Administrators Admin API keys

Activities domain

Access level

Grantee abilities

Typical grantees

View

Access the Activity Browser and view all organization activities

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 Administration Console pages that they can’t access.

Content managers
Relevance managers
Monitoring API keys

Edit

Send custom activities to Coveo

Administrators
Admin API keys

Critical Updates domain

Access level		Grantee abilities	Typical grantees
View		Access the list of available critical updates	Monitoring API keys
Edit		Enable/disable critical updates in the organization	Administrators Admin API keys

Groups domain

Leading practice

Grant the Edit or Edit all access level for the Groups domain only to a few people, ideally the authority in your company that manages access rights in corporate systems.

Access level		Grantee abilities	Typical grantees
View all		View all groups, including their privileges View organization members	Analytics managers Monitoring
Custom	View	View groups, including their privileges	Content managers Relevance managers
Custom	Edit	Duplicate, edit, or delete groups and members Edit group member privileges Send invitations to users	Relevance managers
Edit all		Duplicate, edit, or delete all groups and their members Edit privileges of all groups Send invitations to users	Administrators Admin API keys

Note

For the above grantees, by default, members of the Relevance Managers built-in group can edit this group only. This allows them to invite other people in the Relevance Managers group, but not in other groups.

The Edit all access level is especially potent since grantees can use it to add anyone, including themselves, to any organization group. This can lead to privilege escalation

Link domain

See Privileges required to manage snapshots for details on the privileges you need to use the resource snapshot feature.

Access level		Grantee abilities	Typical grantees
View		Validate a resource snapshot View changes to apply	Monitoring API keys
Edit		Match analogous resources	Administrators Admin API keys

Notifications domain

Access level		Grantee abilities	Typical grantees
View		View organization notifications	Monitoring API keys
Edit		Edit and delete organization notifications	Administrators Admin API keys

On-Premises Administration domain

The privileges of this domain are required by the Coveo On-Premises Crawling Module API keys only. Granting these privileges to groups of users doesn’t give them any additional capabilities.

Access level

Grantee abilities

Typical grantees

View

Monitoring API keys

Edit

This access level, when granted to a Coveo On-Premises Crawling Module API key, allows the Crawling Module to communicate with Coveo. Granting it to users or groups doesn’t give them any additional capabilities.

Administrators
Admin API keys
Crawling Module API keys

Note

Administrators are granted the highest access level for all domains, including On-Premises Organization. However, in this case, having the Edit access level instead of View doesn’t grant them any additional capabilities. It only makes a difference for Crawling Module API keys, which require the Edit access level.

Organization domain

Access level

Grantee abilities

Typical grantees

View

Access the Coveo Administration Console (if the grantee is a group of users)
View the Coveo license details and limits, as well as the organization basic information

Analytics managers
Analytics viewers
Content managers
Relevance managers
Users
Monitoring API keys

Edit

Administrators
Admin API keys

Single Sign-On Identity Provider domain

Access level		Grantee abilities	Typical grantees
View		View the organization's single sign-on configuration	Monitoring API keys
Edit		Configure single sign-on for the organization	Administrators Admin API keys

Snapshots domain

See Privileges required to manage snapshots for details on the privileges you need to use the resource snapshot feature.

Access level		Grantee abilities	Typical grantees
View		View the snapshots in the organization Copy or download a snapshot Validate a snapshot View changes to apply Match analogous resources	Monitoring API keys
Edit		Create a snapshot Export a snapshot to a different organization Apply a snapshot Delete a snapshot	Administrators Analytics managers Content managers Relevance managers Admin API keys

Temporary Access domain

Access level		Grantee abilities	Typical grantees
View		View who at Coveo has asked for and been granted temporary access to your organization, as well as the privileges they were granted	Monitoring API keys
Edit		Revoke temporary access to your organization	Administrators Admin API keys

Vault Entry domain

See Privileges required to manage snapshots for details on the privileges you need to use the resource snapshot feature.

Note

To import sensitive information in your destination organization, you must have both of the following privileges:

The View access level on the Vault entry domain in the origin organization.
The Edit access level on the Vault entry domain in the destination organization.

Access level		Grantee abilities	Typical grantees
View		Import sensitive information (in the origin organization)	Analytics managers Content managers Relevance managers Monitoring API keys
Edit		Apply a snapshot, if it contains sensitive information Import sensitive information (in the destination organization)	Administrators Admin API keys

Search service

Execute Queries domain

Access level	Grantee abilities	Typical grantees
Allowed	For organization members and API keys to send queries and get search results in search pages connected to their Coveo organization	Administrators Content managers Relevance managers Users Anonymous search API keys

Expression Validation Result domain

Required to use an upcoming feature. Granting privileges on this domain doesn’t give the grantee any additional capabilities yet.

Impersonate domain

Access level

Grantee abilities

Typical grantees

Allowed

Obtain a search token for a search interface that replicates a permission system to execute queries and send usage analytics events as a specific user. See Use search token authentication for more information.

This privilege is especially potent since grantees can impersonate any user and access in search results the content accessible to this user. Grantees could therefore access sensitive items that they can’t normally access in the original repositories.

Administrators
Search API keys

Modify Authentication Provider domain

Access level	Grantee abilities	Typical grantees
Allowed	Manage authentication for sources that index permissions, such as when they're secured with SharePoint claims-based identities	Administrators Admin API keys

Query Logs domain

Access level	Grantee abilities	Typical grantees
View	In your consumption dashboard, download a list of the queries performed in a hub during a certain month	Administrators Admin API keys Monitoring API keys

Query Pipelines domain

Access level		Grantee abilities	Typical grantees
View all		View query pipelines View query pipeline rules View query pipeline rule conditions View A/B tests	Monitoring API keys
Custom	View	View query pipeline View query pipeline rules View query pipeline rule condition View A/B test
Custom	Edit	Edit or delete specific query pipelines Edit or delete specific query pipeline rules Edit or delete specific query pipeline rule conditions Edit or delete specific A/B tests
Edit all		Optimize results relevance and search experience in general: Add, edit, or delete all query pipelines Add, edit, or delete all query pipeline rules Add, edit, or delete all query pipeline rule conditions Add, edit, or delete all A/B tests	Administrators Relevance managers Admin API keys

Salesforce Index Configuration domain

Access level

Grantee abilities

Typical grantees

View

Monitoring API keys

Edit

Link a Coveo organization to a Salesforce organization that uses a Salesforce index

Administrators
Admin API keys

Search Pages domain

Access level		Grantee abilities	Typical grantees
View all		Access all the search pages hosted by the Coveo organization	Users Monitoring API keys
Custom	View	None yet. Custom search page privileges will be available following an upcoming release.
Custom	Edit	None yet. Custom search page privileges will be available following an upcoming release.
Edit all		Add or delete all hosted search pages Customize all search page interfaces	Administrators Admin API keys

The Edit all access level is a sensitive privilege which is typically granted only to administrators. This privilege should remain limited to avoid being exploited by malicious users who could enter unwanted code and put search page users at risk.

Search Usage Metrics domain

Access level		Grantee abilities	Typical grantees
View		View the Consumption dashboard	Relevance managers Monitoring API keys
Edit		Edit the entitlement metric of a search hub in the Consumption dashboard	Administrators Admin API keys

View All Content domain

Access level

Grantee abilities

Typical grantees

Allowed

Browse all the content of a Coveo organization index

This privilege is especially potent since grantees bypass the content permissions and could therefore access sensitive items that they can’t normally access in the original repositories.

Administrators