GetUser

Retrieves detailed information about the specified user.

Element Parent Definition Type Default
siteName <securityContext> The first string in your Webex site URL, provided by Webex. For example: siteName is “acme” for the site http://acme.webex.com. string
webExID <securityContext> A WebEx-maintained reference to the WebEx user ID for the meeting host. string
password <securityContext> The password associated with the webExID password
firstName User's first name. String
lastName User's last name. String
title User's title
categoryId A reference to the office category for the user’s office. Optional. A reference to another service or zero. 0
description A description of the user’s virtual office. Optional. Maximum of 4000 characters. ""
company The user’s company name. Optional. Maximum of 128 characters.
webExId A reference to the WebEx user account for the meeting participant. Optional. String. Maximum of 64 characters.
addressType <address> Determines whether the meeting participant is a personal contact of the meeting host or is a site-wide (global) contact. Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered WebEx user. PERSONAL
country <address> The country for the user. Optional. Maximum of 64 characters. ""
phone <phones> Indicates the phone number for the user. Optional. Valid values are TRUE and FALSE. FALSE
mobilePhone <phones> The attendee’s mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234" Optional. Maximum of 64 characters. ""
fax <phones> The contact’s fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Optional. Maximum of 64 characters. ""
pager <phones> The user’s Office Profile pager number. Optional. Maximum of 64 characters. ""
PIN <phones> Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees string 0..1
email The email address of the user. Notifications of messages left by office visitors will be sent to this address. Must be a valid email address. Not applicable for all other actions. Maximum of 64 characters.
password Maximum of 60 characters. User password. A user password will be validated against the password security options if enabled in the Site Administration tool. Requires strict passwords for user account, does not allow cyclic passwords, does not allow site administrator to input password for other hosts. If any security rules is violated, an exception then occurs.
passwordHint The question for which passwordHintAnswer is an answer for the user. Optional. Maximum of 128 characters. ""
passwordHintAnswer The answer to the passwordHint for the user. If the user can answer the challenge correctly then he can be instantly presented with the password or it can be sent to him in an email message. Optional. Maximum of 32 characters. ""
personalUrl The user’s website. Optional. Maximum of 128 characters. ""
expirationDate The date and time after which a meeting that was set to automatically repeat stops repeating; leave empty to let the meeting repeat forever. MM/DD/YYYY HH:MM:SS. Optional.
prodAnnounce <commOptions> Indicates product/service announcements. Optional. Valid values are TRUE and FALSE. FALSE
trainingInfo <commOptions> Indicates training information. Optional. Valid values are TRUE and FALSE. FALSE
electronicInfo <commOptions> Indicates electronic information. Optional. Valid values are TRUE and FALSE. FALSE
promos <commOptions> Indicates promotions and special offers. Optional. Valid values are TRUE and FALSE. FALSE
press <commOptions> Indicates press releases. Optional. Valid values are TRUE and FALSE. FALSE
email <commOptions> Indicates email. Optional. Valid values are TRUE and FALSE. FALSE
fax <commOptions> Indicates fax. Optional. Valid values are TRUE and FALSE. FALSE
phone <commOptions> Indicates phone. Optional. Valid values are TRUE and FALSE. FALSE
mail <commOptions> Indicates mail. Optional. Valid values are TRUE and FALSE. FALSE
meetingType <meetingTypes> The meeting type ID. Optional. Integer.
firstNameVisible <options> Toggles the first name of the user. Optional. Valid values are TRUE and FALSE. FALSE
lastNameVisible <options> Toggles the last name of the user. Optional. Valid values are TRUE and FALSE. FALSE
addressVisible <options> Toggles the address for the user. Optional. Valid values are TRUE and FALSE. FALSE
workPhoneVisible <options> Toggles the work phone number for the user. Optional. Valid values are TRUE and FALSE. FALSE
cellPhoneVisible <options> Toggles the cell phone number for the user. Optional. Valid values are TRUE and FALSE. FALSE
pagerVisible <options> Toggles the pager number for the user. Optional. Valid values are TRUE and FALSE. FALSE
faxVisible <options> Toggles the fax number for the user. Optional. Valid values are TRUE and FALSE. FALSE
officeUrlVisible <options> Toggles the URL for the user office. Optional. Valid values are TRUE and FALSE. FALSE
pictureVisible <options> Toggles the pictures of the user office. Optional. Valid values are TRUE and FALSE. FALSE
notifyOnNewMessage <options> Toggles the feature of notification upon new messages’ arrival. Optional. Valid values are TRUE and FALSE. FALSE
notifyOnMeeting <options> Toggles the feature of notification upon the meeting’s start time. Optional. Valid values are TRUE and FALSE. FALSE
followMeEnable <options> Toggles the follow-me wizard for the meeting. Optional. Valid values are TRUE and FALSE. FALSE
emailVisible <options> Toggles the feature of displaying email addresses. Optional. Valid values are TRUE and FALSE. FALSE
listInCategory <options> Toggles the feature of listing in categories. Optional. Valid values are TRUE and FALSE. FALSE
titleVisible <options> Toggles the feature of displaying the user’s title. Optional. Valid values are TRUE and FALSE. FALSE
folderRead <options> Toggles the read accessibility of the folder. Optional. Valid values are TRUE and FALSE. FALSE
folderWrite <options> Toggles the write accessibility of the folder. Optional. Valid values are TRUE and FALSE. FALSE
messageVisible <options> Toggles the feature of displaying messages. Optional. Valid values are TRUE and FALSE. FALSE
iconSelect1 <options> Toggles the feature of selecting icons. Optional. Valid values are TRUE and FALSE. FALSE
iconSelect2 <options> Toggles the feature of selecting icons. Optional. Valid values are TRUE and FALSE. FALSE
acceptLinkRequest <options> Toggles the feature of accepting link requests. Optional. Valid values are TRUE and FALSE. FALSE
holdOnLinkRequest <options> Toggles the feature of holding on link requests. Optional. Valid values are TRUE and FALSE. FALSE
notifyOnLinkRequest <options> Toggles the feature of notifying on link request. Optional. Valid values are TRUE and FALSE. FALSE
supportVideo <options> Toggles the feature of supporting video for the meeting. Optional. Valid values are TRUE and FALSE. FALSE
supportApp <options> Toggles the feature of supporting applications. Optional. Valid values are TRUE and FALSE. FALSE
supportFileShare <options> Toggles the feature of supporting file sharing. Optional. Valid values are TRUE and FALSE. FALSE
supportDesktopShare <options> Toggles the feature of supporting desktop sharing. Optional. Valid values are TRUE and FALSE. FALSE
supportMeetingRecord <options> Toggles the feature of supporting meeting recording. Optional. Valid values are TRUE and FALSE. FALSE
supportAppshareRemote <options> Toggles the feature of supporting remote application sharing. Optional. Valid values are TRUE and FALSE. FALSE
supportWebTourRemote <options> Toggles the feature of supporting remote web tour. Optional. Valid values are TRUE and FALSE. FALSE
supportDesktopShareRemote <options> Indicates whether remote desktop sharing is supported for meetings of this type. Optional. Valid values are TRUE and FALSE. FALSE
subscriptionOffice <options> Toggles the feature of subscription office. Optional. Valid values are TRUE and FALSE. FALSE
workPhoneCallback <options> Toggles the work phone number for call back for the user. (Office phone number.) Optional. Valid values are TRUE and FALSE. FALSE
cellPhoneCallback <options> Toggles the cell phone number for call back for the user. Optional. Valid values are TRUE and FALSE. FALSE
faxCallback <options> Toggles the fax number for call back for the user. (Alternate number 2.) Optional. Valid values are TRUE and FALSE. FALSE
pagerCallback <options> Toggles the pager number for call backfor the user. (Alternate number 1.) Optional. Valid values are TRUE and FALSE. FALSE
timeZoneID Determines the time zone for the geographic location of the meeting. Optional. An integer ranging from 0 to 61.
timeZone Determines the time zone for the geographic location of the user or user’s office. Optional. String indicating the time and country code. “GMT-08:00, Pacific Time (San Jose)”
timeZoneWithDST A timezone description which is adjusted by DST, e.g., "GMT-7:00, Pacific (San Francisco)" Optional. String.
service The type of service that the user has. Optional. Valid values are FREE_OFFICE, STANDARD_OFFICE, and PRO_OFFICE. FREE_OFFICE
host <privilege> Indicates whether the user can be a host for the meeting. FALSE. Optional. Valid values are TRUE and FALSE.
teleConfCallOut <privilege> Indicates whether conference calling out of meetings is supported for the user. Optional. Valid values are TRUE and FALSE. Defaults to site settings.
teleConfCallOutInternational <privilege> Indicates whether international calling out of meetings is supported for the meeting. Optional. Valid values are TRUE and FALSE. Defaults to site setting.
teleConfCallIn <privilege> Indicates whether conference calling into meetings is supported for the meeting. Optional. Valid values are TRUE and FALSE. Defaults to site setting.
teleConfTollFreeCallIn <privilege> Indicates whether toll-free calling into meetings is supported for the user. Optional. Valid values are TRUE and FALSE. Defaults to site setting.
siteAdmin <privilege> Indicates whether the user has administrative privilege for the meeting. Optional. Valid values are TRUE and FALSE. FALSE
voiceOverIp <privilege> Indicates voice communications over Internet protocols is supported for the meeting. Optional. Valid values are TRUE and FALSE. Defaults to site setting.
roSiteAdmin <privilege> Indicates whether the current user is a site administrator with view only privilege. Optional. Valid values are TRUE and FALSE. FALSE
labAdmin <privilege> If TRUE, then user has access to the Hands-on Lab administration pages. This element is effective only when Hands-on Lab is enabled. Optional. Valid values are TRUE and FALSE. Defaults to site setting.
otherTelephony <privilege> Specifies whether a user account has the privilege to schedule a session with “other teleconferencing” feature enabled. Optional. Valid values are TRUE and FALSE. Default value depends on the configurations on the user’s website.
teleConfCallInInternational <privilege> Allows a user to access WebEx teleconferencing via international local call-in telephone numbers. Defaults to site setting. Note This option applies when the site has both Call-in teleconferencing and Allow access to teleconference via international local call-in numbers enabled in the Site Administration tool. Optional. Valid values are TRUE and FALSE. Default value depends on the configurations on the user’s website.
attendeeOnly <privilege> If TRUE, then indicates that the user’s role is attendee only. If set to TRUE, then the host, the siteAdmin, the labAdmin and the roSiteAdmin elements should be FALSE. Optional. Valid values are TRUE and FALSE. FALSE
recordingEditor <privilege> Indicates whether a user has the privilege to download WebEx Recording Editor from My WebEx > Support. Note In the Site Administration tool, Recording Editor must be enabled for a host. Otherwise, setting recordingEditor to TRUE will throw an exception. Optional. Valid values are TRUE and FALSE. FALSE
meetingAssist <privilege> Enables Meeting Assist. Optional. Valid values are TRUE and FALSE.
isEnableCET <privilege> Enable/disable Collaboration Meeting Room (Cloud Enabled Telepresence) for the user. Optional. Valid values are TRUE and FALSE. FALSE
isEnablePMR <privilege> Enable/disable Personal Room for new user. Optional. Valid values are TRUE and FALSE. FALSE
teleCLIAuthEnabled <privilege> Allow/disallow user to have call-in CLI authentication Optional. Valid values are TRUE and FALSE. FALSE
teleCLIPINEnabled <privilege> Whether to require PIN in call-in CLI authentication if teleCLIAuthEnabled is checked. Optional. Valid values are TRUE and FALSE. FALSE
language Sets the preferred language for the user. Optional. String.
locale Holds user locale information. Optional. String.
active Determines whether the user account has been staged for use. The CreateUser/SetUser command will return an exceededSiteHostLimit error if you set a user's active=ACTIVATED parameter so that the WebEx sites' host limit is exceeded. Optional. Valid values are ACTIVATED, REQUEST_TO_ACTIVATE, or DEACTIVATED. ACTIVATED
countryAlias <defaultCallIn> / <defaultGlobalCallInNum> Holds the country’s alias. Required. String.
phoneNumber <defaultCallIn> / <defaultGlobalCallInNum> Holds the global phone number. Required. String.
tollFree <defaultCallIn> / <defaultGlobalCallInNum> Specifies whether toll-free call-in is available. Optional. Valid values are TRUE and FALSE.
meetingCenter <supportedServices> If TRUE, enables Webex Meetings service for the user. Optional. Valid values are TRUE and FALSE.
trainingCenter <supportedServices> If TRUE, enables Webex Training service for the user. Optional. Valid values are TRUE and FALSE.
supportCenter <supportedServices> If TRUE, enables Webex Support service for the user. Optional. Valid values are TRUE and FALSE
eventCenter <supportedServices> If TRUE, enables Webex Events service for the user. Optional. Valid values are TRUE and FALSE.
salesCenter <supportedServices> Enables the Sales Center service (if available on the site) for the user. Optional. Valid values are TRUE and FALSE.
isMyWebExPro <myWebEx> If TRUE, then user has access to additional My WebEx Pro features which usually includes My Reports, Access Anywhere, and Personal Meetings Page. If TRUE, and Webex super administrator has limited the number of My Webex Pro hosts, then the number of existing My WebEx hosts can’t exceed the max number set by the super administrator; otherwise, a NoWebExProLicensesAvailable error occurs. Optional. Valid values are TRUE and FALSE.
myContact <myWebEx> Enables the My WebEx, My Contacts feature for the user. Optional. Valid values are TRUE and FALSE.
myProfile <myWebEx> Enables the My WebEx, My Profile feature for the user. Optional. Valid values are TRUE and FALSE.
myMeetings <myWebEx> Enables the My WebEx, My Meetings feature for the user. Optional. Valid values are TRUE and FALSE.
myFolders <myWebEx> Enables the My WebEx, My Folders feature for the user. Optional. Valid values are TRUE and FALSE.
trainingRecordings <myWebEx> Enables the My WebEx, My Files: Training Recordings feature for the user. Optional. Valid values are TRUE and FALSE.
recordedEvents <myWebEx> Enables the My WebEx, My Files: Recorded Events feature for the user. Optional. Valid values are TRUE and FALSE.
totalStorageSize <myWebEx> Default My WebEx file storage size for the user. Note The logic of this element is as follows:  If the totalStorageSize value exceeds the Total storage size set for each user on the site, then the user’s Additional storage field will be set to the difference. (The Total storage size and Additional storage per user are fields in the Site Administration tool.)  If the site strictly limits the Additional storage for this site and the sum of this user and other user’s Additional storage values exceeds the site limit, then exceptionID=030016 is returned. For details, see “Exception Messages in Response Documents”. (The Additional storage for this site value is defined in the Super Administration Tool.) Optional. Integer.
myReports <myWebEx> Enables the My WebEx, My Reports feature for the user. Optional. Valid values are TRUE and FALSE.
myComputer <myWebEx> Enables the My WebEx, Access Anywhere feature and sets the number of Access Anywhere computers for the user. Setting this value to 0 disables Access Anywhere. Note The logic of this element is as follows:  If the myComputer value exceeds the Access Anywhere # of computers set for each user on the site then the user's Additional computers field will be set to the difference. The Access Anywhere # of computers and Additional computers per user are fields in the Site Administration tool.  If the site strictly limits the Additional number of Access Anywhere Computers for this site and the sum of this user and other user's Additional computers exceeds the limit then exceptionID=030017 is returned. For details, see “Exception Messages in Response Documents”. The Additional number of Access Anywhere Computers for this site value is defined in the Super Administration tool. Optional. Integer.
personalMeetingRoom <myWebEx> Enables the My WebEx, Personal Meetings Page feature for the user. Optional. Valid values are TRUE and FALSE.
myPartnerLinks <myWebEx> Indicates whether the partner links for a host are displayed in My WebEx. Optional. Valid values are TRUE and FALSE. FALSE
myWorkspaces <myWebEx> Defines whether or not My Workspaces is enabled for WebOffice integration. Optional. Valid values are TRUE and FALSE.
additionalRecordingStorage <myWebEx> Additional My Webex file storage size for the user. See the notes for totalStorageSize. Optional. Integer.
subscriberAccessCode <personalTeleconf> / <account> The teleconferencing subscriber access code supplied by the telephony service provider. Optional. String.
participantFullAccessCode <personalTeleconf> / <account> Indicates the access code for attendees who have full speaking privileges during a teleconference-only session. Required. String.
participantLimitedAccessCode <personalTeleconf> / <account> Indicates the access code for attendees who have limited speaking privileges during a teleconference-only session. Required. String.
accountIndex <personalTeleconf> / <account> Specifies the personal telephony account. Optional. Integer.
defaultFlag <personalTeleconf> / <account> Determines if the account is to be used as the default account. Optional. Valid values are TRUE and FALSE. FALSE
joinBeforeHost <personalTeleconf> / <account> Indicates whether "PCN Join Before Host" is enabled for the user. The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support the "PCN Join Before Host" feature: Optional. Valid values are TRUE and FALSE. FALSE
title <personalMeetingRoom> The user’s title. Optional. Maximum of 128 characters. ""
personalMeetingRoomURL <personalMeetingRoom> The user's Personal Room URL in the format of username@sitename.webex.com. String.
accessCode <personalMeetingRoom> The access code for a third party teleconference. Optional. String. Maximum of 32 characters.
hostPIN <personalMeetingRoom> The PIN for hosting meetings. Integer. Four digits.
applyPMRForInstantMeeting <personalMeetingRoom>
PMRAutoLock <personalMeetingRoom>
PMRAutoLockWaitTime <personalMeetingRoom>
mode <personalMeetingRoom> / <PRNotifications>
PMRAlternateHost <personalMeetingRoom> Indicates whether or not this user can have an alternate host. Optional. Valid values are TRUE and FALSE.
allowAnyoneHostMyPMR <personalMeetingRoom> / <alternateHost> Indicates whether or not any registered user in the meeting can host this user's Personal Room. Optional. Valid values are TRUE and FALSE.
defaultSessionType <sessionOptions> Session info of a Default session type. Optional. Integer.
defaultServiceType <sessionOptions> Service info of a Default session type. Optional. com:serviceType Type.
autoDeleteAfterMeetingEnd <sessionOptions> Automatically deletes the meeting from calender after this user's meeting ends. Optional. Valid values are TRUE and FALSE.
displayQuickStartHost <sessionOptions> Determines whether or not to show QuickStart to the Host and the Presenter. Optional. Valid values are TRUE and FALSE.
displayQuickStartAttendees <sessionOptions> Determines whether or not to show QuickStart to the Attendees. Optional. Valid values are TRUE and FALSE.
enable <supportCenter> / <serviceDesk> Enables Service Desk integration for user in Support Center. Optional. Valid values are TRUE and FALSE. FALSE
forceChangePassword <security> Determines if a user is forced to change their password on their next login. Is set to TRUE if resetPassword is set to TRUE. Optional. Valid values are TRUE and FALSE. FALSE
resetPassword <security> Resets the user’s password to a random string and notifies the user of the change. Automatically sets forceChangePassword to TRUE. Optional. Valid values are TRUE and FALSE. FALSE
lockAccount <security> Prevents a user from being able to login. Optional. Valid values are TRUE and FALSE.
languageID The ID of a language in the database. Optional. Long.
isAgent <webACDPrefs> Determines if a user is considered an agent. Optional. Valid values are TRUE and FALSE.
isMgr <webACDPrefs> Determines if a user is considered a manager. Optional. Valid values are TRUE and FALSE.
numAgentSessions <webACDPrefs> The number of agent sessions allowed. Integer.
agentMonitorAllRSQueues <webACDPrefs> Optional. Valid values are TRUE and FALSE.
managerMonitorAllRSQueues <webACDPrefs> Optional. Valid values are TRUE and FALSE.
monitorAllRSAgents <webACDPrefs> Optional. Valid values are TRUE and FALSE.
sharingView <remoteSupport> Contains the sharing view. Optional. Enum {FS_SCALE, FS, WIN, WIN_SCALE}
sharingColor <remoteSupport> Contains the sharing color. Optional. Enum {256, 16BIT}
enforce <remoteSupport> / <recording> Determines whether or not to enforce automatic recording. Required. Valid values are TRUE and FALSE.
enable <remoteSupport> / <autoRequest> Determines if the request is enabled when a session begins. Required. Valid values are TRUE and FALSE.
type <remoteSupport> / <defaultClient> Specifies the recording type. Optional. Enum {NBR, LOCAL}
singleSessClient <remoteSupport> / <defaultClient> Determines the single session client console type. Optional, Enum {NEW_CONSL,OLD_CONSL}
optimizeAttendeeBandwidthUsage <eventCenter> Indicates whether or not to optimize this user's bandwidth usage. Optional. Valid values are TRUE and FALSE.

