Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpCalculatedInsight Class
CdpIdentityResolution Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EmailMergeFieldService Class
EmployeeProfiles Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentDelivery Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NamedCredentials Methods
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace (Developer Preview)
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
Invocable Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

NamedCredentials Class

Create, get, update, and delete credentials. Get external credentials. Get the URL for the OAuth token flow for an external credential.

Namespace

ConnectApi

NamedCredentials Methods

The following are methods for NamedCredentials. All methods are static.

createCredential(requestBody)

Create a credential.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.Credential createCredential(ConnectApi.CredentialInput requestBody)

Parameters

requestBody
Type: ConnectApi.CredentialInput
A ConnectApi.CredentialInput class.

Return Value

Type: ConnectApi.Credential

deleteCredential(externalCredential, principalName, principalType)

Delete a credential.

API Version

56.0

Requires Chatter

No

Signature

public static Void deleteCredential(String externalCredential, String principalName, ConnectApi.CredentialPrincipalType principalType)

Parameters

externalCredential
Type: String
Fully qualified developer name of the external credential.
principalName
Type: String
Name of the external credential named principal.
principalType
Type: ConnectApi.CredentialPrincipalType
Type of credential principal. Values are:
  • AwsStsPrincipal
  • NamedPrincipal
  • PerUserPrincipal

Return Value

Type: Void

getCredential(externalCredential, principalName, principalType)

Get a credential.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.Credential getCredential(String externalCredential, String principalName, ConnectApi.CredentialPrincipalType principalType)

Parameters

externalCredential
Type: String
Fully qualified developer name of the external credential.
principalName
Type: String
Name of the external credential named principal.
principalType
Type: ConnectApi.CredentialPrincipalType
Type of credential principal. Values are:
  • AwsStsPrincipal
  • NamedPrincipal
  • PerUserPrincipal

Return Value

Type: ConnectApi.Credential

getExternalCredential(developerName)

Get an external credential, including the named credentials and principals associated with it and the type and status of each principal.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.ExternalCredential getExternalCredential(String developerName)

Parameters

developerName
Type: String
Fully qualified developer name of the external credential.

Return Value

Type: ConnectApi.ExternalCredential

getExternalCredentials()

Get external credentials that the user can authenticate to.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.ExternalCredentialList getExternalCredentials()

Return Value

Type: ConnectApi.ExternalCredentialList

getOAuthCredentialAuthUrl(requestBody)

Get the URL for the OAuth token flow for an external credential.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.OAuthCredentialAuthUrl getOAuthCredentialAuthUrl(ConnectApi.OAuthCredentialAuthUrlInput requestBody)

Parameters

requestBody
Type: ConnectApi.OAuthCredentialAuthUrlInput
A ConnectApi.OAuthCredentialAuthUrlInput class indicating the OAuth authentication flow.

Return Value

Type: ConnectApi.OAuthCredentialAuthUrl

Usage

Accepts input parameters representing a specific external credential and, optionally, a named principal. Returns the URL a user must visit to begin the authentication flow, ultimately returning authentication tokens to Salesforce. Use this method as part of building a customized or branded user interface to help users initiate authentication.

Example

1ConnectApi.OAuthCredentialAuthUrlInput input = new ConnectApi.OAuthCredentialAuthUrlInput();
2
3input.externalCredential = 'MyExternalCredentialDeveloperName';
4input.principalType = ConnectApi.CredentialPrincipalType.PerUserPrincipal;
5input.principalName = 'MyPrincipal'; // Only required when principalType = NamedPrincipal
6
7ConnectApi.OAuthCredentialAuthUrl output = ConnectApi.NamedCredentials.getOAuthCredentialAuthUrl(input);
8
9String authenticationUrl = output.authenticationUrl; // Redirect users to this URL to authenticate in the browser

updateCredential(requestBody)

Update a credential.

API Version

56.0

Requires Chatter

No

Signature

public static ConnectApi.Credential updateCredential(ConnectApi.CredentialInput requestBody)

Parameters

requestBody
Type: ConnectApi.CredentialInput
A ConnectApi.CredentialInput class.

Return Value

Type: ConnectApi.Credential