The CollabNet service

The CollabNet service must always be accessed first, to authenticate the user and return a sessionId. The sessionId is a necessary parameter that must be passed to the methods in the other services.

The CollabNet service also handles retrieving and managing lists of users and projects, which are often the first steps that an application must perform.

Some examples of activities that are managed by the CollabNet service are:

• Returning a list of all CollabNet TeamForge users or projects.
• Creating a new user.
• Providing a user with a list of all projects of which he or she is a member.
• Creating an association between two items.
• Managing user groups and their membership.

User groups, added in CollabNet TeamForge Enterprise Edition 4.4 Service Pack 1, simplify permission management for projects. User groups are site‐wide sets of users, managed by site administrators. Project administrators can add user groups to roles, just like they can add individual project members.

After authenticating the user through the CollabNet service, you can then access all of the other services that manage the items and activities associated with the other CollabNet TeamForge applications, such as trackers, tasks, documents, or file releases. A new “Anonymous Login” capability introduced in CollabNet TeamForge Enterprise Edition 4.4 adds the ability to log in with the privileges and access rights of a non‐authenticated user.

Detailed information

For a complete description of each method, including its parameter definitions and SOAP faults, see the JavaDoc for the cemain service.

WSDL

The WSDL for this service is available on your TeamForge site at https://<mysite.com>/ce-soap50/services/CollabNet?wsdl. For example, here's the copy on the CollabNet web site: http://ctf.open.collab.net/ce-soap50/services/CollabNet?wsdl.

New and changed methods

CollabNet TeamForge introduces the following new and changed methods in the CollabNet service.

Method	Changes	Notes
getGroupList2()	New in 5.1	Updated version of getGroupList(), which returns, in Group2SoapList, the group ID for each returned group.
getGroupList()	Deprecated in 5.1	Use getGroupList() instead.
getUserGroupList()	modified in 5.2	Starting in 5.2, a non-site-admin can call this method to see his or her own user group memberships. You must still be a site admin to see another user's groups.
loginAnonymous()	modified in 5.0	The functionality is unaffected, but the site configuration parameter used to set the shared secret has changed; see the javadoc comment. This also affects previous versions of the soap API.