Script for obtaining authorization bearer token in Postman before sending request

Question

Script for obtaining authorization bearer token in Postman before sending request

I am currently working on a script to automate the generation of my authentication bearer token for collections. This way, I won't have to manually pass the token each time and can inherit authentication from the parent. However, I seem to be encountering an issue with the script as it is not successfully generating the token and is throwing an error.

An error occurred while evaluating the Pre-request Script: Error: No data, empty input at 1:1 ^

Below is the script in question:

var expiresOn = pm.variables.get('ExpiresOn');
    if (!expiresOn || new Date(expiresOn) <= new Date()) {

    var clientId = '565v7677676vfdrd';
          var apiToken =  '6565fdvdrdfd';

    var request = {
        url: 'http://.../auth/token',
        method: 'POST',
        header: 'Content-Type: application/json',
        body: {
            mode: 'raw',
            raw:  clientId + apiToken
        }
    };
            }

        };

        pm.sendRequest(request, function (err, res) {
            if (res !== null) {
                var json = res.json();
                pm.environment.set('Access_Token', json.access_token)

                var expiresOn = new Date(0);
                expiresOn.setUTCSeconds(json.expires_on);
                pm.environment.set('ExpiresOn', expiresOn);
            }
        });
    }

javascript postman postman-collection-runner postman-pre-request-script

Answer 1

Answer №1

const fetchAccessToken = {
  url: 'https://example.com/sign_in?client_id=dbdsA8b6V6Lw7wzu1x0T4CLxt58yd4Bf',
  method: 'POST',
  header: 'Accept: application/json\nUser-Agent: Example/2019.10.31-release (Android 6.0.1; LGE Nexus 5)\nUDID: 1d2c7e65f34b3882f8e42ab8d6a82b4b\nContent-Type: application/json; charset=utf-8\nHost: api-mobile.example.com',
  body: {
    mode: 'application/json',
    raw: JSON.stringify(
        {
        client_id:'dbdsA8b6V6Lw7wzu1x0T4CLxt58yd4Bf',
        client_secret:'aBK1xbehZvrBw0dtVYNY3BuJJOuDFrYs',
        auth_method:'password',
        create_if_not_found:false,
        credentials:{identifier:'username',password:'pass'},
        signature:'2:a899cdc0'
        })
  }
};

var shouldFetchToken = true;

if (!pm.environment.get('accessTokenExpiry') || 
    !pm.environment.get('currentAccessToken')) {
    console.log('Token or expiry date are missing')
} else if (pm.environment.get('accessTokenExpiry') <= (new Date()).getTime()) {
    console.log('Token is expired')
} else {
    shouldFetchToken = false;
    console.log('Token and expiry date are all good');
}

if (shouldFetchToken === true) {
    pm.sendRequest(fetchAccessToken, function (err, res) {
    console.log(err ? err : res.json());
        if (err === null) {
            console.log('Saving the token and expiry date')
            var responseJson = res.json();
            pm.environment.set('currentAccessToken', responseJson.access_token)
           
            var expiryDate = new Date();
            expiryDate.setSeconds(expiryDate.getSeconds() + responseJson.expires_in);
            pm.environment.set('accessTokenExpiry', expiryDate.getTime());
        }
    });
}

The above example demonstrates how to fetch an access token and its expiration time using a Postman pre-request script. This example can help you resolve similar issues. Make sure to monitor the Postman Console for any feedback. Access the Postman Console by pressing Ctrl+Alt+C on Windows or Cmd+Alt+C on Mac.

https://i.sstatic.net/9fdZA.png

Answer 2

const fetchAccessToken = {
  url: 'https://example.com/sign_in?client_id=dbdsA8b6V6Lw7wzu1x0T4CLxt58yd4Bf',
  method: 'POST',
  header: 'Accept: application/json\nUser-Agent: Example/2019.10.31-release (Android 6.0.1; LGE Nexus 5)\nUDID: 1d2c7e65f34b3882f8e42ab8d6a82b4b\nContent-Type: application/json; charset=utf-8\nHost: api-mobile.example.com',
  body: {
    mode: 'application/json',
    raw: JSON.stringify(
        {
        client_id:'dbdsA8b6V6Lw7wzu1x0T4CLxt58yd4Bf',
        client_secret:'aBK1xbehZvrBw0dtVYNY3BuJJOuDFrYs',
        auth_method:'password',
        create_if_not_found:false,
        credentials:{identifier:'username',password:'pass'},
        signature:'2:a899cdc0'
        })
  }
};

