SecureAgent

Represents a Secure Agent that connects Salesforce to on-premises external data sources like SharePoint 2010 and 2013. This object is available in API version 32.0 and later.

Supported Calls

describeSObjects()query()retrieve()

Fields

Field Name Details
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.
Note

Note

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Language
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language of agent labels in the user interface.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The user-interface name for the agent.
Priority
Type
int
Properties
Filter, Group, Nillable, Sort
Description

Specifies the order in which this agent is accessed relative to others in a Secure Agent cluster.

This field is available in API version 35 and later.

ProxyUserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The ID of the user profile specific to the agent.

SecureAgentsClusterId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The ID of a cluster of agents that contains this individual agent. Clusters provide failover protection if an agent on a particular server becomes inaccessible. To edit them, use the SecureAgentsCluster object.

This field is available in API version 35 and later.