API Changes

The output parameter <number> in the searchuser API call, and the getlicensedata API call has been deprecated and will be removed in a future version. Use the license key number is now returned in the <licensekey> tag.

Registration Server 4.0.0

  • Added API calls to support group functionality: “creategroup”, “deletegroup”, “inviteusertogroup”, “removeuserfromgroup”, “setgrouplicense”, “removegrouplicense”, “setgroupdepot”, “removegroupdepot”, “userjoinedgroup”, “setgroupclientsettings”, and “getgroupdata”.
  • A number of API calls now also return group related information: “loginuser”, “searchuser”, “getuserdata”t, “getlicensedata”, “getdefaultdepotdata”. The calls: “loginuser”, “getuserdata” and “getlicensedata” return group related information by default. Set the input tag: <includegroup> to false in order to exclude the group information. The calls “searchuser” and “getdefaultdepotdata” do not include group related data by default. In this case you must explicitly set <includegroup> to true to receive this information.
  • When information about depots (<depot> tag) is returned, there are now 3 new tags: <iscloud>, <isaccount>` and ``<isgroup> included. <iscloud> is set to true if this this depot is the user’s selected cloud storage.``<isaccount>`` is set to true if the depot is set on the account level. <isgroup> is set to true if the depot belongs to the user’s group.
  • When information about licenses (<license> tag) the <isgroup> tag is now included. This tag is set to true if the license belongs to the user’s group.
  • In the “registeruser” API call you can now specify a <groupreference> in order to add the new user to a group immediately.

Registration Server 3.6.3

  • The “activatelicense” and “deactivatelicense” API calls no longer return error -30210 (REGSERVER-1177). If the license is already in the state set, then the call is ignored.
  • Specifying a user in the “removeuserfromlicense” API call is now optional. If specified, then the user must be the owner of the license or a “Unknown license” error will be returned (REGSERVER-1178).
  • Remove the API version number (1.0.006, 1.0.007, etc.) The Registration Server version number is now used to determine when API changes have been made. All API calls now return the <regversion> tag which contains the version number of the server (REGSERVER-1173).
  • “getdefaultlicense” API call: removed the exception that returned the features of the license in use if it was higher than the features of the default license.
  • Added a <licensereference> tag to the input parameters of the “loginuser” call. This tag is used if a default license is created for the user. This is only done if the user has no default license, and the Provider setting DEFAULT_LICENSEKEY is empty.
  • The new reference should now be specified using the <newlicensereference> tag in the “setlicensereference” API call.
  • Added an optional <password> tag to the “removeuser” API call input data.
  • The <featurevalue> tag value may now also be specified as an integer in the “createlicense”, “createlicensewithoutuser”, “upgradelicense” and “downgradelicense” API calls.
  • Added the <licensereference> tag to the <license> block in reply of the “getusedlicense” API call.
  • Added the <licensereference> tag to the <user> and the <device> blocks in reply of the “searchuser” API call.

Registration Server 3.6.2

  • The <licensekey> tag must be used in place of the <licensenumber> tag in the API. <licensenumber> has been deprecated and will no longer be accepted in Registration Server 4.0.

  • Added a <licensekey> tag and a <licensereference> tag the input parameters of the “registeruser” API call. One of these tags can be used to specify a license to assign to the newly created user.

  • Removed the Provider setting API_CREATE_DEFAULT_LICENSE (REGSERVER-1163). A default license is now always created when a user is created by the API, or during TeamDrive Client registration.

    Since the Registration Server version 3.6 now allows a license to be assigned to a user, even when the user has no devices, the default license is also assigned to the user on creation via the API. If the license already has the maximum number of users, the new user will not be created.

Registration Server 3.6.0

  • Added notifications: the Registration Server can be configured to send a notification when a change is made to a user. To do this, the Provider setting API_SEND_NOTIFICATIONS must be set to True, and the setting API_NOTIFICATION_URL must be set to the URL that will receive the notification (TRUS-136).

  • The tag <webportal> has been added to the API functions: “searchuser”, “loginuser”, “getuserdata” and “registeruser”. This tag indicates whether the user is permitted to access a Web Portal.

    Note that if the Provider setting ALLOW_WEB_PORTAL_ACCESS is set to permit or deny, the the value returned in the <webportal> tag will reflect this setting, not the value of the user’s Web Portal Access capability bit.

    When calling “setcapability” the <capability> tag may be set to the value “webportal”, in order to set Web Portal Access capability bit.

  • The “searchuser” API call now accepts the input tags <distributor>, <reference> and <authid>, which are used to search for users with specific external reference or external authentication ID. These tags can be used in addition to or in place of other search tags. The ‘*’ search wildcard is not recognised which searching for these values.

    When searching by <reference> and <authid> the <distributor> will automatically be added to the search conditions (normally this is only done when you set <onlyownusers>true</onlyownusers>).

    Note that setting <distributor> to a value other than your own Provider code is only permitted if you are the “Default Provider”. Web Portals working on the behalf of a Provider may also set the <distributor> tag accordingly.

  • The “registeruser” API call now returns a <userdata> block with the complete details of the user. The <username> outside of the <userdata> block has been deprecated and will be removed in version 4.0.

  • Added the Provider setting EXT_LICENCE_REF_UNIQUE, default True. If set to False duplicate license references are allowed (REGSERVER-1130).

  • Removed the Provider setting CLIENT_DEFAULTLICREF. The license reference must now be provided as parameter to the API call (REGSERVER-1130).

  • The <licensereference> tag can now be used to specify the license in place of the <licensenumber> tag (REGSERVER-808). Note that the license reference must be unique for each Provider, if EXT_LICENCE_REF_UNIQUE is set to True (which is the default).

  • Added the “sendtemplatemail” API call. This call can be used to sent standard template based emails to user, Providers or some other recipient (REGSERVER-1103).

  • Added lookup of an Email on TDNS to the “tdnslookup” call. The result is a list of Registration Servers (REGSERVER-1113).

Registration Server 3.5.10

  • The <licensekey> tag should be uses in place of <licensenumber> in calls that accept this as an input paramater. <licensenumber> will still be accepted, but has been deprecated and will be removed in Registration Server version 4.0.
  • The “searchuser” API function returns <licensekey> instead of <licensenumber> (as added in 3.5.9).
  • The API calls: “searchuser”, “getuserdata”, “getlicensedata”, “getdefaultlicense”, “getusedlicense”, “createlicense” and “createlicensewithoutuser” now return the tag <licensekey> in addition to <number>. The contents is the same. The <number> tag is deprecated and will be removed in a future version.

Registration Server 3.5.9

  • Added <showlicense>true/false</showlicense> tag to the “searchuser” API call. When set to true, license information is returned in the result.

    This includes <licensenumber>, <featurevalue> and <licensestatus> tags in the <user> tag which indicate the current license set for the user, and the features of the license. A <licenselist> tag is also returned with a list of the licenses that belong to the user.

    ‘’<licensereference>`` was added to the “searchuser” API input parameters and is used if the function creates a default license (see searchuser for details).

Registration Server 3.5.5

  • The order of the XML tags in the API documentation now matches the actually order of tags returned by the server. Some tags that were ommitted have been added (REGSERVER-949).

Registration Server 3.5.3

  • The “registeruser” API call will now always returns a <username> tag as well as the standard <intresult> tag on success. For example:


    This is useful if the caller wishes to know the magic username generated by the server (REGSERVER-838).

  • If a user is created via the API, or by CSV import, then it may not be known which language the user will use. In this case the language may be set to “-”. The “-” will be ignored by the TeamDrive Client. API calls will return the default language in this case (REGSERVER-1097)

Registration Server 3.5.2

  • Changed API function “confirmuserdelete”: allow using the call without sending the user password (REGSERVER-1089)
  • Fixed API function “setdistributor” to handle more than one depot in case of switchdepot = true (REGSERVER-1087)

Registration Server 3.5.1

  • Added API call “changelicensepassword” (REGSERVER-1075) and use bcrypt for license password encryption (REGSERVER-965)

Registration Server 3.5.0

Numerous enhancements and additions to the Registration Server API, to provide more functionality for integrating with external applications (e.g. web shops).

  • Added API call deletelicense, which marks a license as “deleted” REGSERVER-883). The API call cancellicense will set a license to “disabled” instead of “deleted” now.
  • Added API call tdnslookup, which performs a lookup at the TeamDrive Name Service (TDNS) to find a given user’s Registration Server.
  • Added new functions: deactivateuser, disableuser, enableuser, updated API reference documentation accordingly.
  • Added new function setdepartment to set the department reference for a user.