naftiko: 1.0.0-alpha2 info: label: Coveo Security Cache API — Security Cache description: 'Coveo Security Cache API — Security Cache. 19 operations. Lead operation: Enable All Disabled Entities on Security Cache. Self-contained Naftiko capability covering one Coveo business surface.' tags: - Coveo - Security Cache - Security Cache created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: COVEO_API_KEY: COVEO_API_KEY capability: consumes: - type: http namespace: security-cache-security-cache baseUri: https://platform.cloud.coveo.com description: Coveo Security Cache API — Security Cache business capability. Self-contained, no shared references. authentication: type: bearer token: '{{env.COVEO_API_KEY}}' resources: - name: rest-organizations-organizationId-securitycache-disabled-enable path: /rest/organizations/{organizationId}/securitycache/disabled/enable operations: - name: enabledisabledentities method: POST description: Enable All Disabled Entities on Security Cache outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-entities-list path: /rest/organizations/{organizationId}/securitycache/entities/list operations: - name: listsecurityidentities method: POST description:
Privilege required outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: page in: query type: integer - name: perPage in: query type: integer - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-securitycache-entities-list-is_supported path: /rest/organizations/{organizationId}/securitycache/entities/list/is_supported operations: - name: islistsecurityidentitiessupported method: GET description:
Privilege required outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-entities-securityProviderId path: /rest/organizations/{organizationId}/securitycache/entities/{securityProviderId} operations: - name: getentities method: GET description: Get the Entities for a Specified Security Provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: states in: query type: array - name: page in: query type: integer - name: perPage in: query type: integer - name: from in: query type: string description: Date filter from, minimum updated date. - name: to in: query type: string description: Date filter to, maximum updated date. - name: usePageModel in: query type: boolean description: 'Deprecated: you can input either ''true'' or ''false'' with no effect on the result.' - name: rest-organizations-organizationId-securitycache-entities-securityProviderId-enti path: /rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/entity operations: - name: getentity method: POST description: Get Entity Information for a Specified Security Provider Member outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-securitycache-entities-securityProviderId-memb path: /rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members operations: - name: getmembers method: GET description: Get the Members for a Specified Security Provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: states in: query type: array - name: page in: query type: integer - name: perPage in: query type: integer - name: from in: query type: string description: Date filter from, minimum updated date - name: to in: query type: string description: Date filter to, maximum updated date - name: usePageModel in: query type: boolean description: 'Deprecated: you can input either ''true'' or ''false'' with no effect on the result.' - name: rest-organizations-organizationId-securitycache-entities-securityProviderId-memb path: /rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members/children operations: - name: getchildentities method: POST description: Get Child Entities for a Specified Security Provider Member outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: recursive in: query type: boolean - name: page in: query type: integer - name: pageSize in: query type: integer - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-securitycache-entities-securityProviderId-memb path: /rest/organizations/{organizationId}/securitycache/entities/{securityProviderId}/members/parents operations: - name: getparententities method: POST description: Get Parent Entities for a Specified Security Provider Member outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: recursive in: query type: boolean - name: page in: query type: integer - name: pageSize in: query type: integer - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-securitycache-refresh path: /rest/organizations/{organizationId}/securitycache/refresh operations: - name: refresh method: POST description: Triggers a Refresh on the Security Cache outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-refresh-entity path: /rest/organizations/{organizationId}/securitycache/refresh/entity operations: - name: refreshentity method: POST description: Refreshes a Single Entity in the Security Cache outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-securitycache-schedules path: /rest/organizations/{organizationId}/securitycache/schedules operations: - name: getschedules1 method: GET description: Get the Security Cache Schedules outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-schedules-scheduleId path: /rest/organizations/{organizationId}/securitycache/schedules/{scheduleId} operations: - name: getschedulebyid method: GET description: Get a Security Cache Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: scheduleId in: path type: string required: true - name: updateschedule1 method: PUT description: Update a Security Cache Schedule outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: scheduleId in: path type: string required: true - name: body in: body type: object description: Request body (JSON). required: true - name: rest-organizations-organizationId-securitycache-status path: /rest/organizations/{organizationId}/securitycache/status operations: - name: getstatus method: GET description: Get the Security Cache Status outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-status-online path: /rest/organizations/{organizationId}/securitycache/status/online operations: - name: getonlinesecuritycacheids method: GET description: Get Online Security Cache Ids outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-securityCacheId-entities-securit path: /rest/organizations/{organizationId}/securitycache/{securityCacheId}/entities/{securityProviderId} operations: - name: getentitiesforasecuritycache method: GET description: Get the Entities for a Specified Security Provider on a Specified Security Cache outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityCacheId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: states in: query type: array - name: page in: query type: integer - name: perPage in: query type: integer - name: from in: query type: string description: Date filter from, minimum updated date. - name: to in: query type: string description: Date filter to, maximum updated date. - name: usePageModel in: query type: boolean description: 'Deprecated: you can input either ''true'' or ''false'' with no effect on the result.' - name: minEntityId in: query type: integer - name: rest-organizations-organizationId-securitycache-securityProviderId-disabled-enab path: /rest/organizations/{organizationId}/securitycache/{securityProviderId}/disabled/enable operations: - name: enableproviderdisabledentities method: POST description: Enable All Disabled Entities for a Specified Security Provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-securityProviderId-refresh path: /rest/organizations/{organizationId}/securitycache/{securityProviderId}/refresh operations: - name: refreshprovider method: POST description: Triggers a Refresh on a Security Provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true - name: rest-organizations-organizationId-securitycache-securityProviderId-refresh-cance path: /rest/organizations/{organizationId}/securitycache/{securityProviderId}/refresh/cancel operations: - name: cancelproviderrefresh method: POST description: Cancels the Current Refresh Operation on a Security Provider outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: organizationId in: path type: string required: true - name: securityProviderId in: path type: string required: true exposes: - type: rest namespace: security-cache-security-cache-rest port: 8080 description: REST adapter for Coveo Security Cache API — Security Cache. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/organizations/{organizationid}/securitycache/disabled/enable name: rest-organizations-organizationid-securitycache-disabled-enable description: REST surface for rest-organizations-organizationId-securitycache-disabled-enable. operations: - method: POST name: enabledisabledentities description: Enable All Disabled Entities on Security Cache call: security-cache-security-cache.enabledisabledentities with: organizationId: rest.organizationId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/list name: rest-organizations-organizationid-securitycache-entities-list description: REST surface for rest-organizations-organizationId-securitycache-entities-list. operations: - method: POST name: listsecurityidentities description:
Privilege required call: security-cache-security-cache.listsecurityidentities with: organizationId: rest.organizationId page: rest.page perPage: rest.perPage body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/list/is-supported name: rest-organizations-organizationid-securitycache-entities-list-is-supported description: REST surface for rest-organizations-organizationId-securitycache-entities-list-is_supported. operations: - method: GET name: islistsecurityidentitiessupported description:
Privilege required call: security-cache-security-cache.islistsecurityidentitiessupported with: organizationId: rest.organizationId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/{securityproviderid} name: rest-organizations-organizationid-securitycache-entities-securityproviderid description: REST surface for rest-organizations-organizationId-securitycache-entities-securityProviderId. operations: - method: GET name: getentities description: Get the Entities for a Specified Security Provider call: security-cache-security-cache.getentities with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId states: rest.states page: rest.page perPage: rest.perPage from: rest.from to: rest.to usePageModel: rest.usePageModel outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/{securityproviderid}/entity name: rest-organizations-organizationid-securitycache-entities-securityproviderid-enti description: REST surface for rest-organizations-organizationId-securitycache-entities-securityProviderId-enti. operations: - method: POST name: getentity description: Get Entity Information for a Specified Security Provider Member call: security-cache-security-cache.getentity with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/{securityproviderid}/members name: rest-organizations-organizationid-securitycache-entities-securityproviderid-memb description: REST surface for rest-organizations-organizationId-securitycache-entities-securityProviderId-memb. operations: - method: GET name: getmembers description: Get the Members for a Specified Security Provider call: security-cache-security-cache.getmembers with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId states: rest.states page: rest.page perPage: rest.perPage from: rest.from to: rest.to usePageModel: rest.usePageModel outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/{securityproviderid}/members/children name: rest-organizations-organizationid-securitycache-entities-securityproviderid-memb description: REST surface for rest-organizations-organizationId-securitycache-entities-securityProviderId-memb. operations: - method: POST name: getchildentities description: Get Child Entities for a Specified Security Provider Member call: security-cache-security-cache.getchildentities with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId recursive: rest.recursive page: rest.page pageSize: rest.pageSize body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/entities/{securityproviderid}/members/parents name: rest-organizations-organizationid-securitycache-entities-securityproviderid-memb description: REST surface for rest-organizations-organizationId-securitycache-entities-securityProviderId-memb. operations: - method: POST name: getparententities description: Get Parent Entities for a Specified Security Provider Member call: security-cache-security-cache.getparententities with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId recursive: rest.recursive page: rest.page pageSize: rest.pageSize body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/refresh name: rest-organizations-organizationid-securitycache-refresh description: REST surface for rest-organizations-organizationId-securitycache-refresh. operations: - method: POST name: refresh description: Triggers a Refresh on the Security Cache call: security-cache-security-cache.refresh with: organizationId: rest.organizationId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/refresh/entity name: rest-organizations-organizationid-securitycache-refresh-entity description: REST surface for rest-organizations-organizationId-securitycache-refresh-entity. operations: - method: POST name: refreshentity description: Refreshes a Single Entity in the Security Cache call: security-cache-security-cache.refreshentity with: organizationId: rest.organizationId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/schedules name: rest-organizations-organizationid-securitycache-schedules description: REST surface for rest-organizations-organizationId-securitycache-schedules. operations: - method: GET name: getschedules1 description: Get the Security Cache Schedules call: security-cache-security-cache.getschedules1 with: organizationId: rest.organizationId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/schedules/{scheduleid} name: rest-organizations-organizationid-securitycache-schedules-scheduleid description: REST surface for rest-organizations-organizationId-securitycache-schedules-scheduleId. operations: - method: GET name: getschedulebyid description: Get a Security Cache Schedule call: security-cache-security-cache.getschedulebyid with: organizationId: rest.organizationId scheduleId: rest.scheduleId outputParameters: - type: object mapping: $. - method: PUT name: updateschedule1 description: Update a Security Cache Schedule call: security-cache-security-cache.updateschedule1 with: organizationId: rest.organizationId scheduleId: rest.scheduleId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/status name: rest-organizations-organizationid-securitycache-status description: REST surface for rest-organizations-organizationId-securitycache-status. operations: - method: GET name: getstatus description: Get the Security Cache Status call: security-cache-security-cache.getstatus with: organizationId: rest.organizationId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/status/online name: rest-organizations-organizationid-securitycache-status-online description: REST surface for rest-organizations-organizationId-securitycache-status-online. operations: - method: GET name: getonlinesecuritycacheids description: Get Online Security Cache Ids call: security-cache-security-cache.getonlinesecuritycacheids with: organizationId: rest.organizationId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/{securitycacheid}/entities/{securityproviderid} name: rest-organizations-organizationid-securitycache-securitycacheid-entities-securit description: REST surface for rest-organizations-organizationId-securitycache-securityCacheId-entities-securit. operations: - method: GET name: getentitiesforasecuritycache description: Get the Entities for a Specified Security Provider on a Specified Security Cache call: security-cache-security-cache.getentitiesforasecuritycache with: organizationId: rest.organizationId securityCacheId: rest.securityCacheId securityProviderId: rest.securityProviderId states: rest.states page: rest.page perPage: rest.perPage from: rest.from to: rest.to usePageModel: rest.usePageModel minEntityId: rest.minEntityId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/{securityproviderid}/disabled/enable name: rest-organizations-organizationid-securitycache-securityproviderid-disabled-enab description: REST surface for rest-organizations-organizationId-securitycache-securityProviderId-disabled-enab. operations: - method: POST name: enableproviderdisabledentities description: Enable All Disabled Entities for a Specified Security Provider call: security-cache-security-cache.enableproviderdisabledentities with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/{securityproviderid}/refresh name: rest-organizations-organizationid-securitycache-securityproviderid-refresh description: REST surface for rest-organizations-organizationId-securitycache-securityProviderId-refresh. operations: - method: POST name: refreshprovider description: Triggers a Refresh on a Security Provider call: security-cache-security-cache.refreshprovider with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId outputParameters: - type: object mapping: $. - path: /v1/organizations/{organizationid}/securitycache/{securityproviderid}/refresh/cancel name: rest-organizations-organizationid-securitycache-securityproviderid-refresh-cance description: REST surface for rest-organizations-organizationId-securitycache-securityProviderId-refresh-cance. operations: - method: POST name: cancelproviderrefresh description: Cancels the Current Refresh Operation on a Security Provider call: security-cache-security-cache.cancelproviderrefresh with: organizationId: rest.organizationId securityProviderId: rest.securityProviderId outputParameters: - type: object mapping: $. - type: mcp namespace: security-cache-security-cache-mcp port: 9090 transport: http description: MCP adapter for Coveo Security Cache API — Security Cache. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: enable-all-disabled-entities-security description: Enable All Disabled Entities on Security Cache hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.enabledisabledentities with: organizationId: tools.organizationId outputParameters: - type: object mapping: $. - name: details-summary-privilege-required-summary description:
Privilege required hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.listsecurityidentities with: organizationId: tools.organizationId page: tools.page perPage: tools.perPage body: tools.body outputParameters: - type: object mapping: $. - name: details-summary-privilege-required-summary-2 description:
Privilege required hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.islistsecurityidentitiessupported with: organizationId: tools.organizationId outputParameters: - type: object mapping: $. - name: get-entities-specified-security-provider description: Get the Entities for a Specified Security Provider hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getentities with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId states: tools.states page: tools.page perPage: tools.perPage from: tools.from to: tools.to usePageModel: tools.usePageModel outputParameters: - type: object mapping: $. - name: get-entity-information-specified-security description: Get Entity Information for a Specified Security Provider Member hints: readOnly: true destructive: false idempotent: false call: security-cache-security-cache.getentity with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId body: tools.body outputParameters: - type: object mapping: $. - name: get-members-specified-security-provider description: Get the Members for a Specified Security Provider hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getmembers with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId states: tools.states page: tools.page perPage: tools.perPage from: tools.from to: tools.to usePageModel: tools.usePageModel outputParameters: - type: object mapping: $. - name: get-child-entities-specified-security description: Get Child Entities for a Specified Security Provider Member hints: readOnly: true destructive: false idempotent: false call: security-cache-security-cache.getchildentities with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId recursive: tools.recursive page: tools.page pageSize: tools.pageSize body: tools.body outputParameters: - type: object mapping: $. - name: get-parent-entities-specified-security description: Get Parent Entities for a Specified Security Provider Member hints: readOnly: true destructive: false idempotent: false call: security-cache-security-cache.getparententities with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId recursive: tools.recursive page: tools.page pageSize: tools.pageSize body: tools.body outputParameters: - type: object mapping: $. - name: triggers-refresh-security-cache description: Triggers a Refresh on the Security Cache hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.refresh with: organizationId: tools.organizationId outputParameters: - type: object mapping: $. - name: refreshes-single-entity-security-cache description: Refreshes a Single Entity in the Security Cache hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.refreshentity with: organizationId: tools.organizationId body: tools.body outputParameters: - type: object mapping: $. - name: get-security-cache-schedules description: Get the Security Cache Schedules hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getschedules1 with: organizationId: tools.organizationId outputParameters: - type: object mapping: $. - name: get-security-cache-schedule description: Get a Security Cache Schedule hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getschedulebyid with: organizationId: tools.organizationId scheduleId: tools.scheduleId outputParameters: - type: object mapping: $. - name: update-security-cache-schedule description: Update a Security Cache Schedule hints: readOnly: false destructive: false idempotent: true call: security-cache-security-cache.updateschedule1 with: organizationId: tools.organizationId scheduleId: tools.scheduleId body: tools.body outputParameters: - type: object mapping: $. - name: get-security-cache-status description: Get the Security Cache Status hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getstatus with: organizationId: tools.organizationId outputParameters: - type: object mapping: $. - name: get-online-security-cache-ids description: Get Online Security Cache Ids hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getonlinesecuritycacheids with: organizationId: tools.organizationId outputParameters: - type: object mapping: $. - name: get-entities-specified-security-provider-2 description: Get the Entities for a Specified Security Provider on a Specified Security Cache hints: readOnly: true destructive: false idempotent: true call: security-cache-security-cache.getentitiesforasecuritycache with: organizationId: tools.organizationId securityCacheId: tools.securityCacheId securityProviderId: tools.securityProviderId states: tools.states page: tools.page perPage: tools.perPage from: tools.from to: tools.to usePageModel: tools.usePageModel minEntityId: tools.minEntityId outputParameters: - type: object mapping: $. - name: enable-all-disabled-entities-specified description: Enable All Disabled Entities for a Specified Security Provider hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.enableproviderdisabledentities with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId outputParameters: - type: object mapping: $. - name: triggers-refresh-security-provider description: Triggers a Refresh on a Security Provider hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.refreshprovider with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId outputParameters: - type: object mapping: $. - name: cancels-current-refresh-operation-security description: Cancels the Current Refresh Operation on a Security Provider hints: readOnly: false destructive: false idempotent: false call: security-cache-security-cache.cancelproviderrefresh with: organizationId: tools.organizationId securityProviderId: tools.securityProviderId outputParameters: - type: object mapping: $.