Updated 06 September 2008 - see the end of the post for details of how to get further user properties by using the user profile web service

This is just a quick post in response to a question I’ve had about how to get the current user’s login details in WSS 3.0. The answer is really in two parts. Firstly, you can get the ID of the current user from the _spUserId variable which is declared by the welcome control on any page.

To test this type javascript:alert(_spUserId) in the browser address bar whilst on a SharePoint page:

Now that we’ve got the internal ID of the user we can look them up in the hidden User Information List. This list contains basic information about users and their profile properties and can be searched using the Lists.asmx web service. The following example uses the javascript API that I published previously to get the user name for user ID 1:

var lists = new SPAPI_Lists('')
var items = lists.getListItems(
'User Information List',
'',
'<Query><Where><Eq><FieldRef Name="ID"/><Value Type="Counter">1</Value></Eq></Where></Query>',  // query
'<ViewFields><FieldRef Name="Name"/></ViewFields>',
1,  // rowLimit
''  // queryOptions
);

if (items.status == 200)
{
    var rows = items.responseXML.getElementsByTagName('z:row');

    if (rows.length == 1)
    {
        alert('The user name is: ' + rows[0].getAttribute('ows_Name'));
    }
    else
    {
        alert('No user was found');
    }
}
else
{
    alert('There was an error: ' + items.statusText);
}

We can wrap this all up into a neat little function which returns the login name based on an ID. Note that the returned login name will depend on the authentication provider. It might be an Active Directory login, a forms authentication user name, or something custom.

function getCurrentUserName()
{
    var lists = new SPAPI_Lists('')
    var items = lists.getListItems(
    'User Information List',
    '',
    '<Query><Where><Eq><FieldRef Name="ID"/><Value Type="Counter">' + _spUserId + '</Value></Eq></Where></Query>',  // query
    '<ViewFields><FieldRef Name="Name"/></ViewFields>',
    1,  // rowLimit
    ''  // queryOptions
    );

    if (items.status == 200)
    {
        var rows = items.responseXML.getElementsByTagName('z:row');

        if (rows.length == 1)
        {
            return rows[0].getAttribute('ows_Name');
        }
        else
        {
            return null;
        }
    }
    else
    {
        return null;
    }
} 

// Test code
var userName = getCurrentUserName();

if (userName != null)
{
    alert(userName);
}

Update: 06 September 2008 - javascript API 1.0.1