var shouldFetchToken = true;

if (!pm.environment.get('accessTokenExpiry') || 
    !pm.environment.get('currentAccessToken')) {
    console.log('Token or expiry date are missing')
} else if (pm.environment.get('accessTokenExpiry') <= (new Date()).getTime()) {
    console.log('Token is expired')
} else {
    shouldFetchToken = false;
    console.log('Token and expiry date are all good');
}

if (shouldFetchToken === true) {
    pm.sendRequest(fetchAccessToken, function (err, res) {
    console.log(err ? err : res.json());
        if (err === null) {
            console.log('Saving the token and expiry date')
            var responseJson = res.json();
            pm.environment.set('currentAccessToken', responseJson.access_token)
           
            var expiryDate = new Date();
            expiryDate.setSeconds(expiryDate.getSeconds() + responseJson.expires_in);
            pm.environment.set('accessTokenExpiry', expiryDate.getTime());
        }
    });
}

The above example demonstrates how to fetch an access token and its expiration time using a Postman pre-request script. This example can help you resolve similar issues. Make sure to monitor the Postman Console for any feedback. Access the Postman Console by pressing Ctrl+Alt+C on Windows or Cmd+Alt+C on Mac.

https://i.sstatic.net/9fdZA.png

Answer 3

Answer №2

Syntax problem

After executing your code, I encountered the following issue:

An error occurred while evaluating the Pre-request Script:  SyntaxError: Unexpected token '('

To resolve this and ensure proper execution, consider revising the script as shown below:

    var sessionExpires = pm.variables.get('SessionExpires');
        if (sessionExpires && new Date(sessionExpires) <= new Date()) {

        var clientID = 'abc1234';
        var apiKey =  'def5678';

        var requestObject = {
            url: 'https://api.example.com/user/session',
            method: 'POST',
            header: 'Content-Type:application/Json',
            body: {
                mode: 'application/json',
                raw:  clientID + apiKey
            }
        };
                }

            pm.sendRequest(requestObject, function (error, response) {
                if (response !== null) {
                    var jsonData = response.json();
                    pm.environment.set('Access_Token', jsonData.access_token)

                    var sessionExpires = new Date(0);
                    sessionExpires.setUTCSeconds(jsonData.expires_on);
                    pm.environment.set('SessionExpires', sessionExpires);
                }
            });

Additional suggestions

I found some useful options that may help you in obtaining the bearer token for your collection:

Answer 4

Syntax problem

After executing your code, I encountered the following issue:

An error occurred while evaluating the Pre-request Script:  SyntaxError: Unexpected token '('

To resolve this and ensure proper execution, consider revising the script as shown below:

    var sessionExpires = pm.variables.get('SessionExpires');
        if (sessionExpires && new Date(sessionExpires) <= new Date()) {

        var clientID = 'abc1234';
        var apiKey =  'def5678';

        var requestObject = {
            url: 'https://api.example.com/user/session',
            method: 'POST',
            header: 'Content-Type:application/Json',
            body: {
                mode: 'application/json',
                raw:  clientID + apiKey
            }
        };
                }

            pm.sendRequest(requestObject, function (error, response) {
                if (response !== null) {
                    var jsonData = response.json();
                    pm.environment.set('Access_Token', jsonData.access_token)

                    var sessionExpires = new Date(0);
                    sessionExpires.setUTCSeconds(jsonData.expires_on);
                    pm.environment.set('SessionExpires', sessionExpires);
                }
            });

Additional suggestions

I found some useful options that may help you in obtaining the bearer token for your collection:

Answer 5

Answer №3

A revised version of Sebin Sunny's solution evaluated using JWT against Azure with the specified resource (/audience).

Include the Authorization header in the request with a randomly generated authorization token.

const echoPostRequest = {
    url: 'https://login.microsoftonline.com/{tenant}/oauth2/token',
    method: 'POST',
    body: {
        mode: 'formdata',
        formdata: [
            { key: 'grant_type', value: 'client_credentials' },
            { key: 'client_Id', value: '*******************************' },
            { key: 'client_secret', value: '*******************************' },
            { key: 'resource', value: '*******************************' }
        ]
    }
};

var getToken = true;

