login()

Syntax

LoginResult = connection.login(string username, string password);

Usage

Use the login() call to log in to the login server and start a client session. The client app logs in and obtains a sessionId and server URL before making other API calls.

Enterprise and Partner Endpoints

In API version 11.1 and earlier, client apps built with the partner WSDL can send requests to the enterprise endpoint, and enterprise WSDL apps can send requests to the partner endpoint. Beginning with version 12.0, this functionality is not supported.

Endpoint Base URLs

All examples use the recommended My Domain login URL format for a production org. To specify an endpoint for a sandbox or to use the default Salesforce login URLs, modify the example as needed.

To understand the benefits of using your My Domain login URL versus the default Salesforce login URL, see Log In to Salesforce with Code in Salesforce Help.

Login When Using a Proxy

If you log in to Salesforce via a proxy, set the proxy host and port number on the instance of the ConnectorConfig class that you use to log in. If you must authenticate on the proxy, set the username and password.

ConnectorConfig config = new ConnectorConfig();
config.setUsername(userId);
config.setPassword(passwd);
config.setAuthEndpoint(authEndPoint);
config.setProxy(proxyHost, proxyPort);
// Set the username and password if your proxy must be authenticated
config.setProxyUsername(proxyUsername);
config.setProxyPassword(proxyPassword);
try {
   EnterpriseConnection connection = new EnterpriseConnection(config);
   // etc.
} catch (ConnectionException ce) {
  ce.printStackTrace();
}

Session Expiration

Client apps aren’t required to explicitly log out to end a session. Sessions expire automatically after a predetermined length of inactivity. The default is two hours. If you make an API call, the inactivity timer is reset to zero. To change the session expiration (timeout) value, from Setup, enter Session Settings in the Quick Find box, and select Session Settings.

Active Self-Service Users Authentication

To authenticate active self-service users, use LoginScopeHeader to specify the Organization ID against which self-service users are authenticated. A self-service user must exist and be active before being authenticated (see SelfServiceUser).

Customer Experience Cloud Site User Authentication

To authenticate an active Experience Cloud site user who has the API Enabled permission, use LoginScopeHeader to specify the Organization ID of the org with Experience Cloud sites. Site users must exist, be active, and belong to the Experience Cloud site before being authenticated.

When specifying an endpoint that authenticates an Experience Cloud site user, the base URL format is https://MyDomainName.my.site.com for a production org and https:/MyDomainName--SandboxName.sandbox.my.site.com for a sandbox org..

All examples for Experience Cloud Site User Authorization use the base URL format for a production org with enhanced domains enabled. To specify an endpoint for a sandbox org, or if you haven’t yet enabled enhanced domains, update the base URL.

Example Endpoints

Client apps can send login requests to these endpoints (using valid values for the authentication endpoint).

Logout

Salesforce recommends that you always call logout() to end a session when it’s no longer needed. This call ends any child sessions. To provide the most protection, log out the user instead of waiting for the session to expire.

Sample Code—Java

This sample logs a user in with the specified username, password, and authentication endpoint URL. The sample writes user and session information to the console after a successful login. Before running this sample, replace the values for username, password, and authentication endpoint with valid values.

To learn how to generate and import the web service WSDL needed to make API calls, see Step 2: Generate or Obtain the Web Service WSDL in the Quick Start.

public boolean loginSample() {
   boolean success = false;
   String username = "username";
   String password = "password";
   String authEndPoint = "https://MyDomainName.my.salesforce.com/services/Soap/c/24.0/";

   try {
      ConnectorConfig config = new ConnectorConfig();
      config.setUsername(username);
      config.setPassword(password);        

      System.out.println("AuthEndPoint: " + authEndPoint);
      config.setAuthEndpoint(authEndPoint);

      connection = new EnterpriseConnection(config);

      // Print user and session info
      GetUserInfoResult userInfo = connection.getUserInfo();
      System.out.println("UserID: " + userInfo.getUserId());
      System.out.println("User Full Name: " + userInfo.getUserFullName());
      System.out.println("User Email: " + userInfo.getUserEmail());
      System.out.println();
      System.out.println("SessionID: " + config.getSessionId());
      System.out.println("Auth End Point: " + config.getAuthEndpoint());
      System.out
            .println("Service End Point: " + config.getServiceEndpoint());
      System.out.println();

      success = true;
   } catch (ConnectionException ce) {
      ce.printStackTrace();
   }

   return success;
}

Sample Code—C#

This sample logs a user in using the specified username and password. The result of the login call contains the service endpoint URL, which is the virtual server instance that is servicing your org, and a unique session ID. The sample sets these returned values on the binding. It sets the binding URL to the returned service endpoint. It also sets the session ID on the session header that is used on all API calls. Next, the sample writes user and session information to the console after a successful login. Before running this sample, replace the values for username and password with valid values.

To learn how to generate and import the web service WSDL needed to make API calls, see Step 2: Generate or Obtain the Web Service WSDL in the Quick Start.

public bool loginSample()
{
   Boolean success = false;
   string username = "username";
   string password = "password";

   // Create a service object 
   binding = new SforceService();
 
   LoginResult lr;
   try
   {
      Console.WriteLine("\nLogging in...\n");
      lr = binding.login(username, password);

      /** 
         * The login results contain the endpoint of the virtual server instance 
         * that is servicing your org. Set the URL of the binding 
         * to this endpoint.
         */
      // Save old authentication end point URL
      String authEndPoint = binding.Url;
      // Set returned service endpoint URL
      binding.Url = lr.serverUrl;

      /** Get the session ID from the login result and set it for the 
         * session header that will be used for all subsequent calls.
         */
      binding.SessionHeaderValue = new SessionHeader();
      binding.SessionHeaderValue.sessionId = lr.sessionId;

      // Print user and session info
      GetUserInfoResult userInfo = lr.userInfo;
      Console.WriteLine("UserID: " + userInfo.userId);
      Console.WriteLine("User Full Name: " +
            userInfo.userFullName);
      Console.WriteLine("User Email: " +
            userInfo.userEmail);
      Console.WriteLine();
      Console.WriteLine("SessionID: " +
            lr.sessionId);
      Console.WriteLine("Auth End Point: " +
            authEndPoint);
      Console.WriteLine("Service End Point: " +
            lr.serverUrl);
      Console.WriteLine();

      // Return true to indicate that we are logged in, pointed  
      // at the right URL and have our security token in place.     
      success = true;
   }
   catch (SoapException e)
   {
      Console.WriteLine("An unexpected error has occurred: " +
                                 e.Message + "\n" + e.StackTrace);
   }
   return success;
}

Arguments

The login request size is limited to 10 KB.

Response

LoginResult

Faults

LoginFault