Available Filters

Filtering is the way a request XML packet indicates to which objects to apply an operation. Parameters nested in the filter node are called filtering rule.

The filter node is presented by the UserSelectionFilter type (user.xsd). Its graphical representation is as follows:

user-filter.gif

  • guid, required

    It specifies a user GUID. Data type: string.

  • owner-guid, required

    It specifies the GUID of an owner of user accounts. Data type: integer.

  • external-id, required

    It specifies a user ID in the Plesk components (for example, Customer and Business Manager). Data type: string.

  • owner-external-id, required

    It specifies the ID of an owner of user accounts in the Plesk components (for example, Business Manager). Data type: string.

  • all, required

    It matches all users. Data type: none.

Examples

The following filter matches a user by guid:

   <filter>
      <guid>96197aa9-389a-db5b-aadc-88350b24fcdd</guid>
   </filter>

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.