Webex Meetings > Develop and Test > XML API > Release Notes

XML API 9.0 SP2 Release Notes

Important: This release does NOT change the schema that was released with XML API 9.0 SP1. For more information, see the latest schema definitions on the release notes announcements page.

Overview

This release note describes the changes made with the release of Webex® XML API 9.0 SP2. Changes described in this release note are backward compatible with existing integrations.

The previous release (XML API 9.0 SP1) blocked operations related to user management on sites based on the Spark Meet with Webex offer. Those sites use the Common Identity architecture (also known as Common User Profile architecture). This release of XML API 9.0 SP2 unblocks some of those user management features. Please see the information below to understand the difference between a normal train site and a Spark Meet with Webex site.
 

Changes to sites based on the Spark Meet with Webex Offer  

There are some changes to sites that are based on the Spark Meet with Webex offer (sites that use the Common architecture, also known as Common User Profile architecture).

 There are no changes to the input and outputs that affect the schema. However, there are new exceptions possible. The new exceptions are:

 

  • Exception ID: E030103 Assignment of this role is not supported 
  • Exception ID: E030104 This operation does not support SessionTicket authentication 
  • Exception ID: E030105 Error setting up or modifying user profile 

 

 

The following table outlines the functionality that has changed in XML API 9.0 SP2.
  Normal Site
List of current behavior.
(No changes in XML API 9.0 SP2) 		Spark Meet with Webex
Changes in XML API 9.0 SP2
Authentication A normal site accepts:
  • passwords
  • session ticket
A Spark Meet with Webex site accepts only an admin password as authentication for user management through the API.
  • If authenticate user is not performed by the admin role, CreateUser raises an exception as before. 
  • SetUser cannot change Active and CMR as before.
  • If the input for authentication is a session ticket the CreateUser API returns an exception:  
    "This operation does not support SessionTicket authentication"
  • If the input for authentication is a session ticket the SetUser API does not return an exception, but it ignores attempts to change the Active and CMR status. The system will also ignore attempts to change basic profile information. 
sendWelcome
CreateUser sends a welcome email to a newly created host if the sendWelcome flag is set to TRUE.
A Spark Meet with Webex site ignores <sendWelcome> flag. The end user will receive an activation email, password reset email and welcome email from Atlas, according to the Atlas email templates.
user active status Can only create active user, setUser accepts active status change. CreateUser ignores active input. It can only create user with inactive status. After an end user finishes performing an active/reset password process, the user becomes active.
 
SetUser cannot activate a user when the user is in pending status. After the end user finishes performing an active/reset password process, SetUser can accept active status changes.

Both activation and de-activation can be supported after the end user finishes performing the active/reset password process.
password input Accepts password input. Ignores password input. The end user must reset the password through the active/reset password process.
user name input,<webExId> Accepts webExId that is different than email:
    <webExId>host555</webExId>
  <email>host555@test.com</email> 		On a Spark Meet with Webex site the user email is always the same as the user webExId.

CreateUser ignores <webExId> input, and uses <email> as the <webExId>. Important: Both items are required.

SetUser ignores <email>, and uses <webExId> as email (webExId is required).
privilege setting Accepts admin, read only admin, host and attendee only Only accepts host privilege. Returns an exception when input privilege has the following:
        <siteAdmin>true</siteAdmin> or 
         <roSiteAdmin>true</roSiteAdmin> or
         <attendeeOnly>true</attendeeOnly>
The new exception is:
"Assignment of this role is not supported"

 

 

 

When an API call to a Spark Meet with Webex site fails or returns an unexpected response, the reponse contains the newly introduced exception: "Error setting up or modifying user profile"

Partners have the option to use a Partner Admin credential. A Partner Admin is a user who is in partner organization, but has site admin privileges for all sites managed by that partner. 

 

Please be aware of the following limitations: 

  • A user can have only one type of authentication. 
  • The password must be reset at least every 9 months.

 

 

 

CreateUser API Unblocked

Description

The CreateUser API has been unblocked. You can now use the CreateUser API to create user accounts on sites based on the Spark Meet with Webex offer (sites that use the Common User Profile architecture).

CreateUser Flow

The following steps outline the flow of logic that the system uses to authenticate and process a CreateUser request.
  1. An XML API call goes to the Common User Profile service to validate the admin user password and get an access token.
  2. The system checks the admin account and maps the Webex site to the organization's ID.
  3. The XML API call goes to the Common Administration service (also known as the Atlas server) to create the user with service entitlement (MC, CMR). The Common Administration service sends either an activation or password reset email to the end user.
  4. The system syncs the information with the basic user profile.
  5. The Webex server creates (provisions) the user with an inactive status.
  6. When end user activates or resets password, the Common User Profile service activates the user, and then sends notification to the Webex service.
  7. The Webex service receives the notification, and sets the user to active status.

SetUser API Unblocked

Description

The SetUser API has been unblocked. You can now use the SetUser API to modify user profiles on sites based on the Spark Meet with Webex offer (sites that use the Common User Profile architecture).

In the previous release, some attributes/elements/fields were ignored on a Spark Meet with Webex site (Common-Identity-enabled site). Previously ignored attributes/elements/fields now work as described in the API. Note that the schema has not changed, the only change is that those attributes/elements/fields are no longer ignored. These include.

newWebexId, firstName, lastName, title, address, phones,
email, email2, password, passwordHint, passwordHintAnswer,
timeZone, timeZoneID, timeZoneWithDST,
locale, language, languageID, active, security

SetUser Flow

The following steps outline the flow of logic that the system uses to authenticate and process a CreateUser request.
  1. An XML API call goes to the Common User Profile service to validate the admin user password and get an access token.
  2. The system checks admin accounts for all organizations with that admin role, then checks the licenses managed in organization to get the licenses ID and organization's input site.
  3. The system syncs the information with the basic user profile.
  4. The Webex server updates the basic user profile, and meeting attributes.
  5. If there are changes to the license based on the active status change, meeting type changes or CMR privilege changes, there is a call to the Common Administration service (also known as the Atlas server) to updates the user's license.

Related Release Information

The XML API schemas and release notes are available at the Cisco Webex Developer Portal:
https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/xml-api/reference/

The URL API release notes are available at the Cisco Webex Developer Portal:
https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/url-api/reference/

release notes last updated: 16-SEP-2015