Get a feed of all user profiles 

Retrieve a feed that lists all of the people in your organization who have a profile in the Profiles application.

This method returns a feed of profiles as opposed to retrieving the Atom entry of a single profile. If you want to retrieve the Atom entry document for a single profiles, send a GET request to the web address specified in the href attribute of the <link> element with the rel="edit" attribute for the profile of interest. However, the entry document returned by that request contains the same information that is already available in this feed.

Table 1. Atom API request details

Resource Description
/admin/atom/profiles.do Retrieves all user profiles. The feed includes the fields (including their current values) associated with each profile.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 2. Input parameters

Parameter Description
email Internet email address. Returns all profiles that contain a matching email address.

Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:

adam_eventide%40garden.com

Note: Do not use this parameter if IBM Connections is configured to prevent email addresses from being displayed. It will return an error.
This parameter is ignored if the userid parameter is also specified.

key An ID generated by Profiles to identify a person.

A user's key value is contained in the element with a class attribute value of x-profile-key in the user's profile feed. You can access a user's feed by searching all profiles by name, which returns information you can then use to retrieve the person's feed.

ps Page size. Specifies the number of entries to return per page. Use the rel="next" link to retrieve additional pages.
uid An organizationally specific unique identifier for the user that typically comes from the source of the profiles data, such as the LDAP directory. A user's uid value is contained in the element with a class attribute value of uid in the user's profile feed.
userid Unique ID that represents a specific person. This value is specified in the <snx:userid> element.


Example

To retrieve all profiles, send the following HTTP request:

