Outbound Basic Auth

Overview

The Outbound Basic Auth Policy enables you to set up a Basic Authentication account for verification at a proxy endpoint level when you establish a connection with a service or a system. It provides flexibility to add login credentials to the header, body, or query string parameter. A preconfigured Basic Auth account is needed to connect with the backend service so you can access third-party URLs through the Proxy.

  • The Basic Auth Outbound Policy is not available for APIs and API versions.

  • The preconfigured accounts used in this policy automatically reflect the changes made to the name of Basic Auth account in the global shared folder.

  • Deletion of the Basic Auth account invalidates the policy and display an error. In this case, you must select another account by navigating to the Policy Setting.

Prerequisites

  • Preconfigured Basic Authentication Account.

Supported Account Types

  • API Suite Basic Authentication Account.

Policy Execution Order

The Outbound Basic Auth Policy executes after all policies, when the proxy calls the downstream API.

All expression-enabled fields take expressions from the SnapLogic® Expression Language and the API Policy Manager functions.

Known Issue

When you use the HTTP Retry Policy with the Basic Auth policy, the request fails with an error message. This issue only applies to Proxies created after the February 2024 release. Existing Proxies are unaffected.
Workaround: Delete the HTTP Retry Policy.

Settings and Account Tab

policy-basic-auth-reducewhitespace.png

Field names with an '*' (Asterisk symbol) suffix are mandatory fields.

Parameter Name

Field Type

Description

Default Value

Example

Parameter Name

Field Type

Description

Default Value

Example

Setting Tab

Label*

String

Required. The name for the API policy.

Outbound Basic Auth

Outbound Basic Auth Policy

When this policy should be applied

String/Expression

An expression-enabled field that determines the condition to be fulfilled for the API policy to execute.

For example, if the value in this field is request.method == "POST", the API policy is executed only if the request method is a POST.

N/A

request.method == “POST”

Token Location*

 

Select the Token location as Header/Body/Query.

 

 

Header

 

Dropdown List

Token provided in header

Header

Header

 

Authorization Scheme*

Dropdown List

Select Bearer/Custom Authorization Scheme if you selected the Header option from the dropdown list.

Basic

Basic

 

Custom Authorization Scheme

 

String

Add your Custom Scheme token.

N/A

N/A

Body

 

Dropdown List

Token provided in header

Body

 

 

Request Body Key

 

String

Enter the JSON key with the value of the token.

N/A

N/A

Query

 

Dropdown List

Token provided in header

Query

 

 

Query String Parameter Name

 

String

Name the Query Parameter.

N/A

N/A

Status

Dropdown List

Specifies whether the API policy is enabled or disabled. 

Enabled

Enabled

Account Tab

Account Reference*

Dropdown List

Select a preconfigured Basic Auth account from the dropdown list that is configured in the Global Org >Shared Folder.

N/A

../../shared/BasicAuthOutboundaccount