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
AuthConfiguration Class
AuthConfiguration Constructors
AuthConfiguration Methods
AuthProviderCallbackState Class
AuthProviderPlugin Interface
AuthProviderPluginClass Class
AuthProviderTokenResponse Class
AuthToken Class
CommunitiesUtil Class
ConfigurableSelfRegHandler Interface
ConfirmUserRegistrationHandler Interface
ConnectedAppPlugin Class
CustomOneTimePasswordDeliveryHandler Interface
CustomOneTimePasswordDeliveryResult Enum
ExternalClientAppOauthHandler Class
HeadlessSelfRegistrationHandler Interface
HeadlessUserDiscoveryHandler Interface
HeadlessUserDiscoveryResponse Class
HttpCalloutMockUtil Class
IntegratingAppType Enum
InvocationContext Enum
JWS Class
JWT Class
JWTBearerTokenExchange Class
JWTUtil Class
LightningLoginEligibility Enum
LoginDiscoveryHandler Interface
LoginDiscoveryMethod Enum
MyDomainLoginDiscoveryHandler Interface
Oauth2TokenExchangeHandler Class
OAuth2TokenExchangeType Enum
OAuthRefreshResult Class
OauthToken Class
OauthTokenType Enum
RegistrationHandler Interface
SamlJitHandler Interface
SessionManagement Class
SessionLevel Enum
TokenValidationResult Class
UserData Class
VerificationAction Enum
VerificationMethod Enum
VerificationPolicy Enum
VerificationResult Class
Auth Exceptions
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable 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

AuthConfiguration Class

