# @elastic/search-ui-workplace-search-connector
> ⚠️ DEPRECATED. Please use '@elastic/search-ui-elasticsearch-connector'.
Latest version **1.24.1** (published 2025-05-30) · Apache-2.0 license · 0 weekly downloads
## Install
```sh
npm install @elastic/search-ui-workplace-search-connector
pnpm add @elastic/search-ui-workplace-search-connector
yarn add @elastic/search-ui-workplace-search-connector
bun add @elastic/search-ui-workplace-search-connector
```
## Health
**Score 55/100 (C)** — status: stable.
Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.
Warnings: low downloads.
Negative: stale.
## Facts
| | |
|---|---|
| Version | 1.24.1 |
| Published | 2025-05-30 |
| First published | 2022-04-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 142.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1979 |
| Maintainers | jen-huang, delvedor, lukasolson, ccowan, jbudz, thomasneirynck, verogo, weltenwort, pugnascotia, zinckiwi, brandon.kobel, nreese, mgreau, jonahbull, jarpy, leathekd, lukeelmers, ddillinger, jasonstoltz, bamieh, markov00, joshmock, vignesh.shanmugam, watson, rhodesjason, jmlrt, mattkime, afoucret, nickpeihl, axw, mistic, elasticmachine, gtback, pickypg, trentm, andrewvc-elastic, jorge.sanz, stratoula, nkammah, streamich, nickofthyme, phoey1, breehall, kyrspl, johnwcambra, colleen.mcginnis, legrego, banerjeesoham004, patryk.kopycinski, kibanamachine, tkajtoch, cindy_c, cbishopewc, lenegadewoll, asnyder-elastic, lgestc, weronika-olejniczak, elena-shostak, kc13greiner, yan.savitski, jeramysoucy, miguel-elastic, bradtimmerman, obltmachine, jbwelastic, acstll, bmorelli25 |
## Links
- npm: https://www.npmjs.com/package/@elastic/search-ui-workplace-search-connector
- Repository: https://github.com/elastic/search-ui
- Homepage: https://docs.elastic.co/search-ui
- Issues: https://github.com/elastic/search-ui/issues
- npm.io page: https://npm.io/package/@elastic/search-ui-workplace-search-connector
## Dependencies (2)
- [query-string](https://npm.io/package/query-string.md) ^7.1.1
- [@elastic/search-ui](https://npm.io/package/@elastic/search-ui.md) 1.24.1
## Recent versions
- 1.24.1 (latest) — 2025-05-30
- 1.24.0 — 2025-05-28
- 1.23.1 — 2025-04-30
- 1.23.0 — 2025-04-01
- 1.22.2 — 2025-01-06
- 1.22.1 — 2025-01-06
- 1.22.0 — 2024-11-28
- 1.21.5 — 2024-06-06
- 1.21.4 — 2024-05-10
- 1.21.3 — 2024-05-10
- 1.21.2 — 2024-04-26
- 1.21.1 — 2024-03-15
- 1.21.0 — 2024-03-13
- 1.20.2 — 2023-05-09
- 1.20.1 — 2023-05-09
- … 22 more at https://npm.io/package/@elastic/search-ui-workplace-search-connector/versions
## README
# search-ui-workplace-search-connector
Part of the [Search UI](https://github.com/elastic/search-ui) project.
This Connector is used to connect Search UI to Elastic's [Workplace Search](https://www.elastic.co/workplace-search/) API.
## Deprecation Notice
**Note:** The `WorkplaceSearchConnector` package is deprecated and will no longer be supported. Please migrate to [Elasticsearch Connector](https://www.npmjs.com/package/@elastic/search-ui-elasticsearch-connector) for continued support.
## Usage
```shell
npm install --save @elastic/search-ui-workplace-search-connector
```
```js
import WorkplaceSearchAPIConnector from "@elastic/search-ui-workplace-search-connector";
const connector = new WorkplaceSearchAPIConnector({
kibanaBase: "https://search-ui-sandbox.kb.us-central1.gcp.cloud.es.io:9243",
enterpriseSearchBase:
"https://search-ui-sandbox.ent.us-central1.gcp.cloud.es.io",
redirectUri: "http://localhost:3000",
clientId: "8e495e40fc4e6acf515e557e634de39d4f727f7f60a3afed24a99ce316607c1e"
});
```
See the [usage example](https://github.com/elastic/search-ui/blob/main/examples/sandbox/src/pages/workplace-search/index.js) in our sandbox app. The example uses a private Elastic Cloud deployment. Make sure to update the configuration values to use with your own [Elastic Cloud](https://www.elastic.co/cloud/) deployment.
## Authentication
The Workplace Search API requires authentication. This connector uses OAuth authentication. You can read more about that [here](https://www.elastic.co/guide/en/workplace-search/current/building-custom-search-workplace-search.html) and [here](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-oauth.html).
Using this connector will populate two additional pieces of Application State:
`isLoggedIn` (boolean) - This can be used to determine whether or not a user is authenticated. Requests using this connector will only work if a user is authenticatied. If this is false, consider showing a "Login" link using the `authorizeUrl` state.
`authorizeUrl` (string) - This can be used to create a "Login" link for users to initiate OAuth authentication.
`logout` - (function) - This action can be used to log out user out of the search experience. Under the hood it 1) deletes the saved token from LocalStorage and 2) logs user out of Enterprise Search and Kibana to prevent the ability to get a new access token.
## Classes
- WorkplaceSearchAPIConnector
## Typedefs
- next :
function
- hook :
function
- Options
## WorkplaceSearchAPIConnector
**Kind**: global class
### new WorkplaceSearchAPIConnector(options)
| Param | Type |
| ------- | -------------------------------- |
| options | [Options](#Options) |
## next : function
**Kind**: global typedef
| Param | Type | Description |
| ------------------- | ------------------- | ------------------------------ |
| updatedQueryOptions | Object | The options to send to the API |
## hook : function
**Kind**: global typedef
| Param | Type | Description |
| ------------ | -------------------------- | ------------------------------------------------ |
| queryOptions | Object | The options that are about to be sent to the API |
| next | [next](#next) | The options that are about to be sent to the API |
## Options
**Kind**: global typedef
| Param | Type | Default | Description |
| --------------------------------- | -------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enterpriseSearchBase | string | | The publicly accessible url of the Enterprise Search deployment. |
| kibanaBase | string | | The publicly accessible url for the Kibana deployment associated with the Enterprise Search deployment. Used for OAuth authentication. |
| redirectUri | string | | The publicly accessible url of this Search UI deployment, which Kibana will redirect back to after successful OAuth authentication. Must match a URI as configured in the OAuth Application. |
| clientId | string | | Client ID as generated when setting up the OAuth Application. |
| beforeSearchCall | [hook](#hook) | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a query on an "onSearch" event. |
| beforeAutocompleteResultsCall | [hook](#hook) | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a "results" query on an "onAutocomplete" event. |
| beforeAutocompleteSuggestionsCall | [hook](#hook) | (queryOptions,next)=>next(queryOptions) | (Currently not supported as Workplace Search doesn't have a query suggestions API) A hook to amend query options before the request is sent to the API in a "suggestions" query on an "onAutocomplete" event. |
---
_Source: https://npm.io/package/@elastic/search-ui-workplace-search-connector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._