Skip to content

feat: add atg auth docs #783

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
TvisharajiK merged 2 commits into from
Feb 5, 2026
Merged

feat: add atg auth docs #783

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
62df2dd
feat: add atg auth docs
charankamarapu Feb 5, 2026
556a322
chore: grammar change
charankamarapu Feb 5, 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
Binary file added static/img/auth.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/jwt.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/login-curl.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: api-testing-auth-setup
title: Auth Setup
sidebar_label: Auth Setup
description: Auth setup for API Testing
tags:
- API testing
- webhooks
- integration
- custom validation
- policy enforcement
keywords:
- webhook
- API testing
- PreExecute
- PostExecute
- external validation
- custom logic
Comment on lines +8 to +18
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tags in the frontmatter are not relevant to authentication setup. These tags ("webhooks", "custom validation", "policy enforcement") appear to be copied from the webhook documentation. The tags should reflect the authentication-related content of this document, such as "authentication", "auth", "bearer token", "login API", etc.

Suggested change
- webhooks
- integration
- custom validation
- policy enforcement
keywords:
- webhook
- API testing
- PreExecute
- PostExecute
- external validation
- custom logic
- authentication
- auth
- bearer token
- login API
keywords:
- authentication
- auth
- bearer token
- login API
- JWT
- cookie
- access token

Copilot uses AI. Check for mistakes.
Comment on lines +8 to +18
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The keywords in the frontmatter are not relevant to authentication setup. These keywords ("webhook", "PreExecute", "PostExecute", "external validation", "custom logic") appear to be copied from the webhook documentation. The keywords should reflect the authentication-related content of this document, such as "authentication", "bearer token", "JWT", "login", "auth setup", etc.

Suggested change
- webhooks
- integration
- custom validation
- policy enforcement
keywords:
- webhook
- API testing
- PreExecute
- PostExecute
- external validation
- custom logic
- authentication
- auth setup
- JWT
- bearer token
keywords:
- authentication
- auth setup
- login
- JWT
- bearer token
- cookie auth

Copilot uses AI. Check for mistakes.
---

import ProductTier from '@site/src/components/ProductTier';

<ProductTier tiers="Free, Teams, Scale, Enterprise" offerings="Self-Hosted, Dedicated" />
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tier specification uses "Teams" but other documentation files in this repository use "Team" (without the 's'). For consistency, this should be "Team" to match the pattern seen in api-testing-cicd.md and generate-api-tests-using-ai.md which use "Free, Team, Scale, Enterprise".

Copilot uses AI. Check for mistakes.

This guide will help you setup your application Auth in API Test Generation and Run
Copy link

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When "setup" is used as a verb, it should be two words: "set up". The noun form "setup" is correct when used as a noun (e.g., "Auth Setup" in the title), but when describing an action, it should be "set up".

Suggested change
This guide will help you setup your application Auth in API Test Generation and Run
This guide will help you set up your application Auth in API Test Generation and Run

Copilot uses AI. Check for mistakes.

![Keploy](../../../static/img/auth.png)

### 1. Login API

![Keploy](../../../static/img/login-curl.png)

This Auth option is for the application which provides a login API. Keploy will execute this login API when ever the auth token is required and use it in the API calls either in generation or run.

JWT Token - Keploy will execute this API and take the token from the json response value with the key "token" or "access_token" or "jwt"

Cookie - Keploy will execute this API and take the cookie from response headers with key value "Set-Cookie"

### 2. Bearer Token

![Keploy](../../../static/img/jwt.png)

This Auth option is for the application which can be authenticated using jwt token. This token is used in all the API calls that are done by Keploy to the application.
1 change: 1 addition & 0 deletions versioned_sidebars/version-4.0.0-sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@
"running-keploy/run-ai-generated-api-tests",
"running-keploy/api-testing-cicd",
"running-keploy/api-testing-webhook",
"running-keploy/api-testing-auth-setup",
{
"type": "doc",
"label": "FAQs",
Expand Down
Loading