How to set up Username and Password authentication in new Named Credentials?

Hello there! How’s it going? 😀

In one of my recent post I shared how we can pass API key in headers in External Services, and the basis of that solution was the new Named Credentials set up. In Winter ’23, Salesforce has completely reimagined the set up process for Named Credentials. Oddly enough, the new Named Credentials DO NOT support Username and Password auth out of the box (silly, I know) but there is a very interesting workaround.

But let’s first quickly catchup on what is Username and Password authentication.

Basic Authentication Protocol 

Username and password based authentication is better known as Basic authentication protocol where username and password is passed as a base64 encoded string in the request header. The username and password are concatenated with a colon (:), then encoded to base64 encoded string and passed as a value to the ‘Authorization’ header.

Example:

myUsername:myPassword → base64 encoding applied ⇒ bXlVc2VybmFtZTpteVBhc3N3b3JkCg==

GET https://externalapp.com/data HTTP/1.1
Authorization: Basic bXlVc2VybmFtZTpteVBhc3N3b3JkCg==

NOTE: The fact that a base64 string can be easily decoded, makes the Basic Auth protocol less secure, jfyi.

Alright, now let’s see how we can set up Basic auth protocol in the new Named Credentials.

Setup

In the new Named Creds set up, you’ve to first set up an External Credential (introduced in Winter ’23).

Step 1: Create External Credential.

• Go to Setup -> Named Credentials.
• Click on the External Credentials subtab, then click New.
• Enter a descriptive Label.
• Enter “BasicAuth” developer Name.
• Set the Authentication Protocol to Custom.
• Click Save.

Step 2: Create Permission Set Mapping to store the API key.

• When viewing the External Credential, click New under Permission Set Mappings.
• Select a Permission Set that users will need to access this secret value. (Note: you may want to create a new Permission Set for this purpose.)
• Set the Sequence Number in case a user happens to have multiple Permission Sets used in multiple Permission Set Mappings. This number determines which mapping “wins” and gets used for the callout, sorted from lowest to highest.
• Leave the Identity Type set to Named Principal. This indicates that Salesforce users will share the same API key, and they don’t have unique access to the external service.
• Click Add to create an Authentication Parameter, and enter “Username” in the Name.
• Enter the username in the Value of the Authentication Parameter and click Save.
• Click Add to create another Authentication Parameter, and enter “Password” in the Name.
• Enter the password in the Value of the Authentication Parameter.
• Click Save.

Step 3: Adding Custom Header

• When viewing the External Credential, click New under Custom Headers.
• Enter “Authorization” in the Name of the header.
• Enter the following Value: {!'Basic ' & BASE64ENCODE(BLOB($Credential.BasicAuth.Username & ':' & $Credential.BasicAuth.Password))}.
• Leave the Sequence Number set to the default, since we don’t need to worry about the order of headers in this case.
• Click Save.

Step 4: Create the Named Credential.

• Click the Named Credentials subtab, then click New.
• Enter a descriptive Label.
• Enter a developer Name.
• Set the URL to the correct endpoint.
• Select the External Credential created in the prior step.
• For this example, it’s important to uncheck the Generate Authorization Header setting. Instead, this will be handled by the Custom Header we defined in the prior steps.
• Check the Allow Formulas in HTTP Header setting as we’re formula functions in header values.
• Click Save.

And we’re all set!

Hope you find this one useful! Catch you in the next one! ✌
And thank you for being an awesome reader! Subscribe to this blog for receiving all the latest updates straight to your inbox. 🙂

Advertisement