User Service
Important
The Meetings-related XML APIs will be deprecated and the End-of-Support (EoS) date is planned for the second half of 2023. Cisco will continue to resolve bugs up to this date, but new features will only be implemented for the REST APIs suite. The End-of-life (EoL) timeframe for Meetings-related XML APIs is targeted for March 31, 2024, at which time the APIs will be retired. For information on how to migrate from XML to REST APIs, please see Webex Meetings XML to REST Migration Guide. User management APIs such asCreateUser, SetUser, DelUser, etc. are NOT affected by this EOL
announcement.
The user service is all about user account management. Here, you will find requests that allow you to create and update user accounts, list available user accounts, and set user privileges.
Available user requests are listed below. Detailed information about each request is provided in separate pages within this chapter.
User Service Requests
| XML API Request | Description |
|---|---|
AuthenticateUser |
Converts Webex API access token or user password to a sessionTicket for XML API authentication. This request is optional, and Webex offers better authentication options. |
CreateUser |
A site administrator can provision new host and admin user accounts using CreateUser. On Control hub managed sites, if the email/user does not already belong to a control hub org, then it first tries to create a user in the site owning the org. |
DeleteUser |
Deactivates the specified user from your site. Permits up to 50 users to be deactivated at a time. For ControlHub managed sites it also removes the meeting license(s) (related to the WebEx site) for the user(s) in ControlHub. |
GetloginTicket |
Unrelated to XML API authentication. Generates a one time login ticket that can be used with URL API to log in to a Webex site. |
GetloginurlUser |
Unrealted to XML API authentication. Generates a URL that loads a host or admin user's Webex site, already logged in. |
GetlogouturlUser |
Unrelated to XML API authentication. Logs a user out of their Webex site if run in the same browser process. This is not commonly used and user can be logged out of Webex by terminating the browser process. |
GetUser |
Retrieve detailed list of user account settings. |
LstsummaryUser |
Retrieve list of user accounts on the Webex site. |
SetUser |
Updates information and settings for an existing host or admin user. For Webex sites managed in Control Hub, cannot update user's Webex ID, password, email, name, or telephone number. |
UploadPMRImage |
Update user's Personal Meeting Room photo. |