Skip to content

Commit e7979db

Browse files
session identifiers
1 parent 6c7e03b commit e7979db

File tree

2 files changed

+36
-15
lines changed

2 files changed

+36
-15
lines changed

src/content/partials/api-shield/required-session-identifiers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33

44
---
55

6-
Session identifiers are necessary to configure [Sequence Mitigation](/api-shield/security/sequence-mitigation/) or [rate limiting recommendations](/api-shield/security/volumetric-abuse-detection/), and to see results in [Sequence Analytics](/api-shield/security/sequence-analytics/) and [Authentication Posture](/api-shield/security/authentication-posture/).
6+
You must have specific entitlements to configure session identifiers or cookies as a form of identifiers, such as an Enterprise subscription, for features such as [API Discovery](/api-shield/security/api-discovery/), [Sequence Mitigation](/api-shield/security/sequence-mitigation/) or [rate limiting recommendations](/api-shield/security/volumetric-abuse-detection/), and to see results in [Sequence Analytics](/api-shield/security/sequence-analytics/) and [Authentication Posture](/api-shield/security/authentication-posture/).

src/content/partials/api-shield/set-up-session-identifiers.mdx

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,42 @@
22
{}
33

44
---
5-
import { Steps } from "~/components"
5+
import { Steps, Tabs, TabItem } from "~/components"
66

7-
<Steps>
8-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
9-
2. Go to **Security** > **API Shield**.
10-
3. Select **Settings**.
11-
4. On **Endpoint settings**, select **Manage identifiers**.
12-
5. Choose the type of session identifier (cookie, HTTP header, or JWT claim).
13-
:::note
14-
The session identifier cookie must comply with RFC 6265. Otherwise, it will be rejected.
7+
<Tabs syncKey="dashNewNav">
8+
<TabItem label="Old dashboard">
9+
<Steps>
10+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
11+
2. Go to **Security** > **API Shield**.
12+
3. Select **Settings**.
13+
4. On **Endpoint settings**, select **Manage identifiers**.
14+
5. Choose the type of session identifier (cookie, HTTP header, or JWT claim).
15+
:::note
16+
The session identifier cookie must comply with RFC 6265. Otherwise, it will be rejected.
1517

16-
If you are using a JWT claim, choose the [Token Configuration](/api-shield/security/jwt-validation/api/#token-configurations) that will verify the JWT. Token Configurations are required to use JWT claims as session identifiers. Refer to [JWT Validation](/api-shield/security/jwt-validation/) for more information.
17-
:::
18-
6. Enter the name of the session identifier.
19-
7. Select **Save**.
20-
</Steps>
18+
If you are using a JWT claim, choose the [Token Configuration](/api-shield/security/jwt-validation/api/#token-configurations) that will verify the JWT. Token Configurations are required to use JWT claims as session identifiers. Refer to [JWT Validation](/api-shield/security/jwt-validation/) for more information.
19+
:::
20+
6. Enter the name of the session identifier.
21+
7. Select **Save**.
22+
</Steps>
23+
</TabItem>
24+
<TabItem label="New dashboard" icon="rocket">
25+
<Steps>
26+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
27+
2. Go to **Security** > **Settings**
28+
3. Filter by **API abuse**.
29+
4. On **Session identifiers**, select **Configure session identifiers**.
30+
5. Select **Manage identifiers**.
31+
6. Choose the type of session identifier (cookie, HTTP header, or JWT claim).
32+
:::note
33+
The session identifier cookie must comply with RFC 6265. Otherwise, it will be rejected.
34+
35+
If you are using a JWT claim, choose the [Token Configuration](/api-shield/security/jwt-validation/api/#token-configurations) that will verify the JWT. Token Configurations are required to use JWT claims as session identifiers. Refer to [JWT Validation](/api-shield/security/jwt-validation/) for more information.
36+
:::
37+
7. Enter the name of the session identifier.
38+
8. Select **Save**.
39+
</Steps>
40+
</TabItem>
41+
</Tabs>
2142

2243
After setting up session identifiers and allowing some time for Cloudflare to learn your traffic patterns, you can view your per endpoint and per session rate limiting recommendations, as well as enforce per endpoint and per session rate limits by creating new rules. Session identifiers will allow you to view API Discovery results from session ID-based discovery and session traffic patterns in Sequence Analytics.

0 commit comments

Comments
 (0)