Skip to content

feat: document search result set limits #2408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alnr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: document search result set limits #2408

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/kratos/manage-identities/search/identity-search-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ import Help from '@site/docs/_common/need-help.mdx'

## Getting started

We recommend using the [Typesense SDKs](https://typesense.org/docs/29.0/api/api-clients.html) for your preferred language to
interact with the advanced identity search API. Pass your [Ory Network API key](/concepts/personal-access-token) where you would
normally pass the Typesense API key, use the following base URL:
Ory exposes an advanced Identity Search API that is compatible with the Typesense search protocol. You can use existing Typesense
SDKs to interact with it. Pass your [Ory Network API key](/concepts/personal-access-token) where you would normally pass the
Typesense API key, and use the following base URL:

```shell
https://{your-ory-slug}.projects.oryapis.com/admin/preview/search/v0beta1
Expand Down Expand Up @@ -105,6 +105,13 @@ possible.

:::

## Search result set limit

The identity search API does not support pagination (unlike the List Identities API) and will return a maximum of 1,000 results
per request. If you are frequently hitting this limit, consider refining your search queries to reduce the number of results
returned. To paginate through _all_ your identities, use the
[List Identities API](/reference/api#tag/identity/operation/listIdentities).

## Consistency and availability

The search index powering advanced identity search is eventually consistent with the main identity store. This means that there
Expand Down
Loading