Skip to content

ListUsersRequest

Source code in docs_src/capo_wickr/types/list_users_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ListUsersRequest(TypedDict, closed=True):
    network_id: "capo_wickr.types.network_id.NetworkId"
    """<p>The ID of the Wickr network from which to list users.</p>"""
    next_token: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.</p>"""
    sort_fields: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.</p>"""
    sort_direction: NotRequired["capo_wickr.types.sort_direction.SortDirection"]
    """<p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p>"""
    first_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>Filter results to only include users with first names matching this value.</p>"""
    last_name: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>Filter results to only include users with last names matching this value.</p>"""
    username: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>Filter results to only include users with usernames matching this value.</p>"""
    status: NotRequired["capo_wickr.types.user_status.UserStatus"]
    """<p>Filter results to only include users with this status (1 for pending, 2 for active).</p>"""
    group_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>Filter results to only include users belonging to this security group.</p>"""

first_name instance-attribute 

first_name: NotRequired[SensitiveString]

Filter results to only include users with first names matching this value.

group_id instance-attribute 

group_id: NotRequired[GenericString]

Filter results to only include users belonging to this security group.

last_name instance-attribute 

last_name: NotRequired[SensitiveString]

Filter results to only include users with last names matching this value.

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

network_id instance-attribute 

network_id: NetworkId

The ID of the Wickr network from which to list users.

next_token instance-attribute 

next_token: NotRequired[GenericString]

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

sort_direction instance-attribute 

sort_direction: NotRequired[SortDirection]

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

sort_fields instance-attribute 

sort_fields: NotRequired[GenericString]

The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.

status instance-attribute 

status: NotRequired[UserStatus]

Filter results to only include users with this status (1 for pending, 2 for active).

username instance-attribute 

username: NotRequired[GenericString]

Filter results to only include users with usernames matching this value.