Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Remote setup API reference
Cisco TMS Extension Booking API Programming Reference Guide (13.0.1)
Page 12 of 33
TMS user object
The Cisco TMS user object contains information about Cisco TMS users. Use this object to access
information about users in Cisco TMS. The XML document below describes the User object. Following the
XML is a description of the elements and what information each element it contains.
information about users in Cisco TMS. The XML document below describes the User object. Following the
XML is a description of the elements and what information each element it contains.
<User>
<DisplayName>
string
</DisplayName>
<EmailAddress>
string
</EmailAddress>
<FirstName>
string
</FirstName>
<LastName>
string
</LastName>
<UserName>
string
</UserName>
<IsHiddenUser>
boolean
</IsHiddenUser>
<TimeZone>
<TimezoneName>
string
</TimezoneName>
<StartTimeDTS>
string
</StartTimeDTS>
<EndTimeDTS>
string
</EndTimeDTS>
<GMTOffset>
string
</GMTOffset>
</TimeZone>
</User>
User
Displayname
The display name of the user.
EmailAddress
The e-mail address of the user.
FirstName
The first name of the user.
LastName
The last name of the user.
UserName
The Windows login name of the user.
IsHiddenUser
Boolean value used to represent if this is a normal user (True), or a service account
(False) that normally should not be displayed in a list of users.
(False) that normally should not be displayed in a list of users.
TimeZone
The time zone where the user is located. Uses the same TimeZone object as
TMSSystem.
TMSSystem.
Functions/Methods
DisableConferenceAPIUser
This function is used to disable a ConferenceAPI user. E-mail notifications for the user are disabled, and
the user is removed from all groups in Cisco TMS except the Users group (this is done to keep references
valid.) Executing this method requires Cisco TMS Site Administrator privileges.
the user is removed from all groups in Cisco TMS except the Users group (this is done to keep references
valid.) Executing this method requires Cisco TMS Site Administrator privileges.
This function is typically used during uninstall procedures.
Input
userName
The full user name in NT4 style (domain\username) of the user to delete.
GenerateConferenceAPIUser
This function generates a Cisco TMS Booking API account in the default user container on the Cisco TMS
server, including registering the user in Cisco TMS (as a hidden user not in normal user lists). The user is
server, including registering the user in Cisco TMS (as a hidden user not in normal user lists). The user is