Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 10 additions & 0 deletions docs/api-reference/astp/endpoints/post-credentials-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ authMethod: "bearer"

import GatedAccessFeatureAstp from '/snippets/gated-access-feature-astp.mdx';
import CrendentialSearchCommon from '/snippets/credentials/astp-and-global-search-common.mdx';
import CrendentialSearchQueryAndFilters from '/snippets/credentials/astp-and-global-search-query-and-filters.mdx';
import CrendentialSearchDescription from '/snippets/credentials/astp-and-global-search-description.mdx';
import CrendentialEndpointsNote from '/snippets/credentials/astp-and-global-search-note.mdx';

Expand All @@ -19,3 +20,12 @@ See the guide for using this endpoint:
[Exporting a Domain's Credentials <Icon icon="book" size={16} />](/guides/credentials-export-domain).

<CrendentialSearchCommon />

<ParamField body="include" type="string[]">
Additional fields to return. Available options:
- `known_password_id`: ID of the credential's password.
- `auth_domains`: for each credential, up to 100 hosts (domain only, e.g. `login.example.com`) where the credential was seen being used.
- `urls`: for each credential, up to 100 full URLs (including scheme and path, e.g. `https://login.example.com/signin`) where the credential was seen being used. These are the complete addresses that `auth_domains` reports the host portion of.
</ParamField>

<CrendentialSearchQueryAndFilters />
11 changes: 10 additions & 1 deletion docs/api-reference/v4/endpoints/credentials-global-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,19 @@ title: Search Credentials

import CrendentialEndpointsNote from '/snippets/credentials/astp-and-global-search-note.mdx';
import CrendentialSearchCommon from '/snippets/credentials/astp-and-global-search-common.mdx';
import CrendentialSearchQueryAndFilters from '/snippets/credentials/astp-and-global-search-query-and-filters.mdx';
import GlobalSearchApiQuotaNote from '/snippets/global-search-api-quota-note.mdx';
import CrendentialSearchDescription from '/snippets/credentials/astp-and-global-search-description.mdx';

<GlobalSearchApiQuotaNote />
<CrendentialEndpointsNote />
<CrendentialSearchDescription />
<CrendentialSearchCommon />
<CrendentialSearchCommon />

<ParamField body="include" type="string[]">
Additional fields to return. Available options:
- `known_password_id`: ID of the credential's password.
- `auth_domains`: for each credential, up to 100 hosts (domain only, e.g. `login.example.com`) where the credential was seen being used.
</ParamField>

<CrendentialSearchQueryAndFilters />
4 changes: 4 additions & 0 deletions docs/changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ 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-07" description="API - July 2026">
Added the `urls` value to 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-05" description="API - May 2026">
The `imported_at` filter now works for all query types in the [Global Search Credentials Endpoint <Icon icon="code" size={16} />](/api-reference/v4/endpoints/credentials-global-search)
and the [ASTP Search Credentials Endpoint <Icon icon="code" size={16} />](/api-reference/astp/endpoints/post-credentials-search).
Expand Down
91 changes: 0 additions & 91 deletions docs/snippets/credentials/astp-and-global-search-common.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,97 +65,6 @@ 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`: ID of the credential's password.
- `auth_domains`: for each credential, return up to 10 domains where this credential was used.
</ParamField>

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

<ParamField body="query" type="object">
One of the supported queries.
<Tabs>

<Tab title="Domain Query">
This query will match all credentials that contain the specified domain in the email address.
```json
{
"type": "domain",
"fqdn": "<string>"
}
```
</Tab>

<Tab title="Auth Domain Query" >
This query will match the domain of the service that this credential might have been used to log in to.
```json
{
"type": "auth_domain",
"fqdn": "<string>"
}
```
</Tab>

<Tab title="Password Query">
This query will match all credentials that contain the specified password.
```json
{
"type": "secret",
"secret": "<string>"
}
```
</Tab>

<Tab title="Email Query">
This query will match all credentials for the exact email address.
```json
{
"type": "email",
"email": "<string>"
}
```
</Tab>

<Tab title="Keyword Query" >
This query will match with the credential's username, which is the portion of the `identity_name` that preceeds `@`.
```json
{
"type": "keyword",
"keyword": "<string>"
}
```
</Tab>

</Tabs>
</ParamField>

<ParamField body="filters" type="object">
<Expandable defaultOpen>
<ParamField body="imported_at" type="object">
<Expandable>
<ParamField
body="gte"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values greater than or equal to the specified timestamp.

Format: ISO-8601
</ParamField>

<ParamField
body="lte"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values lesser than or equal to the specified timestamp.

Format: ISO-8601
</ParamField>
</Expandable>
</ParamField>
</Expandable>
</ParamField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<ParamField body="query" type="object">
One of the supported queries.
<Tabs>

<Tab title="Domain Query">
This query will match all credentials that contain the specified domain in the email address.
```json
{
"type": "domain",
"fqdn": "<string>"
}
```
</Tab>

<Tab title="Auth Domain Query" >
This query will match the domain of the service that this credential might have been used to log in to.
```json
{
"type": "auth_domain",
"fqdn": "<string>"
}
```
</Tab>

<Tab title="Password Query">
This query will match all credentials that contain the specified password.
```json
{
"type": "secret",
"secret": "<string>"
}
```
</Tab>

<Tab title="Email Query">
This query will match all credentials for the exact email address.
```json
{
"type": "email",
"email": "<string>"
}
```
</Tab>

<Tab title="Keyword Query" >
This query will match with the credential's username, which is the portion of the `identity_name` that preceeds `@`.
```json
{
"type": "keyword",
"keyword": "<string>"
}
```
</Tab>

</Tabs>
</ParamField>

<ParamField body="filters" type="object">
<Expandable defaultOpen>
<ParamField body="imported_at" type="object">
<Expandable>
<ParamField
body="gte"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values greater than or equal to the specified timestamp.

Format: ISO-8601
</ParamField>

<ParamField
body="lte"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values lesser than or equal to the specified timestamp.

Format: ISO-8601
</ParamField>
</Expandable>
</ParamField>
</Expandable>
</ParamField>
Loading