var token = pm.globals.get('$randomLoremSentence') || '';
var exp = pm.globals.get('accessTokenExpiry');
var exps = new Date(exp);
if (token.indexOf('Bearer ') < 0) {
    console.log('Token or expiry date are missing')
} else if (exp <= (new Date()).getTime()) {
    console.log('Token is expired - ${exps}')
} else {
    getToken = false;
    console.log(`Token ${token.substr(0,10)}...${token.substr(-5)} and expiry ${exps} date are all good`);
}

if (getToken === true) {
    pm.sendRequest(echoPostRequest, function (err, res) {
    console.log(err ? err : res.json());
        if (err === null) {
            var responseJson = res.json();
            var token = responseJson.access_token;
            console.log(`Saving the token ${token.substr(0,5)}...${token.substr(-5)} and expiry ${exps} date`)
            pm.globals.set('$randomLoremSentence', "Bearer " + token);
           
            var expiryDate = new Date(responseJson.expires_on * 1000);
            pm.globals.set('accessTokenExpiry', expiryDate.getTime());
        }
    });
}
//pm.globals.set('$randomLoremSentence', 0); // reset token 2 test

Answer 6

A revised version of Sebin Sunny's solution evaluated using JWT against Azure with the specified resource (/audience).

Include the Authorization header in the request with a randomly generated authorization token.

const echoPostRequest = {
    url: 'https://login.microsoftonline.com/{tenant}/oauth2/token',
    method: 'POST',
    body: {
        mode: 'formdata',
        formdata: [
            { key: 'grant_type', value: 'client_credentials' },
            { key: 'client_Id', value: '*******************************' },
            { key: 'client_secret', value: '*******************************' },
            { key: 'resource', value: '*******************************' }
        ]
    }
};

var getToken = true;

var token = pm.globals.get('$randomLoremSentence') || '';
var exp = pm.globals.get('accessTokenExpiry');
var exps = new Date(exp);
if (token.indexOf('Bearer ') < 0) {
    console.log('Token or expiry date are missing')
} else if (exp <= (new Date()).getTime()) {
    console.log('Token is expired - ${exps}')
} else {
    getToken = false;
    console.log(`Token ${token.substr(0,10)}...${token.substr(-5)} and expiry ${exps} date are all good`);
}

if (getToken === true) {
    pm.sendRequest(echoPostRequest, function (err, res) {
    console.log(err ? err : res.json());
        if (err === null) {
            var responseJson = res.json();
            var token = responseJson.access_token;
            console.log(`Saving the token ${token.substr(0,5)}...${token.substr(-5)} and expiry ${exps} date`)
            pm.globals.set('$randomLoremSentence', "Bearer " + token);
           
            var expiryDate = new Date(responseJson.expires_on * 1000);
            pm.globals.set('accessTokenExpiry', expiryDate.getTime());
        }
    });
}
//pm.globals.set('$randomLoremSentence', 0); // reset token 2 test

Answer 7

Answer №4

While on a different search mission, I stumbled upon this query.

This particular pre-request script is designed to handle token expiration and includes various tests for troubleshooting convenience in case of any issues.

To make it work correctly, you need to adjust the body according to the appropriate grant type.

let currentDateTime = Date.now();
let tokenExpiry = pm.environment.get("bearerTokenExpiresOn")
// console.log("currentDateTime: " + currentDateTime);
// console.log("tokenExpiry: " + tokenExpiry);
if (!pm.environment.get("bearerToken") || currentDateTime > tokenExpiry) {
    pm.test("Checking Environment Variables Before Request", function () {
        let vars = ['clientId', 'clientSecret', 'tenantId', 'username', 'password', 'scope'];
        vars.forEach(function (item) {
            // console.log(item);
            pm.expect(pm.environment.get(item), item + " variable not set").to.not.be.undefined;
            pm.expect(pm.environment.get(item), item + " variable not set").to.not.be.empty;
        });
        pm.sendRequest({
            url: 'https://login.microsoftonline.com/' + pm.environment.get("tenantId") + '/oauth2/v2.0/token',
            method: 'POST',
            header: 'Content-Type: application/x-www-form-urlencoded',
            body: {
                mode: 'urlencoded',
                urlencoded: [
                    { key: "client_id", value: pm.environment.get("clientId"), disabled: false },
                    { key: "scope", value: pm.environment.get("scope"), disabled: false },
                    { key: "username", value: pm.environment.get("username"), disabled: false },
                    { key: "password", value: pm.environment.get("password"), disabled: false },
                    { key: "client_secret", value: pm.environment.get("clientSecret"), disabled: false },
                    { key: "grant_type", value: "password", disabled: false },
                ]
            }
        }, function (err, res) {
            if (err) {
                console.log(err);
            } else {
                pm.test("Status Code After Microsoft login - 200", () => {
                    pm.expect(res).to.have.status(200);
                    let resJson = res.json();
                    // console.log(resJson);
                    pm.environment.set("bearerToken", resJson.id_token);
                    pm.environment.set("bearerTokenExpiresOn", Date.now() + resJson.expires_in * 1000);
                    // console.log("bearerTokenExpiresOn: " + pm.environment.get("bearerTokenExpiresOn"));
                });
            }
        });
    });
};