I’ve now updated the javascript API to version 1.0.1. This now includes support for the user profile web service via the SPAPI_UserProfile.js library. The user profile service provides a number of mechanisms for viewing and updating user profiles. Of particular interest is the getUserProfileByName method which returns the user profile of a user based on their login name. An example packet is shown below:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <GetUserProfileByIndexResponse xmlns="http://microsoft.com/webservices/SharePointPortalServer/UserProfileService">
      <GetUserProfileByIndexResult>
        <NextValue>2</NextValue>
        <UserProfile>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>UserProfile_GUID</Name>
            <Privacy>Public</Privacy>
            <Values>
              <ValueData>
                <Value xmlns:q1="http://microsoft.com/wsdl/types/" xsi:type="q1:guid">35c7e6d2-89fe-4cc2-9dc6-1f0803d3778c</Value>
              </ValueData>
            </Values>
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>AccountName</Name>
            <Privacy>Public</Privacy>
            <Values>
              <ValueData>
                <Value xsi:type="xsd:string">GLASGOW\Administrator</Value>
              </ValueData>
            </Values>
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>FirstName</Name>
            <Privacy>Public</Privacy>
            <Values>
              <ValueData>
                <Value xsi:type="xsd:string">Darren</Value>
              </ValueData>
            </Values>
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>LastName</Name>
            <Privacy>Public</Privacy>
            <Values>
              <ValueData>
                <Value xsi:type="xsd:string">Johnstone</Value>
              </ValueData>
            </Values>
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>PreferredName</Name>
            <Privacy>Public</Privacy>
            <Values>
              <ValueData>
                <Value xsi:type="xsd:string">Darren Johnstone</Value>
              </ValueData>
            </Values>
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>WorkPhone</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>Office</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>Department</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>Title</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>Manager</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>AboutMe</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>PersonalSpace</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>PictureURL</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>UserName</Name>
            <Privacy>Public</Privacy>
            <Values>
              <ValueData>
                <Value xsi:type="xsd:string">Administrator</Value>
              </ValueData>
            </Values>
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>QuickLinks</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>WebSite</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>PublicSiteRedirect</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-Dotted-line</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-Peers</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-Responsibility</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-Skills</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-PastProjects</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-Interests</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-School</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-SipAddress</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-Birthday</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-MySiteUpgrade</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-DontSuggestList</Name>
            <Privacy>Private</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-ProxyAddresses</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-HireDate</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-LastColleagueAdded</Name>
            <Privacy>Private</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-OWAUrl</Name>
            <Privacy>Private</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-ResourceAccountName</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>SPS-MasterAccountName</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>Assistant</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>WorkEmail</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>CellPhone</Name>
            <Privacy>Contacts</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>Fax</Name>
            <Privacy>Public</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>HomePhone</Name>
            <Privacy>Contacts</Privacy>
            <Values />
          </PropertyData>
          <PropertyData>
            <IsPrivacyChanged>false</IsPrivacyChanged>
            <IsValueChanged>false</IsValueChanged>
            <Name>EmployeeID</Name>
            <Privacy>Private</Privacy>
            <Values />
          </PropertyData>
        </UserProfile>
        <Colleagues />
        <QuickLinks />
        <PinnedLinks />
        <Memberships>
          <MembershipData>
            <Source>SharePointSite</Source>
            <MemberGroup>
              <SourceInternal>8bb1220f-de8b-4771-ac3a-0551242cf2bd</SourceInternal>
              <SourceReference>873FA19B-402A-444E-AD9B-E61984DB7AA7</SourceReference>
            </MemberGroup>
            <Group>SharePoint Sites</Group>
            <DisplayName>Admin</DisplayName>
            <Privacy>Public</Privacy>
            <MailNickname>nickname</MailNickname>
            <Url></Url>
            <ID>2</ID>
            <MemberGroupID>215</MemberGroupID>
          </MembershipData>
        </Memberships>
      </GetUserProfileByIndexResult>
    </GetUserProfileByIndexResponse>
  </soap:Body>
</soap:Envelope>

This can be used to access other profile properties (such as their preferred name and employee ID) for the user (once their login name is known). The following code requires that SPAPI_Core.js and SPAPI_UserProfile.js be included.

function getUserProfile(accountName)
{
    var profile = new SPAPI_UserProfile('')
    var p = profile.getUserProfileByName(accountName);

    if (p.status == 200)
    {
        return p;
    }
    else
    {
        return null;
    }
}

// Test code
var profileData = getUserProfile(getCurrentUserName()); // Custom GetCurrentUserName function

if (profileData != null)
{
    var properties = profileData.responseXML.getElementsByTagName('PropertyData');
    var propertyValues = new Array();

    for (var i=0; i<properties.length; i++)
    {
        var propName = properties[i].getElementsByTagName('Name')[0].childNodes[0].nodeValue;
        propertyValues[propName] = properties[i].getElementsByTagName('Value');
    }

    alert(propertyValues['AccountName'][0].childNodes[0].nodeValue);
    alert(propertyValues['EmployeeID'][0].childNodes[0].nodeValue);
}

The javascript above uses our original function to get the user name. It then calls the getUserProfileByName method of the user profile service to get the user profile XML. The XML is then parsed to create a hash table of XML nodes keyed by the property name. Note that a property may have more than one value so the hash table stores arrays of these values.

So to get the user’s login name we use:

propertyValues['AccountName'][0].childNodes[0].nodeValue;

…and for the employee ID…

propertyValues['EmployeeID'][0].childNodes[0].nodeValue;

There are many more methods made available by the profile service- I’ll post some examples soon.