Basic Auth

vibssingh

How to pass basic authentication token in Python Requests

HOME

An authentication token is a piece of data, often a string, that is used to represent the authenticated user. Instead of sending the username and password with each request, a token is sent, usually in the request headers.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

The syntax for basic authentication in Python Request is

 headers = {'Authorization': 'Basic dXNlcjpwYXNz'}

In this scenario, all you need to do is to embed the basic auth token as Authorization header while making the API call. A sample basic auth token would look like this auth param and the get() method in requests will take care of the basic authorization for us.

Below is the example of basic authentication token.

import requests

endpoint = 'https://httpbin.org/basic-auth/user/pass'
token = 'Basic dXNlcjpwYXNz'


def test_auth_token():

    headers = {'Authorization': token}

    response = requests.get(endpoint, headers=headers)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["authenticated"] == True
    assert response_body["user"] == "user"

Save above file as Authentication_test.py and run using the below command:

pytest Authentication_test.py -s

Note: -s is shortcut for –capture=no

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!

vibssingh

How to pass basic authentication credentials in Python Requests

Last Updated On

HOME

Basic Authentication is a simple authentication scheme that is often used in HTTP (Hypertext Transfer Protocol) to provide a way for a client to send a username and password to a server for verification. It is a part of the HTTP protocol and involves sending the credentials (username and password) in the request headers.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or another Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

The syntax for basic authentication in Python Request is

response = requests.get(endpoint, auth=(username, password))

We can directly embed a basic auth username and password in the request by passing the username and password as a tuple to the auth param and the get() method in requests will take care of the basic authorization for us.

Below is an example of basic authentication in Postman.

Below is an example of basic authentication.

import requests

endpoint = 'https://httpbin.org/basic-auth/user/pass'
credentials = ('user', 'pass')


def test_basic_auth():

    response = requests.get(endpoint, auth=credentials)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["authenticated"] == True
    assert response_body["user"] == "user"

Save above file as BasicAuth_test.py and run using the below command:

pytest BasicAuth_test.py -s

Note: -s is shortcut for –capture=no

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!

vibssingh

How to send basic authentication credentials in Rest Assured

Last Updated On

HOME

When you are doing API testing, sometimes the APIs or endpoints are protected. This means you need to be authenticated and authorized to perform certain actions. REST assured supports several authentication schemes, for example OAuth, digest, certificate, form and preemptive basic authentication.

In this post, we’ll look at how to send the authentication credentials (username, password) in REST Assured.

Add the below-mentioned dependencies to the Maven project.

 <dependencies>

       <!-- Rest Assured Dependency -->
      <dependency>
         <groupId>io.rest-assured</groupId>
        <artifactId>rest-assured</artifactId>
        <version>5.3.2</version>
        <scope>test</scope>
      </dependency>

        <!-- TestNG Dependency-->
      <dependency>
          <groupId>org.testng</groupId>
         <artifactId>testng</artifactId>
         <version>7.8.0</version>
         <scope>test</scope>
       </dependency>

</dependencies>

Sending Basic Auth Header in REST Assured

import io.restassured.http.ContentType;
import io.restassured.response.Response;
import org.testng.Assert;
import org.testng.annotations.Test;
import static io.restassured.RestAssured.given;

public class BasicAuth_Demo {

   private String validRequest = "{" +
           "\"username\": \"Samu01\"," +
           "\"email\": \"samuel@email.com\"," +
           "\"password\": \"Passw0rd123!\"" +
           "}";

    @Test
    public void createUser() {
        Response response = given()
                .auth()
                .preemptive()
                .basic("username", "password")
                .header("Accept", "application/json")
                .contentType(ContentType.JSON)
                .body(validRequest)
                .when()
                .post("http://localhost:8080/users")
                .then()
                .extract()
                .response();

        int statusCode = response.getStatusCode();

        Assert.assertEquals(statusCode,200);
    }
}

Below is an example of authentication in Postman.

Let us create the test for the above example using Rest Assured.

import io.restassured.http.ContentType;
import io.restassured.response.Response;
import org.junit.Assert;
import org.junit.Test;

import static io.restassured.RestAssured.given;

public class BasicAuth_Demo {

    @Test
    public void validateCredentials() {

        Response response = given()
                .auth()
                .preemptive()
                .basic("user", "pass")
                .header("Accept", "application/json")
                .contentType(ContentType.JSON)
                .when()
                .get("https://httpbin.org/basic-auth/user/pass")
                .then()
                .log().all()
                .extract()
                .response();

        int statusCode = response.getStatusCode();

        Assert.assertEquals(200,statusCode);
    }

The output of the above program is

By default, REST-assured waits for the server to challenge before sending the credentials and so the library provides the preemptive directive that we can use:

given()
    .auth()
    .preemptive()
    .basic("username", "password")

Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!! Cheers!!