Skip to content

feat: search: update screenshot, description, and correct result set size #2431

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

Merged
alnr merged 1 commit into from
Feb 3, 2026
Merged

feat: search: update screenshot, description, and correct result set size #2431

Show file tree
Hide file tree
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
128 changes: 82 additions & 46 deletions code-examples/curl/search/advanced-result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,105 +1,141 @@
{
"facet_counts": [
{
"counts": [],
"counts": [
{
"count": 534,
"highlighted": "6e0b1f71-4236-44a3-a730-a033fcd21eab",
"value": "6e0b1f71-4236-44a3-a730-a033fcd21eab"
},
{
"count": 489,
"highlighted": "6bd7de58-a3d4-412c-a3fd-0c04a14b03f7",
"value": "6bd7de58-a3d4-412c-a3fd-0c04a14b03f7"
}
],
"field_name": "organization_id",
"sampled": false,
"stats": {
"total_values": 0
"avg": 0,
"sum": 0,
"total_values": 2
}
}
],
"found": 5,
"found": 2163,
"hits": [
{
"document": {
"available_aal": "aal1",
"created_at": 1725296067,
"id": "9e9763c9-80fc-43d0-97fb-d241cb274c2c",
"schema_id": "preset://email",
"available_aal": "aal0",
"created_at": 1769995344,
"id": "8a2a14af-7a89-4424-aebd-1db3e3b8a229",
"nid": "e70f3b9e-f343-40e6-89f1-de24e459722e",
"organization_id": "6bd7de58-a3d4-412c-a3fd-0c04a14b03f7",
"schema_id": "preset://basic",
"state": "active",
"traits": {
"email": "wrhgr@srgpzjdrgpz"
"email": "louise_henderson760@aol.com",
"name": {
"first": "Louise",
"last": "Henderson"
}
},
"updated_at": 1725296067
"updated_at": 1770125357
},
"highlight": {},
"highlights": []
},
{
"document": {
"available_aal": "aal1",
"created_at": 1725295678,
"id": "38403863-16c2-4a0c-b53e-428f7d80a65b",
"schema_id": "preset://email",
"available_aal": "aal0",
"created_at": 1769900788,
"id": "dc6b133f-363a-42e2-83b1-78a4a81e0a07",
"nid": "e70f3b9e-f343-40e6-89f1-de24e459722e",
"organization_id": "6bd7de58-a3d4-412c-a3fd-0c04a14b03f7",
"schema_id": "preset://basic",
"state": "active",
"traits": {
"email": "SRGSRpgj@SPRGojsgs.com"
"email": "patricia.lefebvre570@mailbox.org",
"name": {
"first": "Patricia",
"last": "Lefebvre"
}
},
"updated_at": 1725295678
"updated_at": 1770125352
},
"highlight": {},
"highlights": []
},
{
"document": {
"available_aal": "aal1",
"created_at": 1725031786,
"id": "f5e85c2f-6f0f-49d7-9b77-1bfbb530add4",
"schema_id": "preset://email",
"available_aal": "aal0",
"created_at": 1769785191,
"id": "f748b84f-8ad0-4f72-8a3c-5e38bd0fe96d",
"nid": "e70f3b9e-f343-40e6-89f1-de24e459722e",
"organization_id": "6e0b1f71-4236-44a3-a730-a033fcd21eab",
"schema_id": "preset://basic",
"state": "active",
"traits": {
"email": "wGWRIGOH@WOsPgjzsroig"
"email": "steven.r740@posteo.de",
"name": {
"first": "Steven",
"last": "Roussel"
}
},
"updated_at": 1725031786
"updated_at": 1770125356
},
"highlight": {},
"highlights": []
},
{
"document": {
"available_aal": "aal1",
"created_at": 1725031437,
"external_id": "external-id-123",
"id": "d52d5bdb-74b4-4aa0-b706-d1e9c853bd81",
"metadata_admin": {
"role": "user"
},
"metadata_public": {
"foo": "bar"
},
"schema_id": "preset://email",
"available_aal": "aal0",
"created_at": 1769316538,
"id": "1c00a491-c5cf-47d5-a306-2214248f81d5",
"nid": "e70f3b9e-f343-40e6-89f1-de24e459722e",
"organization_id": "6bd7de58-a3d4-412c-a3fd-0c04a14b03f7",
"schema_id": "preset://basic",
"state": "active",
"traits": {
"email": "wgiho@agpaa.com"
"email": "thomasmitchell631@wanadoo.fr",
"name": {
"first": "Thomas",
"last": "Mitchell"
}
},
"updated_at": 1758115258
"updated_at": 1770125354
},
"highlight": {},
"highlights": []
},
{
"document": {
"available_aal": "aal1",
"created_at": 1725031040,
"id": "f56128f1-687e-414e-8f5d-ec5f909b33c0",
"schema_id": "preset://email",
"state": "active",
"available_aal": "aal0",
"created_at": 1769293967,
"id": "07421d7e-0e84-4e05-bd1e-9c446dc94a6d",
"nid": "e70f3b9e-f343-40e6-89f1-de24e459722e",
"organization_id": "6bd7de58-a3d4-412c-a3fd-0c04a14b03f7",
"schema_id": "preset://basic",
"state": "inactive",
"traits": {
"email": "sogihSOG@SdoSORghzdrg"
"email": "vhughes947@zoho.com",
"name": {
"first": "Valerie",
"last": "Hughes"
}
},
"updated_at": 1725031040
"updated_at": 1770125361
},
"highlight": {},
"highlights": []
}
],
"out_of": 2163,
"page": 1,
"request_params": {
"collection_name": "identities",
"first_q": "*",
"per_page": 20,
"collection_name": "identities-e70f3b9e-f343-40e6-89f1-de24e459722e",
"per_page": 5,
"q": "*"
},
"search_cutoff": false
"search_cutoff": false,
"search_time_ms": 2
}
2 changes: 1 addition & 1 deletion code-examples/curl/search/advanced.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ curl -H "Authorization: Bearer $ORY_API_KEY" \
--url-query 'filter_by=available_aal:!=aal2' \
--url-query 'facet_by=organization_id' \
--url-query 'sort_by=created_at:desc' \
--url-query 'per_page=20'
--url-query 'per_page=5'
Binary file modified docs/kratos/manage-identities/search/console.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 3 additions & 4 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 @@ -107,10 +107,9 @@ 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).
The identity search API does not support pagination (unlike the List Identities API) and will return a maximum of 250 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

Expand Down
7 changes: 6 additions & 1 deletion docs/kratos/manage-identities/search/identity-search-console.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ sidebar_label: Ory Console

Search for identities by navigating to <ConsoleLink route="project.identities.list" />.

Use the search bar to find identities by email, username, or any other attribute.
Use the search bar to find identities by email, username, first/last name, or any other custom traits you have defined. Admin and
public metadata is also searchable. Use the State (`Active`/`Inactive`), Identity Schema, and Organization filters to narrow down
your search results.

Identity search supports a maximum result set size of 250 identities. If your search query matches more than 250 identities, only
the first 250 results will be shown, along with a message about how many identities match your search query in total.

![Search](console.png)
Loading