Skip to end of metadata
Go to start of metadata

A Coveo Cloud V2 API key is granted a set of privileges which are only valid within the confines of a specific Coveo Cloud V2 organization (see Privileges). 

You can use the Get all possible privileges for api keys in the selected organization call to retrieve the list of values which are assignable to the privileges parameter when you create an API Key (see Creating an API Key):

Ensure that:

  • You replace {organizationId} in the path by the actual ID of the target Coveo Cloud V2 organization (see Getting the organizationId).
  • You replace MyOAuth2Token in the Authorization header by an access token that grants you the privilege to view API keys in the target organization (see Getting Your Coveo Cloud V2 Platform Access Token). 

    Note:

    It is not possible to authenticate this call using an API key, since an API key cannot have the privilege to edit or view other API keys.

The body of a successful response contains the list of all privileges which are individually assignable to any API key in the Coveo Cloud V2 organization matching the organizationId you provide as a path argument.

Note:

The most important properties of an API key privilege are its targetDomainowner, and type (see Valid Privilege owner, targetDomain, and type Combinations). You do not need to specify the targetIds and global properties of the privileges you include in the privileges parameter when you create an API key.

Example:
200 OK
  • No labels