Note: To enhance Personal Conference security, the XML API supports a user telephone Personal Identification Number (PIN), which is used to add security to Personal Conference Number audio.

The PIN element is available in the createUser, setUser, and getUser operations:

Element Parent Definition Type Default
`PIN <phones> Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees string 0..1

The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support PCN Join Before Host:

Element Parent Definition Type Default
joinBeforeHost <personalTeleconf> Indicates if PCN Join Before Host is enabled for the user boolean 0..1 FALSE

The PIN can be set through the XML API by using CreateUser/SetUser. You can use the GetUser operation to retrieve the host's PIN.

When using CreateUser/SetUser to specify the PIN, the XML API will check to see if the value provided is a valid PIN. Single number values and simple sequences, like 1111 or 1234 are not allowed. If value is not a valid PIN, the XML API throws the exception: WBXValidationException
(ID=999999, "Not a valid PIN! PIN must be 4-digit number and not allow PIN to be Single number values or simple sequences, like 1111 or 1234.") "Not a valid PIN".

The CreateUser/SetUser operations allow only a siteadmin to specify <personalTeleconf>``<joinBeforeHost> for the host. This option can only be specified on the SiteAdmin page. The host is not allowed to change the setting. If this rule is violated, the XML API will throw the exception: NoPrivilegeException (ID = 000001, "Access denied, additional privileges are required").

If the deprecated element structure <personalTeleconf>``<account>``<joinBeforeHost> is used to set a value through CreateUser/SetUser requests, this input value will be ignored. Only the value of the element <personalTeleconf>``<joinBeforeHost> should be used.

The XML API GetUser response will still return <personalTeleconf>``<account>``<joinBeforeHost>, but the value will be identical to the value of the new element <personalTeleconf>``<joinBeforeHost>.

Request

The sample XML document shows an example of a possible response to the preceding request document.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:getUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:firstName>firstName1</use:firstName>
            <use:lastName>lastName1</use:lastName>
            <use:title>title</use:title>
            <use:categoryId>36</use:categoryId>
            <use:description>The system automatically creates this office when it creates your user account.</use:description>
            <use:company>company1</use:company>
            <use:webExId>webExId1</use:webExId>
            <use:address>
                <com:addressType>PERSONAL</com:addressType>
                <com:country>1</com:country>
            </use:address>
            <use:phones>
                <com:phone>1,,,,,,</com:phone>
                <com:mobilePhone>1,,,,,,</com:mobilePhone>
                <com:fax>1,,,,,,</com:fax>
                <use:pager>1,,,,,,</use:pager>
                <use:PIN>1911</use:PIN>
            </use:phones>
            <use:email>webExId1@email.com</use:email>
            <use:password>******</use:password>
            <use:passwordHint>passwordHint</use:passwordHint>
            <use:passwordHintAnswer>passwordHintAnswer</use:passwordHintAnswer>
            <use:personalUrl>personalUrl</use:personalUrl>
            <use:expirationDate>12/31/2049 15:59:59</use:expirationDate>
            <use:commOptions>
                <use:prodAnnounce>false</use:prodAnnounce>
                <use:trainingInfo>false</use:trainingInfo>
                <use:electronicInfo>false</use:electronicInfo>
                <use:promos>false</use:promos>
                <use:press>false</use:press>
                <use:email>false</use:email>
                <use:fax>false</use:fax>
                <use:phone>false</use:phone>
                <use:mail>false</use:mail>
            </use:commOptions>
            <use:meetingTypes>
                <use:meetingType>3</use:meetingType>
                <use:meetingType>9</use:meetingType>
                <use:meetingType>11</use:meetingType>
            </use:meetingTypes>
            <use:options>
                <use:firstNameVisible>true</use:firstNameVisible>
                <use:lastNameVisible>true</use:lastNameVisible>
                <use:addressVisible>true</use:addressVisible>
                <use:workPhoneVisible>true</use:workPhoneVisible>
                <use:cellPhoneVisible>true</use:cellPhoneVisible>
                <use:pagerVisible>true</use:pagerVisible>
                <use:faxVisible>true</use:faxVisible>
                <use:officeUrlVisible>true</use:officeUrlVisible>
                <use:pictureVisible>true</use:pictureVisible>
                <use:notifyOnNewMessage>true</use:notifyOnNewMessage>
                <use:notifyOnMeeting>true</use:notifyOnMeeting>
                <use:followMeEnable>true</use:followMeEnable>
                <use:emailVisible>true</use:emailVisible>
                <use:listInCategory>true</use:listInCategory>
                <use:titleVisible>true</use:titleVisible>
                <use:folderRead>false</use:folderRead>
                <use:folderWrite>false</use:folderWrite>
                <use:messageVisible>false</use:messageVisible>
                <use:iconSelect1>false</use:iconSelect1>
                <use:iconSelect2>false</use:iconSelect2>
                <use:acceptLinkRequest>false</use:acceptLinkRequest>
                <use:holdOnLinkRequest>true</use:holdOnLinkRequest>
                <use:notifyOnLinkRequest>true</use:notifyOnLinkRequest>
                <use:supportVideo>true</use:supportVideo>
                <use:supportApp>true</use:supportApp>
                <use:supportFileShare>true</use:supportFileShare>
                <use:supportDesktopShare>true</use:supportDesktopShare>
                <use:supportMeetingRecord>true</use:supportMeetingRecord>
                <use:supportAppshareRemote>true</use:supportAppshareRemote>
                <use:supportWebTourRemote>true</use:supportWebTourRemote>
                <use:supportDesktopShareRemote>true</use:supportDesktopShareRemote>
                <use:subscriptionOffice>true</use:subscriptionOffice>
                <use:workPhoneCallback>false</use:workPhoneCallback>
                <use:cellPhoneCallback>false</use:cellPhoneCallback>
                <use:faxCallback>false</use:faxCallback>
                <use:pagerCallback>false</use:pagerCallback>
            </use:options>
            <use:timeZoneID>4</use:timeZoneID>
            <use:timeZone>GMT-08:00, Pacific (San Jose)</use:timeZone>
            <use:timeZoneWithDST>San Francisco (Pacific Daylight Time, GMT-07:00)</use:timeZoneWithDST>
            <use:tracking/>
            <use:service>FREE_OFFICE</use:service>
            <use:privilege>
                <use:host>false</use:host>
                <use:teleConfCallOut>true</use:teleConfCallOut>
                <use:teleConfCallOutInternational>false</use:teleConfCallOutInternational>
                <use:teleConfCallIn>true</use:teleConfCallIn>
                <use:teleConfTollFreeCallIn>false</use:teleConfTollFreeCallIn>
                <use:siteAdmin>true</use:siteAdmin>
                <use:voiceOverIp>false</use:voiceOverIp>
                <use:roSiteAdmin>false</use:roSiteAdmin>
                <use:labAdmin>false</use:labAdmin>
                <use:otherTelephony>true</use:otherTelephony>
                <use:teleConfCallInInternational>true</use:teleConfCallInInternational>
                <use:attendeeOnly>false</use:attendeeOnly>
                <use:recordingEditor>true</use:recordingEditor>
                <use:meetingAssist>false</use:meetingAssist>
                <use:isEnableCET>false</use:isEnableCET>
                <use:isEnablePMR>true</use:isEnablePMR>
                <use:teleCLIAuthEnabled>false</use:teleCLIAuthEnabled>
                <use:teleCLIPINEnabled>false</use:teleCLIPINEnabled>
            </use:privilege>
            <use:language>ENGLISH</use:language>
            <use:locale>U.S.</use:locale>
            <use:active>ACTIVATED</use:active>
            <use:defaultCallIn>
                <use:defaultGlobalCallInNum>
                    <serv:countryAlias>Call-in toll number (US/Canada)</serv:countryAlias>
                    <serv:phoneNumber>10224462261</serv:phoneNumber>
                    <serv:tollFree>false</serv:tollFree>
                </use:defaultGlobalCallInNum>
                <use:defaultGlobalCallInNum>
                    <serv:countryAlias>Call-in toll-free number (US/Canada)</serv:countryAlias>
                    <serv:phoneNumber>10224462262</serv:phoneNumber>
                    <serv:tollFree>true</serv:tollFree>
                </use:defaultGlobalCallInNum>
            </use:defaultCallIn>
            <use:supportedServices>
                <use:meetingCenter>true</use:meetingCenter>
                <use:trainingCenter>true</use:trainingCenter>
                <use:supportCenter>true</use:supportCenter>
                <use:eventCenter>true</use:eventCenter>
                <use:salesCenter>false</use:salesCenter>
            </use:supportedServices>
            <use:myWebEx>
                <use:isMyWebExPro>true</use:isMyWebExPro>
                <use:myContact>true</use:myContact>
                <use:myProfile>true</use:myProfile>
                <use:myMeetings>true</use:myMeetings>
                <use:myFolders>true</use:myFolders>
                <use:trainingRecordings>true</use:trainingRecordings>
                <use:recordedEvents>true</use:recordedEvents>
                <use:totalStorageSize>1000</use:totalStorageSize>
                <use:myReports>true</use:myReports>
                <use:myComputer>0</use:myComputer>
                <use:personalMeetingRoom>false</use:personalMeetingRoom>
                <use:myPartnerLinks>true</use:myPartnerLinks>
                <use:myWorkspaces>false</use:myWorkspaces>
                <use:additionalRecordingStorage>0</use:additionalRecordingStorage>
            </use:myWebEx>
            <use:personalTeleconf>
                <use:account>
                    <use:subscriberAccessCode>30693179</use:subscriberAccessCode>
                    <use:participantFullAccessCode>35830055</use:participantFullAccessCode>
                    <use:participantLimitedAccessCode>41577676</use:participantLimitedAccessCode>
                    <use:accountIndex>1</use:accountIndex>
                    <use:defaultFlag>true</use:defaultFlag>
                    <use:joinBeforeHost>false</use:joinBeforeHost>
                </use:account>
                <use:account>
                    <use:subscriberAccessCode>32541810</use:subscriberAccessCode>
                    <use:participantFullAccessCode>38256313</use:participantFullAccessCode>
                    <use:participantLimitedAccessCode>37595547</use:participantLimitedAccessCode>
                    <use:accountIndex>2</use:accountIndex>
                    <use:defaultFlag>false</use:defaultFlag>
                    <use:joinBeforeHost>false</use:joinBeforeHost>
                </use:account>
                <use:joinBeforeHost>false</use:joinBeforeHost>
            </use:personalTeleconf>
            <use:videoSystems/>
            <use:personalMeetingRoom>
                <use:title>title1</use:title>
                <use:personalMeetingRoomURL>https://site.webex.com/meet/webExId1</use:personalMeetingRoomURL>
                <use:accessCode>216125648</use:accessCode>
                <use:hostPIN>1116</use:hostPIN>
                <use:applyPMRForInstantMeeting>false</use:applyPMRForInstantMeeting>
                <use:PMRAutoLock>false</use:PMRAutoLock>
                <use:PMRAutoLockWaitTime>0</use:PMRAutoLockWaitTime>
                <use:PRNotifications>
                    <use:mode>EMAIL</use:mode>
                </use:PRNotifications>
                <use:PMRAlternateHost>true</use:PMRAlternateHost>
                <use:alternateHost>
                    <use:allowAnyoneHostMyPMR>false</use:allowAnyoneHostMyPMR>
                </use:alternateHost>
            </use:personalMeetingRoom>
            <use:sessionOptions>
                <use:defaultSessionType>3</use:defaultSessionType>
                <use:defaultServiceType>MeetingCenter</use:defaultServiceType>
                <use:autoDeleteAfterMeetingEnd>true</use:autoDeleteAfterMeetingEnd>
                <use:displayQuickStartHost>true</use:displayQuickStartHost>
                <use:displayQuickStartAttendees>false</use:displayQuickStartAttendees>
            </use:sessionOptions>
            <use:supportCenter>
                <use:serviceDesk>
                    <use:enable>false</use:enable>
                </use:serviceDesk>
            </use:supportCenter>
            <use:security>
                <use:forceChangePassword>false</use:forceChangePassword>
                <use:resetPassword>false</use:resetPassword>
                <use:lockAccount>false</use:lockAccount>
            </use:security>
            <use:languageID>1</use:languageID>
            <use:webACDPrefs>
                <use:isAgent>false</use:isAgent>
                <use:isMgr>false</use:isMgr>
                <use:numAgentSessions>1</use:numAgentSessions>
                <use:agentMonitorAllRSQueues>false</use:agentMonitorAllRSQueues>
                <use:managerMonitorAllRSQueues>false</use:managerMonitorAllRSQueues>
                <use:monitorAllRSAgents>false</use:monitorAllRSAgents>
            </use:webACDPrefs>
            <use:remoteSupport>
                <use:sharingView>FS</use:sharingView>
                <use:sharingColor>16BIT</use:sharingColor>
                <use:recording>
                    <use:enforce>false</use:enforce>
                </use:recording>
                <use:autoRequest>
                    <use:enable>false</use:enable>
                </use:autoRequest>
                <use:defaultClient>
                    <use:type>SINGLE_SESS</use:type>
                    <use:singleSessClient>NEW_CONSL</use:singleSessClient>
                </use:defaultClient>
            </use:remoteSupport>
            <use:registrationDate>06/03/2016 11:38:33</use:registrationDate>
            <use:visitCount>0</use:visitCount>
            <use:userId>504916225</use:userId>
            <use:eventCenter>
                <use:optimizeAttendeeBandwidthUsage>false</use:optimizeAttendeeBandwidthUsage>
            </use:eventCenter>
            <use:passwordExpires>false</use:passwordExpires>
            <use:passwordDaysLeft>0</use:passwordDaysLeft>
            <use:avatar>
                <use:url>https://site.qa.webex.com/url</use:url>
                <use:lastModifiedTime>1507828423000</use:lastModifiedTime>
                <use:isUploaded>true</use:isUploaded>
            </use:avatar>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The sample XML document shows an example of a request to retrieve a user account with a webExID value of hostid. Be sure to provide valid values for a user account on your site.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostid@acme.com</webExID>
          <password>hostPassword</password>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.user.GetUser">
            <webExId>hostid</webExId>
        </bodyContent>
    </body>
</serv:message>

The following schema diagram shows the structure of the elements in the getUser request message.

Figure 3-16 • Schema diagram for getUser

getUser

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non-global elements, see Elements in WebEx XML Schema Definitions for the User Service.

Response

The following schema diagram shows the structure of the elements in the
getUserResponse message.

Figure 3-17 • Schema diagram for getUserResponse

getUserResponse

Note

GetUser validates user options against the site options before returning the settings in the XML response. Users can be forced to change their password on their next login or locked out of their account entirely by Site Admin. The enable element has been added to support the “Create this user as administrator on the Service Desk site” option in Site Admin.
 
The result and exceptionID global elements allow you to confirm that an instantiation request was successful. These elements are described in “Global Response Elements Showing Results and Errors”.