From 0da83ac49b004a2fa95c340f32cb962059d10c61 Mon Sep 17 00:00:00 2001 From: Francis Labelle Date: Mon, 30 Mar 2026 14:45:56 -0400 Subject: [PATCH 1/2] document `include` param in firework & astp credential search --- docs/api-reference/spec/firework-v4-openapi.json | 10 +++++++++- docs/changelog/overview.mdx | 6 ++++++ .../credentials/astp-and-global-search-common.mdx | 4 ++++ 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/api-reference/spec/firework-v4-openapi.json b/docs/api-reference/spec/firework-v4-openapi.json index 2848572..e2ef309 100644 --- a/docs/api-reference/spec/firework-v4-openapi.json +++ b/docs/api-reference/spec/firework-v4-openapi.json @@ -15299,6 +15299,13 @@ } ], "title": "Event Uid" + }, + "auth_domains": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Auth Domains" } }, "type": "object", @@ -21029,7 +21036,8 @@ "IncludeOptions": { "type": "string", "enum": [ - "known_password_id" + "known_password_id", + "auth_domains" ], "title": "IncludeOptions" }, diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 3021773..e76c0ba 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -12,6 +12,12 @@ This page lists changes to Flare's API. Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases). + + Added new value for the `include` parameter in the [Global Search Credentials Endpoint ](/api-reference/v4/endpoints/credentials-global-search). + + Added documentation for the `include` paramter in the [ASTP Search Credentials Endpoint ](/api-reference/astp/endpoints/post-credentials-search). + + Replaced the `leak` event type for individual `leaked_credential` events. See [Leaked Credentials ](/event-types/leaked-credential) diff --git a/docs/snippets/credentials/astp-and-global-search-common.mdx b/docs/snippets/credentials/astp-and-global-search-common.mdx index 7c36326..20729ec 100644 --- a/docs/snippets/credentials/astp-and-global-search-common.mdx +++ b/docs/snippets/credentials/astp-and-global-search-common.mdx @@ -63,6 +63,10 @@ This endpoint supports the The `next` value from the last response. + + Additional fields to return. Available options: `known_password_id`, `auth_domains` + + The order in which the results will be returned. (`asc` or `desc`) From e9ac89a70bb7ec89707029133a405a6b6ff8c750 Mon Sep 17 00:00:00 2001 From: Francis Labelle Date: Mon, 30 Mar 2026 15:42:00 -0400 Subject: [PATCH 2/2] Fix typo in docs/changelog/overview.mdx Co-authored-by: Xavier Lavallee --- docs/changelog/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index e76c0ba..e7b44e0 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -15,7 +15,7 @@ Release notes for the Flare Platform can be found on the [product documentation Added new value for the `include` parameter in the [Global Search Credentials Endpoint ](/api-reference/v4/endpoints/credentials-global-search). - Added documentation for the `include` paramter in the [ASTP Search Credentials Endpoint ](/api-reference/astp/endpoints/post-credentials-search). + Added documentation for the `include` parameter in the [ASTP Search Credentials Endpoint ](/api-reference/astp/endpoints/post-credentials-search).