Skip to main content

Quick Tips : Use SFDX Auth token within CURL requests (Mac/ Linux)

I came across a peculiar requirement recently, wherein we needed to download files in a scheduled job. As you all know downloading a file can be a tricky affair with Salesforce. 

Fortunately, using REST API we can achieve it. So, the solution became somewhat easier, wherein we could make a CURL call and download the file. 

However, all usual cases reference using login name/ password or some reference using the Connected app (OAuth) route. For my specific use case, I already have a machine setup with SFDX and with target orgs authenticated.

This solution helps just in that case. With command line scripting it is quite easy (for folks who are experienced with the command line). It took some time for me to get it working.

Note: This approach should be chosen after appropriate review/analysis of other approaches, namely, OAuth-based login flows for app authentication.

Tools used

  1. SFDX - to retrieve auth tokens
  2. Curl - to make API calls via the command line 
  3. JQ - to parse JSON in the command line

Steps 1 - Get Org Info

This command helps retrieve target org's
sfdx force:org:display -u <TAGET ORG> --json

Result (masked information)
"status": 0,
"result": {
"username": "",
"id": "00D3I00000089ASPUAA",
"connectedStatus": "Connected",
"accessToken": "<AUTH TOKEN>",
"instanceUrl": "",
"clientId": "PlatformCLI",
"alias": "targetorg"

Steps 2 - Extract auth token

This command uses the previous command and extracts the auth token from the JSON response of the previous command

sfdx force:org:display -u <TARGET ORG> --json | jq '.result.accessToken' -r

Note: JQ allows us to simply parse and extract desired value within JSON data

(shown in multi-line command format for rendering here)
anshul@Anshuls-MacBook-Pro ~ % sfdx force:org:display -u sv_newdev --json |
pipe> jq '.result.accessToken' -r


Step 3 - Fire the CURL command to make request

Fire API request by using auth token within CURL

curl "https://<TARGET ORG>"
-H "Authorization: Bearer <AUTH TOKEN>"

Final - Combine all of these into one command

curl "https://<TARGET ORG>"
-H "Authorization: Bearer $(sfdx force:org:display -u <TARGET ORG> --json | jq '.result.accessToken' -r)"

This is a small one-liner code that allows you to invoke an API (in this particular case, get code of visualforce page).


Popular posts from this blog

Quick Tips: Salesforce default Images

Well, I'm sure a lot of you still rely on using out of the box salesforce images for displaying quick icons within formula fields or even using them within your Visualforce pages. Lately, I realized that a lot of earlier resources are no longer accessible, so I tried to quickly extract all images from Salesforce CSS files and provide a quick reference here. Please note, I've referenced all images from SF servers directly, so if anything changes, the image should stop rendering here. As these images are completely controlled by Salesforce, and in case they change anything, it might lead to image not being accessible. Image path Image /img/samples/flag_green.gif /img/samples/flag_green.gif /img/samples/flag_red.gif /img/samples/color_red.gif /img/samples/color_yellow.gif /img/samples/color_green.gif /img/samples/light_green.gif /img/samples/light_yellow.gif /img/samples/light_red.gif /img/samples/stars_100.gif /img/samples/stars_200.gif /img/samples/stars_300.

Lightning: Generate PDF from Lightning components with in-memory data

I'm sure as everyone is diving into lightning components development, they are getting acquainted with the nuances of the Lightning components framework. As well as, its current limitations. Being a new framework, this is bound to happen. Although we have our users still using salesforce classic, we have started using lightning components framework our primary development platform and Visualforce is considered primarily for rendering lightning components within Classic Service console. Recently, while re-architecting a critical module, we encountered a problem wherein we needed to generate PDF from lightning components. Now, being Javascript intensive framework, it has limited room for such features (may be included in future roadmap). As of now, there is no native feature within the lightning framework to do so (at least I didn't find anything). Common Scenario - Create Visualforce page to retrieve data and generate PDF For scenarios where the data exist within Sa

Quick Tips: Setup SFDX Manually without Admin access

We all have faced challenges while working in different enterprise environments, where there may be lot of controls/ checks/ red-tape to get by. In such situations, getting access to simple tools (even git) can take lot of time. Note: This tutorial is to be followed at your own risk, as it may not be complaint to your organization's IT policies. What is SFDX? SFDX is a command line utility for managing salesforce builds/ deployments. Being command line, it can be easily embedded to automation chains, to help build fully automated build and deployment processes. To get started, refer Setup SFDX on Windows machine without admin access As you may have already realized, SFDX installation needs admin access to one's machine. Which may be a luxury a lot of developers may not have. So, i tried to provide a step-by-step guide to setup SFDX on your computer without any admin access Steps: Note: