openapi: 3.0.1
info:
title: Coveo Security Cache 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/organizations/{organizationId}/securityproviders/{securityProviderId}:
get:
tags:
- Security Providers
summary: Get a Single Security Provider for an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSecurityProvider
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SecurityProviderModelWithStatus'
x-pretty-name: getSecurityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId_get
put:
tags:
- Security Providers
summary: Update a Security Provider for an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createOrUpdateSecurityProvider
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityProviderModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SecurityProviderModelWithStatus'
x-pretty-name: createOrUpdateSecurityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId_put
delete:
tags:
- Security Providers
summary: Remove a Security Provider from an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"{securityProviderId}"}
```
</details>'
operationId: removeSecurityProvider
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: removeSecurityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId_delete
/rest/organizations/{organizationId}/securityproviders/{securityProviderId}/schedules/{scheduleId}:
put:
tags:
- Security Providers Schedules
summary: Update a Security Provider Schedule
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"{securityProviderId}"}
```
</details>'
operationId: updateSchedule
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
- name: scheduleId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ScheduleModel'
x-pretty-name: updateSchedule
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId/schedules/paramId_put
/rest/organizations/{organizationId}/securityproviders/{securityProviderId}/raw:
get:
tags:
- Security Providers
summary: Get the Raw Configuration of a Security Provider for an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSecurityProviderRaw
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/RawSecurityProviderConfig'
x-pretty-name: getSecurityProviderRaw
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId/raw_get
put:
tags:
- Security Providers
summary: Update the Raw Configuration of a Security Provider for an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createOrUpdateSecurityProviderRaw
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
- name: forceUpdate
in: query
required: false
schema:
type: boolean
default: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RawSecurityProviderConfig'
required: true
responses:
'204':
description: No Content
x-pretty-name: createOrUpdateSecurityProviderRaw
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId/raw_put
/rest/organizations/{organizationId}/securitycache/schedules/{scheduleId}:
get:
tags:
- Security Cache
summary: Get a Security Cache Schedule
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getScheduleById
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: scheduleId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ScheduleModel'
deprecated: true
x-pretty-name: getScheduleById
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/schedules/paramId_get
put:
tags:
- Security Cache
summary: Update a Security Cache Schedule
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateSchedule_1
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: scheduleId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ScheduleModel'
deprecated: true
x-pretty-name: updateSchedule
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/schedules/paramId_put
/rest/organizations/{organizationId}/securityproviders:
get:
tags:
- Security Providers
summary: Get All Security Providers for an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSecurityProviders
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/SecurityProviderModelWithStatus'
x-pretty-name: getSecurityProviders
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders_get
post:
tags:
- Security Providers
summary: Create a Security Provider for an Organization
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"CREATE","targetId":"*"}
```
</details>'
operationId: createSecurityProvider
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityProviderModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/SecurityProviderModel'
x-pretty-name: createSecurityProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: CREATE
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: CREATE
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders_post
/rest/organizations/{organizationId}/securityproviders/batch/filter:
post:
tags:
- Security Providers
summary: Get and Filter Security Providers by Ids for an Organization.
description: 'Lists the requested [security providers](https://docs.coveo.com/en/242/) by their respective ids. The
unknown ids are ignored.<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSecurityProvidersByIdsWithFilter
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: filter
in: query
description: The text to filter security providers by (applied to the id, and displayName properties).<br/>**Example:**
`Email Security Provider`
required: false
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
required: false
schema:
type: integer
format: int32
default: 100
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelSecurityProviderModelWithStatus'
x-pretty-name: getSecurityProvidersByIdsWithFilter
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/batch/filter_post
/rest/organizations/{organizationId}/securitycache/{securityProviderId}/refresh:
post:
tags:
- Security Cache
summary: Triggers a Refresh on a Security Provider
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"{securityProviderId}"}
```
</details>'
operationId: refreshProvider
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: refreshProvider
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-ui-operation-id: /rest/organizations/paramId/securitycache/paramId/refresh_post
/rest/organizations/{organizationId}/securitycache/{securityProviderId}/refresh/cancel:
post:
tags:
- Security Cache
summary: Cancels the Current Refresh Operation on a Security Provider
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"{securityProviderId}"}
```
</details>'
operationId: cancelProviderRefresh
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: cancelProviderRefresh
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-ui-operation-id: /rest/organizations/paramId/securitycache/paramId/refresh/cancel_post
/rest/organizations/{organizationId}/securitycache/{securityProviderId}/disabled/enable:
post:
tags:
- Security Cache
summary: Enable All Disabled Entities for a Specified Security Provider
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"{securityProviderId}"}
```
</details>'
operationId: enableProviderDisabledEntities
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: enableProviderDisabledEntities
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '{securityProviderId}'
x-ui-operation-id: /rest/organizations/paramId/securitycache/paramId/disabled/enable_post
/rest/organizations/{organizationId}/securitycache/refresh:
post:
tags:
- Security Cache
summary: Triggers a Refresh on the Security Cache
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"EDIT","targetId":"*"}
```
</details>'
operationId: refresh
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: refresh
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/refresh_post
/rest/organizations/{organizationId}/securitycache/refresh/entity:
post:
tags:
- Security Cache
summary: Refreshes a Single Entity in the Security Cache
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"EDIT","targetId":"*"}
```
</details>'
operationId: refreshEntity
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityCacheMemberModel'
required: true
responses:
'204':
description: No Content
x-pretty-name: refreshEntity
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/refresh/entity_post
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members/parents:
post:
tags:
- Security Cache
summary: Get Parent Entities for a Specified Security Provider Member
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getParentEntities
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
- name: recursive
in: query
required: false
schema:
type: boolean
default: false
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: pageSize
in: query
required: false
schema:
type: integer
format: int32
default: 100
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityCacheMemberModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelDetailedSecurityCacheMemberModel'
x-pretty-name: getParentEntities
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/entities/paramId/members/parents_post
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members/children:
post:
tags:
- Security Cache
summary: Get Child Entities for a Specified Security Provider Member
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getChildEntities
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
- name: recursive
in: query
required: false
schema:
type: boolean
default: false
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: pageSize
in: query
required: false
schema:
type: integer
format: int32
default: 100
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityCacheMemberModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelDetailedSecurityCacheMemberModel'
x-pretty-name: getChildEntities
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/entities/paramId/members/children_post
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/entity:
post:
tags:
- Security Cache
summary: Get Entity Information for a Specified Security Provider Member
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getEntity
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SecurityCacheMemberModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DetailedSecurityCacheMemberModel'
x-pretty-name: getEntity
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/entities/paramId/entity_post
/rest/organizations/{organizationId}/securitycache/entities/list:
post:
tags:
- Security Cache
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"VIEW","targetId":"*"}
```
</details>'
operationId: listSecurityIdentities
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: perPage
in: query
required: false
schema:
type: integer
format: int32
default: 100
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/IdentitiesFilterModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageModelDetailedSecurityCacheMemberModel'
x-pretty-name: listSecurityIdentities
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/entities/list_post
/rest/organizations/{organizationId}/securitycache/disabled/enable:
post:
tags:
- Security Cache
summary: Enable All Disabled Entities on Security Cache
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"EDIT","targetId":"*"}
OR
{"owner":"PLATFORM","targetDomain":"SECURITY_CACHE","type":"EDIT","targetId":"*"}
```
</details>'
operationId: enableDisabledEntities
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'204':
description: No Content
x-pretty-name: enableDisabledEntities
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: EDIT
targetId: '*'
- owner: PLATFORM
targetDomain: SECURITY_CACHE
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securitycache/disabled/enable_post
/rest/organizations/{organizationId}/securityproviders/{securityProviderId}/schedules:
get:
tags:
- Security Providers Schedules
summary: Get Security Provider Schedules
description: '<details><summary>Privilege required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getSchedules
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
- name: securityProviderId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleModel'
x-pretty-name: getSchedules
x-required-privilege:
owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-required-privileges:
- owner: PLATFORM
targetDomain: SECURITY_PROVIDER
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/securityproviders/paramId/schedules_get
/rest/organizations/{organizationId}/securityproviders/page:
get:
tags:
- Security Providers
summary: Get and Filter Security Providers by Page for an Organization.
description: 'Lists the filtered [security providers](https://docs.coveo.com/en/242/) by page.<br /><br /><details><summary>Privilege
required</summary>
```
{"owner":"PLATFORM","targetDomain":"SECURITY_PROVIDER","
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-security-cache-openapi-original.yml