login()

Logs in to the login server and starts a client session.

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

When a client application invokes the login() call, it passes in a username and password as user credentials. Upon invocation, the API authenticates the credentials and returns the sessionId for the session, the user ID associated with the logged-in username, and a URL that points to the Force.comAPI to use in all subsequent API calls.

Salesforce checks the IP address from which the client application is logging in, and blocks logins from unknown IP addresses. For a blocked login via the API, Salesforce returns a login fault. Then, the user must add their security token to the end of their password in order to log in. A security token is an automatically-generated key from Salesforce. For example, if a user's password is mypassword, and their security token is XXXXXXXXXX, then the user must enter mypasswordXXXXXXXXXX to log in. Users can obtain their security token by changing their password or resetting their security token via the Salesforce user interface. When a user changes their password or resets their security token, Salesforce sends a new security token to the email address on the user's Salesforce record. The security token is valid until a user resets their security token, changes their password, or has their password reset. When the security token is invalid, the user must repeat the login process to log in. To avoid this, the administrator can make sure the client's IP address is added to the organization's list of trusted IP addresses. For more information, see Security Token.

After logging in, a client application needs to perform these tasks:

• Set the session ID in the SOAP header so that the API can validate subsequent requests for this session.
• Specify the server URL as the target for subsequent service requests. You must change to the server URL, the login server only supports login calls.

Development tools differ in the way you specify session headers and server URLs. For more information, see the documentation for your particular development tool.

Note

Multiple client applications can log in using the same username argument. However, this increases your risk of getting errors due to query limits.A user can have up to 10 query cursors open at a time. If 10 QueryLocator cursors are open when a client application, logged in as the same user, attempts to open a new one, then the oldest of the 10 cursors is released. If the client application attempts to open the released query cursor, an error results.

ConnectionConfig config = new ConnnectionConfig();
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();
}

Authenticating Active Self-Service Users

Note

Starting with Spring ’12, the Self-Service portal isn’t available for new organizations. Existing organizations continue to have access to the Self-Service portal.

To authenticate active Self-Service users, use the 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).

public boolean login() {
    boolean success = false;
    String userId = getUserInput("UserID: ");
    String passwd = getUserInput("Password: ");
    ConnectorConfig config = new ConnectorConfig();
    config.setUsername(userId);
    config.setPassword(passwd);
    config.setAuthEndpoint(authEndPoint);
    config.setCompression(true);
    try {
      connection = new EnterpriseConnection(config);
      GetUserInfoResult userInfo = connection.getUserInfo();
      System.out.println("\nLogging in ...\n");
      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;
  }

private void login() 
{ 
  // Create service object  
    
  binding = new SforceService(); 
  // Invoke the login call and save results in LoginResult  
    
  LoginResult lr = binding.login("username","password"); 
  if (!lr.passwordExpired) {
  // Reset the SOAP endpoint to the returned server URL  
    
  binding.Url = lr.serverUrl; 
  // Create a new session header object  
    
  // Add the session ID returned from the login  
    
  binding.SessionHeaderValue = new SessionHeader(); 
  binding.SessionHeaderValue.sessionId = lr.sessionId; 
  GetUserInfoResult userInfo = lr.userInfo; 
  } else {
    Console.WriteLine("Your password is expired.");
  }
}

UnexpectedErrorFault