MSFT_SIPESUserContactGroupData class

Microsoft Office Live Communications Server 2005 with SP1


The MSFT_SIPESUserContactGroupData class defines the settings for a contact group associated with a specific Active Directory user.

The following syntax is simplified from MOF code and includes all inherited properties.

class MSFT_SIPESUserContactGroupData
  string ExternalURL;
  [key] uint32 GroupID;
  string Name;
  [key] string UserInstanceID;


This class does not define any methods.


The MSFT_SIPESUserContactGroupData class has the following properties.

  • ExternalURL
    Data type: string

    An external URL for this contact group. The maximum length of the string is 2,048 characters.

    This property is optional on creation and can be updated.

  • GroupID
    Data type: [key] uint32

    The contact group ID as an integer value between 1 and 64. This value must be unique for the Active Directory user, such that no other group associated with the user has the same ID. This value has to be NULL for create operations (the server generates this value), and it cannot be NULL for update operations. Once an instance is created, the property can no longer be changed. The appropriate flags must be used (as specified in the Remarks section).

    This group ID is present in the GroupID array property of MSFT_SIPESUserContactData, which contains a list of all groups the user participates in. A maximum of 64 contact groups is supported.

  • Name
    Data type: string

    The display name for this contact group. The name can be no more than 128 characters in length.

    This value cannot be NULL.

    This property is required on creation and can be updated.

  • UserInstanceID
    Data type: [key] string

    A GUID value that uniquely identifies the Active Directory user with which this contact group is associated. The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

    This property is required on creation and cannot be updated.


A contact group is a specific collection of contacts defined by a user. Each contact is represented by an instance of the MSFT_SIPESUserContactData class. For PutInstance operations, only the WBEM_FLAG_CREATE_ONLY and WBEM_FLAG_UPDATE_ONLY flags are supported.

To perform operations on this class, connect to local WMI. In turn, WMI contacts the home server of the user and retrieves or updates the data for the instance of this class associated with the user. Live Communications Server must be running and available on the user's home server.

Uniqueness of a class instance is guaranteed by a combination of the group ID and the GUID that represents the Active Directory user.

Available actions for an instance of this class:

  • Creation: A member of the "Live Communications Domain User Admins" group can create instances of this class.
  • Updates: A member of the "Live Communications Domain User Admins" group can update instances of this class.
  • Deletion: A member of the "Live Communications Domain User Admins" group can delete instances of this class.


Server: Installed on Windows Server 2003 with Live Communications Server 2005 with SP1.
Namespace: Defined in \root\cimv2.

See Also

MSFT_SIPESUserContactData, Live Communications Server WMI Reference

What did you think of this topic?
© 2008 Microsoft Corporation. All rights reserved.