ModifyUser Message

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.

Modifies a specific user account in a conference center.

Components

Remarks

A caller must be a member of the Administrator role.

This message can be used to change the userID value. This message has the same semantics as the ModifyUserProfile message except for the user context.

All the changes for the CreateUser API holds true for both the ModifyUser and ModifyUserProfile APIs, as the following list shows:

• Users can modify their own member default values using ModifyUserProfile, which is used while creating further new meetings. These new member default options are enableRecordingExpiration, recordingExpirationTimeAmount, recordingExpirationTimeType, enableAudioVOIP, enableClientRecordingPresenter, andenableClientRecordingAttendee.

• Administrators can modify the member default values using ModifyUser for new options for any member in the conference center. These new member default options are enableRecordingExpiration, recordingExpirationTimeAmount, recordingExpirationTimeType, enableAudioVOIP, enablePersonalRecordingPresenter, and enablePersonalRecordingAttendee.

All other modify options have not changed.

Examples

This example shows how to change the password of a user, enable all conference modalities, and add the user to a new group.

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

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <ModifyUserRequest userID="bill">
    <OptionList>
       <StringOption name="password" value="NewPa$$w0rd"/>
       <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>
    <AddGroups>
      <GroupID>sales</GroupID>
    </AddGroups>
  </ModifyUserRequest>
</PlaceWareConfCenter>

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

<PlaceWareConfCenter>
  <ModifyUserReply/>
</PlaceWareConfCenter>

See Also

Concepts

ModifyUserRequest Element

ModifyUserReply Element