Skip to content

document include param in firework & astp credential search #207

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
xvaier merged 2 commits into from
Mar 31, 2026
+19 −1
Merged

document include param in firework & astp credential search #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0da83ac
document `include` param in firework & astp credential search
Mar 30, 2026
e9ac89a
Fix typo in docs/changelog/overview.mdx
xshill Mar 30, 2026
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
10 changes: 9 additions & 1 deletion docs/api-reference/spec/firework-v4-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15299,6 +15299,13 @@
}
],
"title": "Event Uid"
},
"auth_domains": {
"items": {
"type": "string"
},
"type": "array",
"title": "Auth Domains"
}
},
"type": "object",
Expand Down Expand Up @@ -21029,7 +21036,8 @@
"IncludeOptions": {
"type": "string",
"enum": [
"known_password_id"
"known_password_id",
"auth_domains"
],
"title": "IncludeOptions"
},
Expand Down
6 changes: 6 additions & 0 deletions docs/changelog/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
</Note>

<Update label="2026-03" description="API - March 2026">
Added new value for the `include` parameter in the [Global Search Credentials Endpoint <Icon icon="code" size={16} />](/api-reference/v4/endpoints/credentials-global-search).

Added documentation for the `include` parameter in the [ASTP Search Credentials Endpoint <Icon icon="code" size={16} />](/api-reference/astp/endpoints/post-credentials-search).
</Update>

<Update label="2026-03" description="API - March 2026">
Replaced the `leak` event type for individual `leaked_credential` events. See [Leaked Credentials <Icon icon="book" size={16} />](/event-types/leaked-credential)
</Update>
Expand Down
4 changes: 4 additions & 0 deletions docs/snippets/credentials/astp-and-global-search-common.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ This endpoint supports the
The `next` value from the last response.
</ParamField>

<ParamField body="include" type="string[]">
Additional fields to return. Available options: `known_password_id`, `auth_domains`
</ParamField>

<ParamField body="order" type="string" default="desc">
The order in which the results will be returned. (`asc` or `desc`)
</ParamField>
Expand Down