Contains methods for configuring settings for users to log in to a Salesforce org using their authentication provider credentials instead of their Salesforce credentials. The authentication provider can be any authentication provider that supports the OpenID Connect protocol, such as Google, Facebook, or Twitter. Users log in to either an Experience Cloud site (https://MyDomainName.my.site.com) or your My Domain login URL (https://MyDomainName.my.salesforce.com).

Namespace

Auth

Example

This example shows how to call some methods on the Auth.AuthConfiguration class. Before you can run this sample, you must provide valid values for the URLs and developer name.

String communityUrl = 'MyDomainName.my.site.com';
String startUrl = '<Add URL>';
Auth.AuthConfiguration authConfig = new Auth.AuthConfiguration(communityUrl,startUrl);
List<AuthProvider> authPrvs = authConfig.getAuthProviders();
String bColor = authConfig.getBackgroundColor();
String fText = authConfig.getFooterText();

String sso = Auth.AuthConfiguration.getAuthProviderSsoUrl(communityUrl, startUrl, 'developerName');

AuthConfiguration Constructors

The following are constructors for AuthConfiguration.

The AuthConfiguration (networkId, startUrl) constructor is deprecated in API version 56.0 and later.

Note

AuthConfiguration(communityOrCustomUrl, startUrl)

Creates an instance of the AuthConfiguration class using the specified URL for an Experience Cloud site or a My Domain subdomain and the start URL for authenticated users.

Signature

public AuthConfiguration(String communityOrCustomUrl, String startUrl)

Parameters

communityOrCustomUrl
Type: String
The URL for the domain, which can be a Salesforce subdomain created with My Domain (my.salesforce.com) or a subdomain of an Experience Cloud site (force.com).
startUrl
Type: String
The page users see after successfully logging in to the Experience Cloud site or My Domain subdomain.

AuthConfiguration Methods

The following are methods for AuthConfiguration. Use these methods to manage and customize authentication for a Salesforce community.

getAllowInternalUserLoginEnabled()

Indicates whether the Experience Cloud site allows internal users to log in using the Experience Cloud site login page. To enable, admins configure the setting Allow internal users to log in directly to the experience on the Login & Registration page in Experience Workspaces. It’s disabled by default.

Signature

public Boolean getAllowInternalUserLoginEnabled()

Return Value

Type: Boolean

Usage

If true, internal users log in to an Experience Cloud site from the site’s login page with their internal credentials. If they navigate to their internal org from the Experience Cloud site, they don't have to log in again.

getAuthConfig()

Returns the AuthConfig sObject, which represents the authentication options for an Experience Cloud site or Salesforce My Domain subdomain.

Signature

public AuthConfig getAuthConfig()

Return Value

Type: AuthConfig

The AuthConfig sObject for the Experience Cloud site or Salesforce My Domain subdomain.

getAuthConfigProviders()

Returns the list of authentication providers configured for an Experience Cloud site or Salesforce My Domain subdomain.

Signature

public List<AuthConfigProviders> getAuthConfigProviders()

Return Value

Type: List<AuthConfigProviders>

A list of authentication providers (AuthConfigProviders sObjects), which are children of the AuthProvider sObject.

getAuthProviders()

Returns the list of authentication providers available for an Experience Cloud site or Salesforce My Domain subdomain.

Signature

public List<AuthProvider> getAuthProviders()

Return Value

Type: List<AuthProvider>

A list of authentication providers (AuthProvider sObjects) for the Experience Cloud site or My Domain subdomain.

getAuthProviderSsoDomainUrl(communityUrl, startUrl, developerName)

Returns the single sign-on URL for an Experience Cloud site subdomain.

For better performance, we recommend using this method instead of getAuthProviderSsoUrl. If the authentication provider has User Subdomain for Callback enabled, changing the single sign-on URL also changes the callback URL to use the Experience Cloud site subdomain. Before switching to this method, update the callback URL in your third-party applications to avoid getting an invalid callback URL error during single sign-on.

Note

Signature

public static String getAuthProviderSsoDomainUrl(String communityUrl, String startUrl, String developerName)

Parameters

communityUrl
Type: String

The URL for the Experience Cloud site subdomain. If null or specified as an empty string, you get the single sign-on URL for the org’s My Domain.

startUrl
Type: String

The page that users see after logging in to the Experience Cloud site subdomain.

developerName
Type: String
The unique name of the authentication provider.

Return Value

Type: String

The Single Sign-On Initialization URL for the Experience Cloud site subdomain.

getAuthProviderSsoUrl(communityUrl, startUrl, developerName)

Returns the single sign-on URL for an Experience Cloud site or Salesforce My Domain subdomain.

Signature

public static String getAuthProviderSsoUrl(String communityUrl, String startUrl, String developerName)

Parameters

communityUrl
Type: String
The URL for the Experience Cloud site or My Domain subdomain. If not null and not specified as an empty string, you get the URL for the Experience Cloud site. If null or specified as an empty string, you get the URL for a custom domain.
startUrl
Type: String
The page that users see after logging in to the Experience Cloud site or My Domain subdomain.
developerName
Type: String
The unique name of the authentication provider.

Return Value

Type: String

The Single Sign-On Initialization URL for the Experience Cloud site or Salesforce My Domain subdomain.

getBackgroundColor()

Returns the color for the background of the login page for a community.

Signature

public String getBackgroundColor()

Return Value

Type: String

getCertificateLoginEnabled(domainUrl)

Returns true if certificate-based authentication is enabled for the My Domain URL.

Signature

public Boolean getCertificateLoginEnabled(String domainUrl)

Parameters

domainUrl
Type: String
The My Domain URL that is being checked for certificate-based authentication.

Return Value

Type: Boolean

getCertificateLoginUrl(domainUrl, startUrl)

Returns the certificate-based authentication endpoint for the My Domain URL if the org has certificate-based authentication enabled.

Signature

public static String getCertificateLoginUrl(String domainUrl, String startUrl)

Parameters

domainUrl
Type: String
The My Domain URL being checked for its certificate-based authentication endpoint .
startUrl
Type: String
The page that the user is directed to after logging in to the My Domain with certificate-based authentication.

Return Value

Type: String

The certificate-based authentication endpoint for the My Domain URL: mydomainURL:8443/services/certauth?startURL=startURLParam

getDefaultProfileForRegistration()

Returns the profile ID assigned to new community users.

Signature

public String getDefaultProfileForRegistration()

Return Value

Type: String

The profile ID.

getFooterText()

Returns the text at the bottom of the login page for a community.

Signature

public String getFooterText()

Return Value

Type: String

The text string displayed at the bottom of the login page, for example “Log in with an existing account.”

getForgotPasswordUrl()

Returns the URL for the standard or custom Forgot Password page that is specified for an Experience Cloud site or portal by the administrator.

Signature

public String getForgotPasswordUrl()

Return Value

Type: String

URL for the standard or custom Forgot Password page.

getHeadlessForgotPasswordEnabled()

Returns true if the Headless Forgot Password Flow is enabled.

Signature

public Boolean getHeadlessForgotPasswordEnabled()

Return Value

Type: Boolean

getHeadlessFrgtPswEnabled()

This method will be deprecated in a future release. Use the getHeadlessForgotPasswordEnabled() method in this class instead.

Signature

public Boolean getHeadlessFrgtPswEnabled()

Return Value

Type: Boolean

getHeadlessPasswordlessLoginEnabled()

Determines if headless passwordless login is enabled.

Signature

public Boolean getHeadlessPasswordlessLoginEnabled()

Return Value

Type: Boolean

Returns true if headless passwordless login is enabled.

getHeadlessRegistrationEnabled()

Determines if the Headless Registration Flow is enabled.

Signature

public Boolean getHeadlessRegistrationEnabled()

Return Value

Type: Boolean

Returns true if headless registration is enabled.

getLogoUrl()

Returns the location of the icon image at the bottom of the login page for a community.

Signature

public String getLogoUrl()

Return Value

Type: String

The path to the icon image.

getRightFrameUrl()

Returns the URL for the right-frame content to display on the right side of the Experience Cloud site login page. The admin supplies the URL.

Signature

public String getLoginRightFrameUrl()

Return Value

Type: String

URL for the right-frame content of the Experience Cloud site login page. Salesforce creates an inline (iframe) on the right side of the login page to display the contents specified by the URL.

getSamlProviders()

Returns the list of SAML-based authentication providers available for an Experience Cloud site or Salesforce My Domain subdomain.

Signature

public List<SamlSsoConfig> getSamlProviders()

Return Value

Type: List<SamlSsoConfig>

A list of SAML-based authentication providers, which are SamlSsoConfig sObjects.

getSamlSsoUrl(communityUrl, startURL, samlId)

Returns the single sign-on URL for an Experience Cloud site or Salesforce My Domain subdomain.

Signature

public static String getSamlSsoUrl(String communityUrl, String startURL, String samlId)

Parameters

communityUrl
Type: String
The URL for the Experience Cloud site or My Domain subdomain. If not null and not specified as an empty string, you get the URL for the Experience Cloud site. If null or specified as an empty string, you get the URL for a My Domain subdomain.
startUrl
Type: String
The page users see after successfully logging in to the Experience Cloud site or My Domain subdomain
samlId
Type: String
The unique identifier of the SamlSsoConfig standard object for the Experience Cloud site or My Domain subdomain

Return Value

Type: String

The Single Sign-On Initialization URL for the Experience Cloud site or Salesforce My Domain subdomain.

getSelfRegistrationEnabled()

Indicates whether the current community allows new users to create their own account by filling out a registration form.

Signature

public Boolean getSelfRegistrationEnabled()

Return Value

Type: Boolean

getSelfRegistrationUrl()

Returns the location of the self-registration page for new users to sign up for an account with a community.

Signature

public String getSelfRegistrationUrl()

Return Value

Type: String

The location of the self-registration page.

getStartUrl()

Returns the start page of an Experience Cloud site or Salesforce My Domain subdomain. This URL is the first page that users see when they log in.

Signature

public String getStartUrl()

Return Value

Type: String

The location of the start page for the Experience Cloud site or My Domain subdomain.

getUsernamePasswordEnabled()

Indicates whether the current community is set to display a login form asking for a username and password. You can configure the community not to request a username and password if it is for unauthenticated users or users logging in with a third-party authentication provider.

Signature

public Boolean getUsernamePasswordEnabled()

Return Value

Type: Boolean

isCommunityUsingSiteAsContainer()

Returns true if the Experience Cloud site uses Site.com pages; otherwise, returns false.

Signature

public Boolean isCommunityUsingSiteAsContainer()

Return Value

Type: Boolean