In the request path:
<MyOrganizationId>by the actual ID of the target Coveo Cloud V2 organization (see Retrieving the ID of a Coveo Cloud V2 Organization).
Authorization HTTP header:
MyOAuth2Tokenby an access token that grants you the
API_KEYprivilege in the target organization (see Getting Your Coveo Cloud V2 Platform Access Token and Getting the Privileges of an Access Token).
In the request body:
<MyAPIKeyDescription>by a string indicating for whom, when, and for what purpose you are creating the API key.
<MyAPIKeyDisplayName>by an adequate name, summarizing the API key purpose.
truein the request body when you want the new API key to work right away; set it to
For each privilege you include in the
Specify a valid
typecombination (see Valid owner, targetDomain, and Type Value Combinations for Privileges).
The body of a successful response (
201 Created) contains information about the API key you just created.
- You can use the
idproperty to later edit or delete the API key. You can always get this value back once the API key has been created (see Getting the apiKeyId).
valueproperty contains the API key itself.