Skip to content

Commit

Permalink
Merge pull request #848 from supertokens/bot-spam-detection-rename
Browse files Browse the repository at this point in the history
Rename bot and spam detection to attack protection suite
  • Loading branch information
rishabhpoddar authored Sep 18, 2024
2 parents 3a668ff + f5df768 commit c91357a
Show file tree
Hide file tree
Showing 21 changed files with 51 additions and 51 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ A more complete example of how to retrieve the request ID from the input body ca
The `requestId` should be required when the trying to reset password, sign in or sign up. If the `requestId` is not present, an error should be returned. You can see more in the [examples section](#examples).
:::

## Making the Request to the Bot / Spam Detection endpoint
## Making the Request to the Attack Protection Suite endpoint

The request body is a JSON object that contains the following properties (all fields are optional):

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ import CustomAdmonition from "/src/components/customAdmonition"

# Introduction

SuperTokens Bot / Spam detection is a powerful security feature designed to identify and prevent suspicious activities in authentication and user sessions. It leverages various detection methods to enhance the security of your application.
SuperTokens Attack Protection Suite is a powerful security feature designed to identify and prevent suspicious activities in authentication and user sessions. It leverages various detection methods to enhance the security of your application.

:::important
This feature is **currently in beta** and not enabled by default. You can find out how to enable this feature [here](/docs/botandspamdetection/enabling).
This feature is **currently in beta** and not enabled by default. You can find out how to enable this feature [here](/docs/attackprotectionsuite/enabling).
:::

## Features
Expand Down Expand Up @@ -43,17 +43,17 @@ Recognize and remember devices and requester details, even when they try to disg

## Flow diagram

The Bot / Spam detection service is typically integrated into your authentication flow. It processes requests and provides risk assessments that you can use to enforce additional security measures, such as requiring two-factor authentication for suspicious logins or blocking high-risk attempts altogether.
The Attack Protection Suite service is typically integrated into your authentication flow. It processes requests and provides risk assessments that you can use to enforce additional security measures, such as requiring two-factor authentication for suspicious logins or blocking high-risk attempts altogether.

By leveraging these advanced detection methods, SuperTokens Bot / Spam detection significantly enhances your application's security posture and helps protect your users from various types of account compromise attempts.
By leveraging these advanced detection methods, SuperTokens Attack Protection Suite significantly enhances your application's security posture and helps protect your users from various types of account compromise attempts.

Below is an high level overview of how this works:

<img src="/img/botandspamdetection/sequence-diagram.png" alt="Bot / Spam detection flow"/>
<img src="/img/attackprotectionsuite/sequence-diagram.png" alt="Attack Protection Suite flow"/>

## Recipes integration

Different recipes have different ways of integrating with the Bot / Spam detection feature.
Different recipes have different ways of integrating with the Attack Protection Suite feature.

### Passwordless

Expand Down
File renamed without changes.
8 changes: 4 additions & 4 deletions v2/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -259,10 +259,10 @@ module.exports = {
[
"@docusaurus/plugin-content-docs",
{
id: "botandspamdetection",
path: "botandspamdetection",
routeBasePath: "docs/botandspamdetection",
sidebarPath: require.resolve("./botandspamdetection/sidebars.js"),
id: "attackprotectionsuite",
path: "attackprotectionsuite",
routeBasePath: "docs/attackprotectionsuite",
sidebarPath: require.resolve("./attackprotectionsuite/sidebars.js"),
showLastUpdateTime: true,
editUrl: "https://github.com/supertokens/docs/tree/master/v2/",
remarkPlugins: remarkPlugins,
Expand Down
8 changes: 4 additions & 4 deletions v2/emailpassword/anomaly-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: bot-and-spam-detection
title: Bot / Spam Detection
id: attack-protection-suite
title: Attack Protection Suite
hide_title: true
---

# Bot / Spam Detection
# Attack Protection Suite

See our guide for anomaly detection [here](/docs/botandspamdetection/introduction).
See our guide for anomaly detection [here](/docs/attackprotectionsuite/introduction).
6 changes: 3 additions & 3 deletions v2/emailpassword/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ module.exports = {
},
"mfa",
"multi-tenant",
"bot-and-spam-detection",
"attack-protection-suite",
],
},
"scalability",
Expand All @@ -705,8 +705,8 @@ module.exports = {
],
},
{
type: 'category',
label: 'Migrating to Supertokens',
type: "category",
label: "Migrating to Supertokens",
items: [
"migration/about",
{
Expand Down
8 changes: 4 additions & 4 deletions v2/passwordless/anomaly-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: bot-and-spam-detection
title: Bot / Spam Detection
id: attack-protection-suite
title: Attack Protection Suite
hide_title: true
---

# Bot / Spam Detection
# Attack Protection Suite

See our guide for anomaly detection [here](/docs/botandspamdetection/introduction).
See our guide for anomaly detection [here](/docs/attackprotectionsuite/introduction).
6 changes: 3 additions & 3 deletions v2/passwordless/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -668,7 +668,7 @@ module.exports = {
},
"mfa",
"multi-tenant",
"bot-and-spam-detection",
"attack-protection-suite",
],
},
"scalability",
Expand All @@ -683,8 +683,8 @@ module.exports = {
],
},
{
type: 'category',
label: 'Migrating to Supertokens',
type: "category",
label: "Migrating to Supertokens",
items: [
"migration/about",
{
Expand Down
6 changes: 3 additions & 3 deletions v2/src/components/recipeBoxes/guides.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@
"path": "/docs/multitenancy/introduction"
},
{
"title": "Bot / Spam Detection",
"icon": "botandspamdetection",
"path": "/docs/botandspamdetection/introduction"
"title": "Attack Protection Suite",
"icon": "attackprotectionsuite",
"path": "/docs/attackprotectionsuite/introduction"
}
],
"ref": [
Expand Down
4 changes: 2 additions & 2 deletions v2/src/theme/NavbarItem/recipeSelector.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ export default function RecipeSelector(props) {
active: activeSelector("anomaly_detection"),
})}
>
<a href="/docs/botandspamdetection/introduction">
Bot / Spam Detection
<a href="/docs/attackprotectionsuite/introduction">
Attack Protection Suite
</a>
</li>
</ul>
Expand Down
8 changes: 4 additions & 4 deletions v2/thirdparty/anomaly-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: bot-and-spam-detection
title: Bot / Spam Detection
id: attack-protection-suite
title: Attack Protection Suite
hide_title: true
---

# Bot / Spam Detection
# Attack Protection Suite

See our guide for anomaly detection [here](/docs/botandspamdetection/introduction).
See our guide for anomaly detection [here](/docs/attackprotectionsuite/introduction).
6 changes: 3 additions & 3 deletions v2/thirdparty/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@ module.exports = {
},
"mfa",
"multi-tenant",
"bot-and-spam-detection",
"attack-protection-suite",
],
},
"scalability",
Expand All @@ -695,8 +695,8 @@ module.exports = {
],
},
{
type: 'category',
label: 'Migrating to Supertokens',
type: "category",
label: "Migrating to Supertokens",
items: [
"migration/about",
{
Expand Down
8 changes: 4 additions & 4 deletions v2/thirdpartyemailpassword/anomaly-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: bot-and-spam-detection
title: Bot / Spam Detection
id: attack-protection-suite
title: Attack Protection Suite
hide_title: true
---

# Bot / Spam Detection
# Attack Protection Suite

See our guide for anomaly detection [here](/docs/botandspamdetection/introduction).
See our guide for anomaly detection [here](/docs/attackprotectionsuite/introduction).
6 changes: 3 additions & 3 deletions v2/thirdpartyemailpassword/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,7 @@ module.exports = {
},
"mfa",
"multi-tenant",
"bot-and-spam-detection",
"attack-protection-suite",
],
},
"scalability",
Expand All @@ -744,8 +744,8 @@ module.exports = {
],
},
{
type: 'category',
label: 'Migrating to Supertokens',
type: "category",
label: "Migrating to Supertokens",
items: [
"migration/about",
{
Expand Down
8 changes: 4 additions & 4 deletions v2/thirdpartypasswordless/anomaly-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: bot-and-spam-detection
title: Bot / Spam Detection
id: attack-protection-suite
title: Attack Protection Suite
hide_title: true
---

# Bot / Spam Detection
# Attack Protection Suite

See our guide for anomaly detection [here](/docs/botandspamdetection/introduction).
See our guide for anomaly detection [here](/docs/attackprotectionsuite/introduction).
6 changes: 3 additions & 3 deletions v2/thirdpartypasswordless/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ module.exports = {
},
"mfa",
"multi-tenant",
"bot-and-spam-detection",
"attack-protection-suite",
],
},
"scalability",
Expand All @@ -736,8 +736,8 @@ module.exports = {
],
},
{
type: 'category',
label: 'Migrating to Supertokens',
type: "category",
label: "Migrating to Supertokens",
items: [
"migration/about",
{
Expand Down

0 comments on commit c91357a

Please sign in to comment.