Skip to content

Commit 7aed6ff

Browse files
authored
Merge branch 'main' into fix/quickstart-settings
2 parents 331c889 + d7a5b40 commit 7aed6ff

5 files changed

Lines changed: 44 additions & 0 deletions

File tree

static/img/auth.png

299 KB
Loading

static/img/jwt.png

184 KB
Loading

static/img/login-curl.png

147 KB
Loading
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
id: api-testing-auth-setup
3+
title: Auth Setup
4+
sidebar_label: Auth Setup
5+
description: Auth setup for API Testing
6+
tags:
7+
- API testing
8+
- webhooks
9+
- integration
10+
- custom validation
11+
- policy enforcement
12+
keywords:
13+
- webhook
14+
- API testing
15+
- PreExecute
16+
- PostExecute
17+
- external validation
18+
- custom logic
19+
---
20+
21+
import ProductTier from '@site/src/components/ProductTier';
22+
23+
<ProductTier tiers="Free, Teams, Scale, Enterprise" offerings="Self-Hosted, Dedicated" />
24+
25+
This guide will help you setup your application Auth in API Test Generation and Run
26+
27+
![Keploy](../../../static/img/auth.png)
28+
29+
### 1. Login API
30+
31+
![Keploy](../../../static/img/login-curl.png)
32+
33+
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.
34+
35+
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"
36+
37+
Cookie - Keploy will execute this API and take the cookie from response headers with key value "Set-Cookie"
38+
39+
### 2. Bearer Token
40+
41+
![Keploy](../../../static/img/jwt.png)
42+
43+
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.

versioned_sidebars/version-4.0.0-sidebars.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@
170170
"running-keploy/run-ai-generated-api-tests",
171171
"running-keploy/api-testing-cicd",
172172
"running-keploy/api-testing-webhook",
173+
"running-keploy/api-testing-auth-setup",
173174
{
174175
"type": "doc",
175176
"label": "FAQs",

0 commit comments

Comments
 (0)