AuthenticationProtocol |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
-
Required.
The authentication protocol that’s required to access
the external system. Valid values are:
-
AwsSv4
— AWS Signature Version 4
-
Basic
— Authentication using a static username
and password
-
Custom
— User-created authentication. Specify the
permission set, sequence number, and
authentication parameters. Each authentication
parameter requires a name and value.
-
Jwt
— Reserved for future use
-
JwtExchange— Reserved for future
use
-
NoAuthentication — Reserved for
future use
-
Oauth
— Oauth 2.0
-
Password
— Reserved for future use
For connections to Amazon Web Services using
Signature Version 4, use AwsSv4.
For connections using a direct token system, use
Jwt. If using
an intermediary authorization provider to process
JWTs and return access tokens, use JwtExchange.
For Simple URL data sources, select NoAuthentication.
For connections using a static username and password,
use Basic.
For cloud-based Files Connect external systems,
select Oauth.
For on-premises systems, select Password.
|
Description |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- A meaningful description of the external credential.
|
DeveloperName |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The unique name for the external credential object.
- 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. Label is
Record Type Name. This field is automatically generated, but you can
supply your own value if you create the record using the
API.
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.
-
Only users with View DeveloperName OR View Setup
and Configuration permission can view, group, sort,
and filter this field.
|
ExternalCredentialParameters |
- Type
- ExternalCredentialParameter[]
- Properties
- Nillable
- Description
- One or more sets of parameters that further configure
the external credential.
|
FullName |
- Type
- string
- Properties
- Create, Group, Nillable
- Description
- The full name of ExternalCredential
in Metadata API. The full name can include a namespace
prefix.
- Query this field only if the query result contains no
more than one record. Otherwise, an error is returned. If more than one record
exists, use multiple queries to retrieve the records. This limit protects
performance.
|
Language |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted
picklist, Sort
- Description
- The language of the external credential.
|
ManageableState |
- Type
- ManageableState enumerated list
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates the manageable state of the specified component that is contained
in a package:
- beta
- deleted
- deprecated
- deprecatedEditable
- installed
- installedEditable
- released
- unmanaged
|
MasterLabel |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The main label for the external credential. In the UI,
this field is Label.
|
Metadata |
- Type
- ExternalCredential
- Properties
- Create, Nillable, Update
- Description
- The external credential’s metadata.
-
Query this field only if the query result contains no
more than one record. Otherwise, an error is returned. If more than one record
exists, use multiple queries to retrieve the records. This limit protects
performance.
|
NamespacePrefix |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- The namespace prefix that is associated with this
object. Each Developer Edition org that creates a
managed package has a unique namespace prefix. Limit: 15
characters. You can refer to a component in a managed
package by using the namespacePrefix__componentName
notation.
|