UserSearch
A complex data type that represents a user search.
Elements
Condition
UserCondition. Optional. The search condition. Specify this value of ConditionArray.
ConditionArray
ArrayOfUserCondition. Optional. An array of search conditions. Specify this value of ConditionArray.
MemberOfGroupName
Obsolete since iHub release 3.
WithRoleName
Deprecated since iHub release 3. Replaced by WithUserGroupName.
WithUserGroupName
String. Optional. The name of the user group to which the user belongs. Specify one of this value, SubscribedToChannelName, WithUserGroupId, WithLicenseOption, or SubscribedToChannelId.
SubscribedToChannelName
String. Optional. The name of the channel to which the user is subscribed. Specify one of this value, WithUserGroupName, WithUserGroupId, WithLicenseOption, or SubscribedToChannelId.
MemberOfGroupId
Obsolete since iHub release 3.
WithRoleId
Deprecated since iHub release 3. Replaced by WithUserGroupId.
WithUserGroupId
String. Optional. The ID of the user group to which the user belongs. Specify one of this value, WithUserGroupName, SubscribedToChannelName, WithLicenseOption, or SubscribedToChannelId.
WithLicenseOption
String. Optional. The name of the license option assigned to the user. Specify one of this value, WithUserGroupName, SubscribedToChannelName, WithUserGroupId, or SubscribedToChannelId.
SubscribedToChannelId
String. Optional. The ID of the channel to which the user is subscribed. Specify one of this value, WithUserGroupName, SubscribedToChannelName, WithUserGroupId, or WithLicenseOption.
FetchSize
Int. Optional. The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
Boolean. Optional. If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
Int. Optional. The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
String. Optional. Retrieves more items from the result set. In the second and subsequent calls for data, specifies the same search criteria as in the original call.