Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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 edit API keys in the target organization (see Getting Your Coveo Cloud V2 Platform Access Token and Getting the Privileges of an Access Token).

    Info
    iconfalse
    titleNote:

    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.

  • You set the enabled property to true  in the request body when you want the new API key to work right away. 

  • You specify a valid owner, targetDomain, and possibly a type for each privilege you want to grant the API key (see Getting the Privileges You Can Assign to an API Key and Valid owner, targetDomain, and Type Value Combinations for Privileges).

    Tip
    iconfalse
    titleBest practice:

    Although optional, you should also specify an adequate displayName, summarizing the API key purpose, and a description, indicating when, for who, and for what purpose you are creating the API key. This information will greatly help whoever manages API keys for this organization.

...