System.Object
PrincipalSearch
Client Declaration
public class PrincipalSearch
Represents information specifying a search of P8 domain users and groups. This element is used in an ExecuteSearch
request.
Elements
String
SearchPattern
: [request] Optional element specifying the text for which to search. String
SearchRealm
: [request] Optional element specifying the realm in which to search, in LDAP format (dc=<domain name component>, dc=<domain name componant>, etc).Attributes
Boolean
includeGroups
: [request] Optional expression specifying
whether groups are included in the search.Boolean
includeUsers
: [request] Optional expression specifying whether
users are included in the search.PrincipalSearchPrincipalSearchAttribute
principalSearchAttribute
: [request] Optional expression specifying
the attribute for which to search (display name or short name). PrincipalSearchPrincipalSearchType
principalSearchType
: [request] Optional expression specifying the type
of operation to use in the search.PrincipalSearchPrincipalSort
principalSort
: [request] Optional expression specifying how to sort the search results (ascending or descending). Attributes Specific to .NET Clients
Boolean
includeGroupsSpecified
: Optional expression specifying whether includeGroups
has a value (true
) or not (false
).Boolean
includeUsersSpecified
: Optional expression specifying whether includeUsers
has a value (true
) or not (false
).Boolean
principalSearchAttributeSpecified
: Optional expression specifying whether principalSearchAttribute
has a value (true
) or not (false
).Boolean
principalSearchTypeSpecified
: Optional expression specifying whether principalSearchType
has a value (true
) or not (false
).Boolean
principalSortSpecified
: Optional expression specifying whether principalSort
has a value (true
) or not (false
).
Elements
PropertyFilterType
SelectionFilter
: [request] Optional element specifying a property filter to be applied to the elements of the result set. Attributes
Boolean
continuable
: [request] Optional expression specifying whether
the client requires paging and continuation capability for this search (true
)
or not (false
). If this attribute is false
, the maxElements
attribute is ignored.String
continueFrom
: [request] Optional expression specifying the
value of CollectionTerminator
element from a previously returned
page. This value indicates the start point of the current page. Int32
maxElements
: [request] Optional expression specifying the page
size for the currently requested page of a continuable query. This attribute is ignored if the continuable
attribute is false
. If this attribute is omitted or a value of -1 is specified, the default page size will apply (the QueryPageDefaultSize
property value of a ServerCacheConfiguration
object).Attributes Specific to .NET Clients
Boolean
continuableSpecified
: Optional expression specifying whether continuable
has a value (true
) or not (false
).Boolean
maxElementsSpecified
: Optional expression specifying whether maxElements
has a value (true
) or not (false
).
<xsd:complexType name="PrincipalSearch"> <xsd:complexContent> <xsd:extension base="SearchRequestType"> <xsd:sequence> <xsd:element name="SearchRealm" type="xsd:string"/> <xsd:element name="SearchPattern" type="xsd:string"/> </xsd:sequence> <xsd:attribute name="includeUsers" type="xsd:boolean"/> <xsd:attribute name="includeGroups" type="xsd:boolean"/> <xsd:attribute name="principalSearchType"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Custom"/> <xsd:enumeration value="PrefixMatch"/> <xsd:enumeration value="SuffixMatch"/> <xsd:enumeration value="Contains"/> <xsd:enumeration value="Exact"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="principalSearchAttribute"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="ShortName"/> <xsd:enumeration value="DisplayName"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="principalSort"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Ascending"/> <xsd:enumeration value="Descending"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:extension> </xsd:complexContent> </xsd:complexType>