Skip to content

Commit 0da83ac

Browse files
author
Francis Labelle
committed
document include param in firework & astp credential search
1 parent 97378d6 commit 0da83ac

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

docs/api-reference/spec/firework-v4-openapi.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15299,6 +15299,13 @@
1529915299
}
1530015300
],
1530115301
"title": "Event Uid"
15302+
},
15303+
"auth_domains": {
15304+
"items": {
15305+
"type": "string"
15306+
},
15307+
"type": "array",
15308+
"title": "Auth Domains"
1530215309
}
1530315310
},
1530415311
"type": "object",
@@ -21029,7 +21036,8 @@
2102921036
"IncludeOptions": {
2103021037
"type": "string",
2103121038
"enum": [
21032-
"known_password_id"
21039+
"known_password_id",
21040+
"auth_domains"
2103321041
],
2103421042
"title": "IncludeOptions"
2103521043
},

docs/changelog/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ This page lists changes to Flare's API.
1212
Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases).
1313
</Note>
1414

15+
<Update label="2026-03" description="API - March 2026">
16+
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).
17+
18+
Added documentation for the `include` paramter in the [ASTP Search Credentials Endpoint <Icon icon="code" size={16} />](/api-reference/astp/endpoints/post-credentials-search).
19+
</Update>
20+
1521
<Update label="2026-03" description="API - March 2026">
1622
Replaced the `leak` event type for individual `leaked_credential` events. See [Leaked Credentials <Icon icon="book" size={16} />](/event-types/leaked-credential)
1723
</Update>

docs/snippets/credentials/astp-and-global-search-common.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ This endpoint supports the
6363
The `next` value from the last response.
6464
</ParamField>
6565

66+
<ParamField body="include" type="string[]">
67+
Additional fields to return. Available options: `known_password_id`, `auth_domains`
68+
</ParamField>
69+
6670
<ParamField body="order" type="string" default="desc">
6771
The order in which the results will be returned. (`asc` or `desc`)
6872
</ParamField>

0 commit comments

Comments
 (0)