How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coveo Security Cache API

The Security Cache API from Coveo — 18 operation(s) for security cache.

Coveo Security Cache API is one of 152 APIs that Coveo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 34 JSON Schema definitions.

Tagged areas include Security Cache. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 34 JSON Schemas.

This API exposes 19 operations across 18 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://platform.cloud.coveo.com.

19 operations 18 paths 13 schemas 8 GET10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform.cloud.coveo.com
Authentication
OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Coveo Security Cache API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 8 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Security Cache 19
GET
/rest/organizations/{organizationId}/securitycache/schedules/{scheduleId}deprecated
Get a Security Cache Schedule
getScheduleById 2 params → 200
PUT
/rest/organizations/{organizationId}/securitycache/schedules/{scheduleId}deprecated
Update a Security Cache Schedule
updateSchedule_1 2 params body → 200
POST
/rest/organizations/{organizationId}/securitycache/{securityProviderId}/refresh
Triggers a Refresh on a Security Provider
refreshProvider 2 params → 204
POST
/rest/organizations/{organizationId}/securitycache/{securityProviderId}/refresh/cancel
Cancels the Current Refresh Operation on a Security Provider
cancelProviderRefresh 2 params → 204
POST
/rest/organizations/{organizationId}/securitycache/{securityProviderId}/disabled/enable
Enable All Disabled Entities for a Specified Security Provider
enableProviderDisabledEntities 2 params → 204
POST
/rest/organizations/{organizationId}/securitycache/refresh
Triggers a Refresh on the Security Cache
refresh 1 param → 204
POST
/rest/organizations/{organizationId}/securitycache/refresh/entity
Refreshes a Single Entity in the Security Cache
refreshEntity 1 param body → 204
POST
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members/parents
Get Parent Entities for a Specified Security Provider Member
getParentEntities 5 params body → 200
POST
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members/children
Get Child Entities for a Specified Security Provider Member
getChildEntities 5 params body → 200
POST
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/entity
Get Entity Information for a Specified Security Provider Member
getEntity 2 params body → 200
POST
/rest/organizations/{organizationId}/securitycache/entities/list
Privilege required {"owner":"PLATFORM","targetDomain":"SECURITYPROVIDER","type":"VIEW","targetId":""} OR {"owner":"PLATFORM","targetDomain":"SECURITYCACHE","type":"VIEW","targetId":""}
listSecurityIdentities 3 params body → 200
POST
/rest/organizations/{organizationId}/securitycache/disabled/enable
Enable All Disabled Entities on Security Cache
enableDisabledEntities 1 param → 204
GET
/rest/organizations/{organizationId}/securitycache/{securityCacheId}/entities/{securityProviderId}
Get the Entities for a Specified Security Provider on a Specified Security Cache
getEntitiesForASecurityCache 10 params → 200
GET
/rest/organizations/{organizationId}/securitycache/status
Get the Security Cache Status
getStatus 1 param → 200
GET
/rest/organizations/{organizationId}/securitycache/status/online
Get Online Security Cache Ids
getOnlineSecurityCacheIds 1 param → 200
GET
/rest/organizations/{organizationId}/securitycache/schedulesdeprecated
Get the Security Cache Schedules
getSchedules_1 1 param → 200
GET
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}
Get the Entities for a Specified Security Provider
getEntities 8 params → 200
GET
/rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members
Get the Members for a Specified Security Provider
getMembers 8 params → 200
GET
/rest/organizations/{organizationId}/securitycache/entities/list/is_supported
Privilege required {"owner":"PLATFORM","targetDomain":"SECURITYPROVIDER","type":"VIEW","targetId":""} OR {"owner":"PLATFORM","targetDomain":"SECURITYCACHE","type":"VIEW","targetId":""}
isListSecurityIdentitiesSupported 1 param → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ScheduleModel (8 properties), DetailedSecurityCacheMemberModel (8 properties), ScheduleFrequency (6 properties), CurrentStatusModel (5 properties). Each schema is shown below with its type and property counts.

IdentitiesFilterModel
object
5 properties
SecurityCacheStatisticsModel
object
5 properties
SecurityCacheStatusModel
object
2 properties
DetailedSecurityCacheMemberModel
object
8 properties
HourMinutePair
object
2 properties
PageModelSIDModel
object
3 properties
ScheduleFrequency
object
6 properties
PageModelDetailedSecurityCacheMemberModel
object
3 properties
SIDModel
object
3 properties
SecurityCacheMemberInfoModel
object
2 properties
SecurityCacheMemberModel
object
4 properties
ScheduleModel
object
8 properties
CurrentStatusModel
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coveo-security-cache-api-openapi.yml Raw ↑

Other APIs Coveo publishes across the network.

Coveo Activities API
Coveo Administration API - Version 15 API
Coveo Advanced Model Configurations API
Coveo Agent Configuration API API
Coveo Agent Orchestration API API
Coveo Analysis V3 API
Coveo Analytics API - Version 14 API
Coveo Analytics API - Version 15 API
Coveo Answer API
Coveo Api Keys API
Coveo Atlassian Connect App API
Coveo Badges API
Where this information came from

This is an independent, third-party profile of Coveo Security Cache API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.