MSFT_SIPESUserACEData class

MSFT_SIPESUserACEData

The MSFT_SIPESUserACEData class defines SIP-level allow and block access for a homed Live Communications Server user.

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

class MSFT_SIPESUserACEData
{
  string Communication;
  [key] string Mask;
  string Presence;
  [key] string Type;
  [key] string UserInstanceID;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESUserACEData class has the following properties.

• Communication
  Data type: string

  The client-enforced action to take when the entity specified in the Mask property sends a SIP INVITE message to the client.

  Value	Description
  "Allow"	Allow all INVITE messages from entities that match the mask.
  "Deny"	Deny all INVITE messages from entities that match the mask.

  This property is required on creation and can be updated.

• Mask
  Data type: [key] string

  The mask used when the access type is either "Domain" or "User". The mask is used to determine which domains or users the actions specified in the Presence and Communication properties are enforced upon.

  If the access type is set to "Domain", the mask must be a valid fully qualified domain name or IP address. If the access type is set to "User", the mask must be a valid SIP URI (for example, "sip:someone@example.com"). If the type is "All", this value is NULL. The maximum length of the string is 454 characters.

  This property is optional on creation and can be updated.

• Presence
  Data type: string

  The server-enforced action to take when the entity specified in the Mask property sends a SIP SUBSCRIBE message to the Live Communications server.

  Value	Description
  "Allow"	Allow all SUBSCRIBE messages from entities that match the mask.
  "Deny"	Deny all SUBSCRIBE messages from entities that match the mask.
  "Prompt"	Prompt the user before allowing any SUBSCRIBE messages from entities that match the mask.
  "Block"	Block all SUBSCRIBE messages from entities that match the mask and respond with a 404 (User Not Found) status code.

  This property is required on creation and can be updated.

• Type
  Data type: [key] string

  The type of filtration for access.

  Value	Description
  "All"	The allow and block entry applies to all messages.
  "Domain"	The allow and block entry applies to messages from users in a specific domain.
  "User"	The allow and block entry applies to messages from a specific user.

  This property is required on creation and can be updated.

• UserInstanceID
  Data type: [key] string

  A GUID value that uniquely identifies this SIP user. 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.

Remarks

For PutInstance operations only WBEM_FLAG_CREATE_OR_UPDATE flag is supported.

Uniqueness is guaranteed by a combination of the GUID representing the Active Directory user, the ACE type, and the allow and block entry mask.

Presence is enforced by the server, and Communication is enforced by the client. There are four valid combinations of the Communication and Presence properties:

• Allow (Communication)/ Allow (Presence)—the user can be invited to sessions by entities that match the mask, and can receive presence updates.
• Allow (Communication)/ Prompt (Presence)—the user can be invited to sessions by entities that match the mask, but must be prompted for presence updates.
• Deny (Communication)/ Deny (Presence)—the user will not accept session invitations from entities that match the mask, and will also not accept presence updates.
• Deny (Communication)/ Block (Presence)—the user will not accept session invitations from entities that match the mask, and will actively block presence updates.

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.

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.

Requirements

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

See Also

MSFT_SIPESUserSetting, Live Communications Server WMI Reference