Answer 8

While on a different search mission, I stumbled upon this query.

This particular pre-request script is designed to handle token expiration and includes various tests for troubleshooting convenience in case of any issues.

To make it work correctly, you need to adjust the body according to the appropriate grant type.

let currentDateTime = Date.now();
let tokenExpiry = pm.environment.get("bearerTokenExpiresOn")
// console.log("currentDateTime: " + currentDateTime);
// console.log("tokenExpiry: " + tokenExpiry);
if (!pm.environment.get("bearerToken") || currentDateTime > tokenExpiry) {
    pm.test("Checking Environment Variables Before Request", function () {
        let vars = ['clientId', 'clientSecret', 'tenantId', 'username', 'password', 'scope'];
        vars.forEach(function (item) {
            // console.log(item);
            pm.expect(pm.environment.get(item), item + " variable not set").to.not.be.undefined;
            pm.expect(pm.environment.get(item), item + " variable not set").to.not.be.empty;
        });
        pm.sendRequest({
            url: 'https://login.microsoftonline.com/' + pm.environment.get("tenantId") + '/oauth2/v2.0/token',
            method: 'POST',
            header: 'Content-Type: application/x-www-form-urlencoded',
            body: {
                mode: 'urlencoded',
                urlencoded: [
                    { key: "client_id", value: pm.environment.get("clientId"), disabled: false },
                    { key: "scope", value: pm.environment.get("scope"), disabled: false },
                    { key: "username", value: pm.environment.get("username"), disabled: false },
                    { key: "password", value: pm.environment.get("password"), disabled: false },
                    { key: "client_secret", value: pm.environment.get("clientSecret"), disabled: false },
                    { key: "grant_type", value: "password", disabled: false },
                ]
            }
        }, function (err, res) {
            if (err) {
                console.log(err);
            } else {
                pm.test("Status Code After Microsoft login - 200", () => {
                    pm.expect(res).to.have.status(200);
                    let resJson = res.json();
                    // console.log(resJson);
                    pm.environment.set("bearerToken", resJson.id_token);
                    pm.environment.set("bearerTokenExpiresOn", Date.now() + resJson.expires_in * 1000);
                    // console.log("bearerTokenExpiresOn: " + pm.environment.get("bearerTokenExpiresOn"));
                });
            }
        });
    });
};

Script for obtaining authorization bearer token in Postman before sending request

Answer №1

Answer №2

Syntax problem

Additional suggestions

Answer №3

Answer №4

Similar questions

Unable to locate the reference to 'Handlebars' in the code

Troubleshooting: HighCharts xAxis not displaying dates correctly when using JSON data

Ways to duplicate or replicate a mongodb collection using a javascript command instead of the command prompt

Addressing the issue of compatibility with iPhone 5 and 5S in both portrait and landscape modes

Display the elements of a div at a reduced size of 25% from its original dimensions

Is it feasible to create a comprehensive CRUD application without utilizing a database?

The seamless flow of web design

What are the steps to resolve a peer dependency problem with npm?

TS7006: Argument 'duplicate' is assumed to have an 'any' data type

Granting Access to an S3 Object (Specific HTML Page) Using AWS Cognito JS

Unraveling the Closure Problem in AngularJS

What is the best way to retrieve JSON data in ReactJS through ExpressJS?

Guide for deploying a Svelte front-end and a Node back-end on Heroku

Obtain a collection of information from a web API by utilizing jQuery

A series of OR interfaces in TypeScript Interface

The Backbone model destruction URL fails to include the model's ID when trying to delete

How to beautifully display the hierarchy of nested SASS Maps?

What is the preferred method for accessing nested object properties in React props?

Transferring data from JavaScript to PHP using the $.ajax method for storing information in a MySQL database

Are there any advantages to using arrays with non-contiguous indices that outweigh their drawbacks?