Skip to content

UserSearchCriteria

Source code in docs_src/capo_connect/types/user_search_criteria.py
class UserSearchCriteria(TypedDict, closed=True):
    or_conditions: NotRequired[
        "capo_connect.types.user_search_condition_list.UserSearchConditionList"
    ]
    """<p>A list of conditions which would be applied together with an <code>OR</code> condition.</p>"""
    and_conditions: NotRequired[
        "capo_connect.types.user_search_condition_list.UserSearchConditionList"
    ]
    """<p>A list of conditions which would be applied together with an <code>AND</code> condition.</p>"""
    string_condition: NotRequired["capo_connect.types.string_condition.StringCondition"]
    """<p>A leaf node condition which can be used to specify a string condition.</p> <p>The currently supported values for <code>FieldName</code> are <code>Username</code>, <code>FirstName</code>, <code>LastName</code>, <code>RoutingProfileId</code>, <code>SecurityProfileId</code>, <code>resourceId</code>.</p>"""
    list_condition: NotRequired["capo_connect.types.list_condition.ListCondition"]
    """<p>A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.</p>"""
    hierarchy_group_condition: NotRequired[
        "capo_connect.types.hierarchy_group_condition.HierarchyGroupCondition"
    ]
    """<p>A leaf node condition which can be used to specify a hierarchy group condition.</p>"""

and_conditions instance-attribute

and_conditions: NotRequired[UserSearchConditionList]

A list of conditions which would be applied together with an AND condition.

hierarchy_group_condition instance-attribute

hierarchy_group_condition: NotRequired[HierarchyGroupCondition]

A leaf node condition which can be used to specify a hierarchy group condition.

list_condition instance-attribute

list_condition: NotRequired[ListCondition]

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

or_conditions instance-attribute

or_conditions: NotRequired[UserSearchConditionList]

A list of conditions which would be applied together with an OR condition.

string_condition instance-attribute

string_condition: NotRequired[StringCondition]

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, resourceId.