Class UsersSearchBaseRequest
Represents a search request over users.
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public abstract class UsersSearchBaseRequestProperties
EditableOnly
Restricts the results to users that are editable for calling user.
If set to true, IncludeServiceUser is ignored.
Declaration
[JsonProperty("editableOnly", Required = Required.Always)]
public bool EditableOnly { get; set; }Property Value
| bool |
Filter
An optional search filter. Limits the document result set.
Declaration
[JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public FilterBase Filter { get; set; }Property Value
| FilterBase |
IncludeAnonymousUser
Includes the anonymous user in result.
Declaration
[JsonProperty("includeAnonymousUser", Required = Required.Always)]
public bool IncludeAnonymousUser { get; set; }Property Value
| bool |
IncludeServiceUser
Includes the service user in result.
Declaration
[JsonProperty("includeServiceUser", Required = Required.Always)]
public bool IncludeServiceUser { get; set; }Property Value
| bool |
LifeCycleFilter
Return only users in certain life cycle state(s).
Declaration
[JsonProperty("lifeCycleFilter", Required = Required.Always)]
[Required(AllowEmptyStrings = true)]
[JsonConverter(typeof(StringEnumConverter))]
public LifeCycleFilter LifeCycleFilter { get; set; }Property Value
| LifeCycleFilter |
SearchBehaviors
An optional list of search behaviors. All the passed behaviors will be applied.
Declaration
[JsonProperty("searchBehaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<SearchBehavior> SearchBehaviors { get; set; }Property Value
| ICollection<SearchBehavior> |
SearchString
Limits the search by using a query string filter. The Lucene query string syntax is supported.
Declaration
[JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SearchString { get; set; }Property Value
| string |
UserRightsFilter
Return only users with certain user rights.
Declaration
[JsonProperty("userRightsFilter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<UserRight> UserRightsFilter { get; set; }Property Value
| ICollection<UserRight> |
Methods
FromJson(string)
Declaration
public static UsersSearchBaseRequest FromJson(string data)Parameters
| string data |
Returns
| UsersSearchBaseRequest |