> GET /profiles/admin/atom/profiles.do HTTP/1.1
> Authorization: xxx
> Host: enterprise.example.com
> Accept: */*

The HTTP response would look as follows:

< HTTP/1.1 200 OK

The following content is returned by the server:

<feed 
 xmlns:app="http://www.w3.org/2007/app" 
 xmlns:fh="http://purl.org/syndication/history/1.0" 
 xmlns:thr="http://purl.org/syndication/thread/1.0" 
 xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
 xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" 
 xmlns="http://www.w3.org/2005/Atom">
  <id>tag:profiles.ibm.com,2006:feed</id> 
  <generator version="3.0" uri="http://www.ibm.com/xmlns/prod/sn">
   IBM Connections - Profiles
  </generator> 
  <title type="text">IBM Connections - Profiles</title> 
  <author>
    <name>IBM Connections - Profiles</name> 
  </author>
  <updated>2010-09-16T20:35:20.360Z</updated> 
  <opensearch:itemsPerPage>10</opensearch:itemsPerPage> 
  <link 
   href="https://enterprise.example.com/profiles/admin/atom/profiles.do&iterState=
    ewogICAibGFzdEtleSI6ICIwMGVmYWViYS05NGVkLTQwZjQtODUwZC03ZDM5NzNjM2YxMDEiLAogICAidmVyIjogIjEiCn0=" 
   rel="next" /> 
  <link 
   href="https://enterprise.example.com/profiles/admin/atom/profiles.do" 
   rel="self" 
   type="application/atom+xml" /> 
  <entry>
    <id>tag:profiles.ibm.com,2006:entry000431ad-7c44-406f-bdac-4bf54472a560</id> 
    <title type="text">Loretta Mahon</title> 
    <updated>2010-06-24T21:29:04.712Z</updated> 
    <category term="profile" scheme="http://www.ibm.com/xmlns/prod/sn/type" /> 
    <contributor>
      <name>Loretta Mahon</name> 
      <snx:userid>57017ac0-0101-102e-8b1e-f78755f7e0ed</snx:userid> 
      <email>lmahon@example.com</email> 
      <snx:userState>active</snx:userState> 
    </contributor>
    <link 
     href="https://enterprise.example.com/profiles/atom/profileEntry.do?
      key=000431ad-7c44-406f-bdac-4bf54472a560" 
     rel="self" 
     type="application/atom+xml" /> 
    <link 
     href="https://enterprise.example.com/profiles/html/profileView.do?
      key=000431ad-7c44-406f-bdac-4bf54472a560" 
     rel="related" 
     type="text/html" /> 
    <link 
     href="https://enterprise.example.com/profiles/photo.do?
      key=000431ad-7c44-406f-bdac-4bf54472a560&lastMod=1277414944712" 
     rel="http://www.ibm.com/xmlns/prod/sn/image" 
     type="image" /> 
    <link  
     href="https://enterprise.example.com/profiles/audio.do?
      key=000431ad-7c44-406f-bdac-4bf54472a560&lastMod=1277414944712" 
     rel="http://www.ibm.com/xmlns/prod/sn/pronunciation" 
     type="audio" /> 
    <summary type="text">Profile information for Loretta Mahon</summary> 
    <link 
     href="https://enterprise.example.com/profiles/admin/atom/profileEntry.do?
      key=000431ad-7c44-406f-bdac-4bf54472a560" 
     rel="edit" 
     type="application/atom+xml" /> 
    <content type="application/xml">
      <person xmlns="http://ns.opensocial.org/2008/opensocial">
        <com.ibm.snx_profiles.attrib>
          <entry>
            <key>com.ibm.snx_profiles.base.key</key> 
            <value>
              <type>text</type> 
              <data>000431ad-7c44-406f-bdac-4bf54472a560</data> 
            </value>
          </entry>
          <entry>
            <key>com.ibm.snx_profiles.base.distinguishedName</key> 
            <value>
              <type>text</type> 
              <data>uid=lmahon,cn=users,l=Groton,st=Massachusetts,c=US,ou=Enterprise,
                    o=Software Group,dc=example,dc=com
              </data> 
            </value>
          </entry>
          <entry>
            <key>com.ibm.snx_profiles.base.isManager</key> 
            <value>
              <type>text</type> 
              <data>N</data> 
            </value>
          </entry>
          <entry>
            <key>com.ibm.snx_profiles.base.preferredLanguage</key> 
            <value>
              <type>text</type> 
              <data /> 
           </value>
          </entry>
          <entry>
           <key>com.ibm.snx_profiles.base.telephoneNumber</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
          </entry>
          <entry>
           <key>com.ibm.snx_profiles.base.faxNumber</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
          </entry>
          <entry>
           <key>com.ibm.snx_profiles.base.countryCode</key> 
           <value>
             <type>text</type> 
             <data>us</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.workLocationCode</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.officeName</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.managerUid</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.surname</key> 
           <value>
             <type>text</type> 
             <data>Mahon</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.guid</key> 
           <value>
             <type>text</type> 
             <data>57017ac0-0101-102e-8b1e-f78755f7e0ed</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.email</key> 
           <value>
             <type>text</type> 
             <data>lmahon@example.com</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.orgId</key> 
           <value>
             <type>text</type> 
             <data>LR&D</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.sourceUrl</key> 
           <value>
             <type>text</type> 
             <data>ldap://tds62ldap.swg.usma.ibm.com:389</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.givenName</key> 
           <value>
             <type>text</type> 
             <data>Loretta</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.mobileNumber</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.employeeTypeCode</key> 
           <value>
             <type>text</type> 
             <data>regular</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.employeeNumber</key> 
           <value>
             <type>text</type> 
             <data>28</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.uid</key> 
           <value>
             <type>text</type> 
             <data>lmahon</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.secretaryUid</key> 
           <value>
             <type>text</type> 
             <data /> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.base.displayName</key> 
           <value>
             <type>text</type> 
             <data>Loretta Mahon</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.sys.usrState</key> 
           <value>
             <type>text</type> 
             <data>active</data> 
           </value>
         </entry>
         <entry>
           <key>com.ibm.snx_profiles.sys.enabledFeatures</key> 
           <value>
             <type>text</type> 
             <data>profile.organization, profile.connection, profile.status, 
                   profile.extension, profile.colleague, profile.tag, profile.board, 
                   profile.peopleManaged, profile.link, profile.pronunciation, 
                   profile.profile, profile.following, profile.photo, profile.reportTo
             </data> 
           </value>
         </entry>
       </com.ibm.snx_profiles.attrib>
      </person>
    </content>
  </entry>
</feed>


Parent topic

Getting Profiles Administration API feeds


   

 

});