CreateUser Message

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Creates a user account in a Live Meeting conference center.

Components

Component Type	XML Element
Request	CreateUserRequest
Reply	CreateUserReply

Remarks

A caller must be a member of the Administrator role.

The CreateUser message returns the users password if a password is not specified or is blank. The password is returned as a string option if the password attribute is missing in the request and is automatically generated by the server.

The user ID that is assigned in the CreateUserRequest can be changed using the ModifyUserRequest operational message. Any recordings or meetings owned by this user are transferred to the new user ID on successful modification of the user.

Important

CreateUser must not be called on a conference center hosted by Microsoft Online. For more information, see Using the Live Meeting API with Microsoft Online-Hosted Live Meeting Service.

Examples

This example shows how to create an organizer with application sharing privilege set to Desktop.

The following code shows the request sent to the conference center.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateUserRequest userID="dhall" password="r!DDl3One">
    <OptionList>
      <ApplicationSharingOption name="applicationSharingPrivilege" value="Desktop"/>
      <StringOption name="email" value="dhall@contoso.com"/>
      <StringOption name="lastName" value="Hall"/>
      <BooleanOption name="isOrganizer" value="True"/>
    </OptionList>
    <GroupList>
      <GroupID>Marketing</GroupID>
    </GroupList>
  </CreateUserRequest>
</PlaceWareConfCenter>

The following shows a reply returned from the conference center when the request is processed successfully.

<PlaceWareConfCenter>
  <CreateUserReply/>
</PlaceWareConfCenter>

Example 2: Creating a User Account with Custom Frames Enabled

This example shows how to create a user with custom frames enabled. You use custom frames to expose a Web page within a frame of the Live Meeting client, usually for the purpose of adding additional functionality. For example, you might want to add a custom frame to expose a Web page that has audio controls. In the following example, you specify one URL for the user when participating as a presenter and another URL when participating as an attendee. When you specify the URLs and the frame heights for the custom frames, you set the customFramesEnabled option to True.

The following code shows the request sent to a conference center.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateUserRequest userID="chris" password="Pa$$w0rd">
    <OptionList>
      <ApplicationSharingOption name="applicationSharingPrivilege" value="Desktop"/>
      <StringOption name="email" value="chris@contoso.com"/>
      <StringOption name="lastName" value="Hay"/>
      <BooleanOption name="isOrganizer" value="True"/>
      <StringOption name="audienceCustomFrameURL" value="https://www.microsoft.com"/>
      <DecimalOption name="audienceCustomFrameHt" value="100"/>
      <StringOption name="presenterCustomFrameURL" value="https://www.msn.com"/>
      <DecimalOption name="presenterCustomFrameHt" value="100"/>
      <BooleanOption name="customFramesEnabled" value="True"/>
    </OptionList>
  </CreateUserRequest>
</PlaceWareConfCenter>

The following is a reply returned from the conference center when the request is processed successfully.

<PlaceWareConfCenter>
  <CreateUserReply/>
</PlaceWareConfCenter>

Example 3: Creating a User Account With Modalities Enabled

The following example enables all meeting modalities for an organizer user. Note that if a given modality is not set using the CreateUserRequest message, that modality is enabled or disabled according to the default value set by an Administrator for the Conference Center.

<PlaceWareConfCenter authUser=" apiuser " authPassword="Pa$$w0rd">
   <CreateUserRequest userID="jeff">
      <OptionList>
         <StringOption name="email" value="jeff@contoso.com " />
         <StringOption name="lastName" value="Hay" />
         <BooleanOption name="isOrganizer" value="True" />
         <BooleanOption name="ecrAnnotationsPrivilege" value="True" />
         <BooleanOption name="ecrChatPrivilege" value="True" />
         <BooleanOption name="ecrHandoutsPrivilege" value="True" />
         <BooleanOption name="ecrQAPrivilege" value="True" />
         <BooleanOption name="ecrSharednotesPrivilege" value="True" />
         <BooleanOption name="ecrTextpagePrivilege" value="True" />
         <BooleanOption name="ecrWhiteboardPrivilege" value="True" />
      </OptionList>
   </CreateUserRequest>
</PlaceWareConfCenter>