Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
AsyncDeleteCallback Class
AsyncSaveCallback Class
AuthenticationCapability Enum
AuthenticationProtocol Enum
Capability Enum
Column Class
ColumnSelection Class
Connection Class
ConnectionParams Class
ConnectionParams Properties
DataSourceUtil Class
DataType Enum
DeleteContext Class
DeleteResult Class
Filter Class
FilterType Enum
IdentityType Enum
Order Class
OrderDirection Enum
Provider Class
QueryAggregation Enum
QueryContext Class
QueryUtils Class
ReadContext Class
SearchContext Class
SearchUtils Class
Table Class
TableResult Class
TableSelection Class
UpsertContext Class
UpsertResult Class
DataSource Exceptions
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

ConnectionParams Class

Contains the credentials for authenticating to the external system.

Namespace

DataSource

Usage

If your extension of the DataSource.Provider class returns DataSource.AuthenticationCapability values that indicate support for authentication, the DataSource.Connection class is instantiated with a DataSource.ConnectionParams instance in the constructor.

The authentication credentials in the DataSource.ConnectionParams instance depend on the Identity Type field of the external data source definition in Salesforce.
  • If Identity Type is set to Named Principal, the credentials come from the external data source definition.
  • If Identity Type is set to Per User:
    • For queries and searches, the credentials are specific to the current user who invokes the query or search. The credentials come from the user’s authentication settings for the external system.
    • For administrative connections, such as syncing the external system’s schema, the credentials come from the external data source definition.

The values in this class can appear in debug logs and can be accessed by users who have the “Author Apex” permission. If you require better security, we recommend that you specify named credentials instead of URLs as your Apex callout endpoints. Salesforce manages all authentication for Apex callouts that specify a named credential as the callout endpoint so that your code doesn’t have to.

ConnectionParams Properties

The following are properties for ConnectionParams.

certificateName

The name of the certificate for establishing each connection to the external system.

Signature

public String certificateName {get; set;}

Property Value

Type: String

The value comes from the external data source definition in Salesforce.

endpoint

The URL of the external system.

Signature

public String endpoint {get; set;}

Property Value

Type: String

The value comes from the external data source definition in Salesforce.

oauthToken

The OAuth token that’s issued by the external system.

Signature

public String oauthToken {get; set;}

Property Value

Type: String

password

The password for authenticating to the external system.

Signature

public String password {get; set;}

Property Value

Type: String

The value depends on the Identity Type field of the external data source definition in Salesforce.
  • If Identity Type is set to Named Principal, the credentials come from the external data source definition.
  • If Identity Type is set to Per User:
    • For queries and searches, the credentials are specific to the current user who invokes the query or search. The credentials come from the user’s authentication settings for the external system.
    • For administrative connections, such as syncing the external system’s schema, the credentials come from the external data source definition.

principalType

An instance of DataSource.IdentityType, which determines which set of credentials to use to access the external system.

Signature

public DataSource.IdentityType principalType {get; set;}

Property Value

Type: DataSource.IdentityType

protocol

The type of protocol that’s used to authenticate to the external system.

Signature

public DataSource.AuthenticationProtocol protocol {get; set;}

Property Value

Type: DataSource.AuthenticationProtocol

repository

Reserved for future use.

Signature

public String repository {get; set;}

Property Value

Type: String

Reserved for future use.

username

The username for authenticating to the external system.

Signature

public String username {get; set;}

Property Value

Type: String

The value depends on the Identity Type field of the external data source definition in Salesforce.
  • If Identity Type is set to Named Principal, the credentials come from the external data source definition.
  • If Identity Type is set to Per User:
    • For queries and searches, the credentials are specific to the current user who invokes the query or search. The credentials come from the user’s authentication settings for the external system.
    • For administrative connections, such as syncing the external system’s schema, the credentials come from the external data source definition.