openapi: 3.0.1
info:
title: Coveo Authorization Server API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
paths:
/rest/users/{username}:
get:
tags:
- Users
summary: Show User
description: Shows a user.</br>**Required privilege:** Users - View
operationId: getUser
parameters:
- name: username
in: path
description: The username of the user to show.</br>**Example:** `[email protected]`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
x-pretty-name: getUser
x-ui-operation-id: /rest/users/paramId_get
put:
tags:
- Users
summary: Update User Additional Information
operationId: updateUserAdditionalInformation
parameters:
- name: username
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserModel'
required: true
responses:
'204':
description: No Content
x-pretty-name: updateUserAdditionalInformation
x-ui-operation-id: /rest/users/paramId_put
/rest/organizations/{organizationId}/saml/identityprovider:
get:
tags:
- Saml Identity Providers
summary: Show Identity Provider
description: 'Shows the SAML identity provider of an [organization](https://docs.coveo.com/en/185/).</br>**Required
privilege:** SAML identity provider - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SAML_IDENTITY_PROVIDER","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getIdentityProvider
parameters:
- name: organizationId
in: path
description: The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id)
for which to show the identity provider.</br>**Example:** `mycoveocloudorganizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SamlIdentityProviderModel'
x-pretty-name: getIdentityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/saml/identityprovider_get
put:
tags:
- Saml Identity Providers
summary: Update Identity Provider
description: 'Updates a SAML identity provider of an [organization](https://docs.coveo.com/en/185/).</br>**Required
privilege:** SAML identity provider - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SAML_IDENTITY_PROVIDER","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateIdentityProvider
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
description: The JSON configuration to update the target SAML identity provider to.
content:
application/json:
schema:
$ref: '#/components/schemas/SamlIdentityProviderModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SamlIdentityProviderModel'
x-pretty-name: updateIdentityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/saml/identityprovider_put
post:
tags:
- Saml Identity Providers
summary: Create Identity Provider
description: 'Creates an identity provider for an [organization](https://docs.coveo.com/en/185/).</br>**Required privilege:**
SAML identity provider - Create<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SAML_IDENTITY_PROVIDER","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createIdentityProvider
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
requestBody:
description: The SAML identity provider to create.
content:
application/json:
schema:
$ref: '#/components/schemas/SamlIdentityProviderModel'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/SamlIdentityProviderModel'
x-pretty-name: createIdentityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/saml/identityprovider_post
delete:
tags:
- Saml Identity Providers
summary: Delete Identity Provider
description: 'Deletes the identity provider of an [organization](https://docs.coveo.com/en/185/).</br>**Required privilege:**
SAML identity provider - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SAML_IDENTITY_PROVIDER","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteIdentityProvider
parameters:
- name: organizationId
in: path
description: The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id)
for which to delete the SAML identity provider.</br>**Example:** `mycoveocloudorganizationg8tp8wu3`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteIdentityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SAML_IDENTITY_PROVIDER
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/saml/identityprovider_delete
/rest/organizations/{organizationId}/realms/{realmId}:
put:
tags:
- Organization Realms
summary: Update Realm
description: 'Updates a realm of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateRealmsInGroups
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: realmId
in: path
description: The unique identifier of the realm to update.</br>**Example:** `website-domain-coveo.com`
required: true
schema:
type: string
requestBody:
description: The JSON configuration to update the target realm to.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationRealmModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationRealmModel'
x-pretty-name: updateRealmsInGroups
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/realms/paramId_put
/rest/organizations/{organizationId}/members:
get:
tags:
- Organization Members
summary: List Members
description: 'Lists the members of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getOrganizationMembers
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/OrganizationMemberModel_Public'
x-pretty-name: getOrganizationMembers
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/members_get
put:
tags:
- Organization Members
summary: Update Organization Members
description: 'Updates the [members](https://docs.coveo.com/en/2869/) of an [organization](https://docs.coveo.com/en/185/).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateOrganizationMembers
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sendEmailToInvitedUsers
in: query
description: Whether to send an invitation email alongside the invite(s).</br>**Default:** `true`
required: false
schema:
type: boolean
default: true
requestBody:
description: The JSON configuration to which to update the organization members (e.g., send invites to new members,
remove old members, etc).
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OrganizationInviteModel_Public'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/OrganizationMemberModel_Public'
x-pretty-name: updateOrganizationMembers
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/members_put
/rest/organizations/{organizationId}/members/{username}:
get:
tags:
- Organization Members
summary: Show Member
description: 'Shows a [member](https://docs.coveo.com/en/2869/) of an [organization](https://docs.coveo.com/en/185/).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getOrganizationMember
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: username
in: path
description: The username of the member to show.</br>**Example:** `[email protected]`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationMemberModel_Public'
x-pretty-name: getOrganizationMember
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/members/paramId_get
put:
tags:
- Organization Members
summary: Update Member
description: 'Updates a member of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateOrganizationMember
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: username
in: path
description: The username of the member to update.</br>**Example:** `[email protected]`
required: true
schema:
type: string
requestBody:
description: The JSON configuration to update the target [member](https://docs.coveo.com/en/2869/) to.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationMemberModel_Public'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/OrganizationMemberModel'
x-pretty-name: updateOrganizationMember
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/members/paramId_put
delete:
tags:
- Organization Members
summary: Delete Member
description: 'Deletes a member from all groups of an [organization](https://docs.coveo.com/en/185/).</br>**Note:** Deleted
users can still be included by domain.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteOrganizationMember
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: username
in: path
description: The username of the member to delete.</br>**Example:** `[email protected]`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteOrganizationMember
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/members/paramId_delete
/rest/organizations/{organizationId}/groups/{groupId}:
get:
tags:
- Groups
summary: Show Group Details
description: 'Show the details of a [group](https://docs.coveo.com/en/2867/) in an organization.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getGroup
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: groupId
in: path
description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/GroupModel_Response'
x-pretty-name: getGroup
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/groups/paramId_get
put:
tags:
- Groups
summary: Update Group
description: 'Updates a [group](https://docs.coveo.com/en/2867/) in an organization.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"EDIT","targetId":"{groupId}"}
```
</details>'
operationId: updateGroup
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: groupId
in: path
description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
required: true
schema:
type: string
- name: sendEmailToInvitedUsers
in: query
description: Whether to send an email to the users that are invited to the [group](https://docs.coveo.com/en/2867/).
required: false
schema:
type: boolean
default: true
requestBody:
description: The JSON configuration to update the target [group](https://docs.coveo.com/en/2867/) to.
content:
application/json:
schema:
$ref: '#/components/schemas/GroupModel_Request'
required: true
responses:
'204':
description: No Content
x-pretty-name: updateGroup
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '{groupId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '{groupId}'
x-ui-operation-id: /rest/organizations/paramId/groups/paramId_put
delete:
tags:
- Groups
summary: Delete Group
description: 'Deletes a [group](https://docs.coveo.com/en/2867/) in an organization.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"GROUP","type":"EDIT","targetId":"{groupId}"}
```
</details>'
operationId: deleteGroup
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: groupId
in: path
description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteGroup
x-required-privilege:
owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '{groupId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: GROUP
type: EDIT
targetId: '{groupId}'
x-ui-operation-id: /rest/organizations/paramId/groups/paramId_delete
/rest/organizations/{organizationId}/apikeys/{sourceApiKeyId}/duplicate:
put:
tags:
- Api Keys
summary: Duplicate API Key
description: 'Duplicates and existing API key of an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","type":"CREATE","targetId":"*"}
```
</details>'
operationId: duplicateApiKey
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: sourceApiKeyId
in: path
description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
the apiKeyId](https://docs.coveo.com/en/38/).
required: true
schema:
type: string
requestBody:
description: The JSON configuration of the API key to be duplicated.
content:
application/json:
schema:
$ref: '#/components/schemas/DuplicatedApiKeyRequest'
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiKeyWithValueResponse'
x-pretty-name: duplicateApiKey
x-required-privilege:
owner: PLATFORM
targetDomain: API_KEY
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: API_KEY
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/apikeys/paramId/duplicate_put
/rest/organizations/{organizationId}/apikeys/{apiKeyId}:
get:
tags:
- Api Keys
summary: Show API Key
description: 'Shows an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","type":"VIEW","targetId":"*"}
```
</details>'
externalDocs:
description: Getting the API Key ID
url: https://docs.coveo.com/en/38/
operationId: getApiKey
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: apiKeyId
in: path
description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiKeyResponse'
x-pretty-name: getApiKey
x-required-privilege:
owner: PLATFORM
targetDomain: API_KEY
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: API_KEY
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/apikeys/paramId_get
put:
tags:
- Api Keys
summary: Update API Key
description: 'Updates an existing API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","type":"EDIT","targetId":"{apiKeyId}"}
```
</details>'
operationId: updateApiKey
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: apiKeyId
in: path
description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
the apiKeyId](https://docs.coveo.com/en/38/).
required: true
schema:
type: string
requestBody:
description: The JSON configuration to update the target API key to.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyUpdateRequest'
required: true
responses:
'204':
description: No Content
x-pretty-name: updateApiKey
x-required-privilege:
owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-ui-operation-id: /rest/organizations/paramId/apikeys/paramId_put
delete:
tags:
- Api Keys
summary: Delete API Key
description: 'Deletes an API key from an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","type":"EDIT","targetId":"{apiKeyId}"}
```
</details>'
externalDocs:
description: Deleting an API Key
url: https://docs.coveo.com/en/82/#delete-an-api-key-programmatically
operationId: deleteApiKey
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: apiKeyId
in: path
description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
the apiKeyId](https://docs.coveo.com/en/38/).
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: deleteApiKey
x-required-privilege:
owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-ui-operation-id: /rest/organizations/paramId/apikeys/paramId_delete
/rest/organizations/{organizationId}/apikeys/{apiKeyId}/disable:
put:
tags:
- Api Keys
summary: Disable API Key
description: 'Disables an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","type":"EDIT","targetId":"{apiKeyId}"}
```
</details>'
operationId: disableApiKey
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: apiKeyId
in: path
description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
the apiKeyId](https://docs.coveo.com/en/38/).
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: disableApiKey
x-required-privilege:
owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-ui-operation-id: /rest/organizations/paramId/apikeys/paramId/disable_put
/rest/organizations/{organizationId}/apikeys/{apiKeyId}/activation/extend:
put:
tags:
- Api Keys
summary: Extend API Key Activation
description: 'Extend the activation of an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","type":"EDIT","targetId":"{apiKeyId}"}
```
</details>'
operationId: extendActivation
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`mycoveocloudv2organizationg8tp8wu3`
required: true
schema:
type: string
- name: apiKeyId
in: path
description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
the apiKeyId](https://docs.coveo.com/en/38/).
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: extendActivation
x-required-privilege:
owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: API_KEY
type: EDIT
targetId: '{apiKeyId}'
x-ui-operation-id: /rest/organizations/paramId/apikeys/paramId/activation/extend_put
/rest/organizations/{organizationId}/apikeys/{apiKeyId}/activate:
put:
tags:
- Api Keys
summary: Activate API Key
description: 'Activates an API key in an [organization](https://docs.coveo.com/en/185/glossary/coveo-organization).<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"API_KEY","t
# --- truncated at 32 KB (188 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-authorization-openapi-original.yml