LoginScopeHeader

Specifies your organization ID so that you can authenticate Self-Service users for your organization using the existing login().

API Calls

login()

Fields

Element Name	Type	Description
organizationId	ID	The ID of the organization against which you will authenticate Self-Service users.
portalId	ID	Specify only if user is a Customer Portal user. The ID of the portal for this organization. The ID is available in the Salesforce user interface: Select `Your Name` \| Setup \| Customize \| Customer Portal \| Settings Select a Customer Portal name, and on the Customer Portal detail page, the URL of the Customer Portal displays. The Portal ID is in the URL.

Sample Code—C#

/// Demonstrates how to set the LoginScopeHeader values 
    
public void LoginScopeHeaderSample()
{
    // Web Reference to the imported Partner WSDL 
    
    APISamples.partner.SforceService partnerBinding;
    
    string username = "USERNAME";
    string password = "PASSWORD";
    
    // The real Client ID will be an API Token provided by salesforce.com 
    
    // to partner applications following a security review. For more details, 
    
    // see the Security Review FAQ in the online help 
    
    string clientId = "SampleCaseSensitiveToken/100";
    
    partnerBinding = new SforceService();
    partnerBinding.CallOptionsValue = new CallOptions();
    partnerBinding.CallOptionsValue.client = clientId;
    
    // To authenticate Self-Service users we need to set the OrganizationId 
    
    // in the LoginScopeHeader 
    
    string orgId = "00ID0000OrgFoo";
    partnerBinding.LoginScopeHeaderValue = new LoginScopeHeader();
    partnerBinding.LoginScopeHeaderValue.organizationId = orgId;
    // Specify the Portal ID if the user is a Customer Portal user 
    
    string portalId = "00ID0000FooPtl";
    partnerBinding.LoginScopeHeaderValue.portalId = portalId;
    
    try
    {
        APISamples.partner.LoginResult lr =
            partnerBinding.login(username, password);
    }
    catch (SoapException e)
    {
        Console.WriteLine(e.Code);
        Console.WriteLine(e.Message);
    }
}