WickrAdminAPI / Client / list_users

list_users

WickrAdminAPI.Client.list_users(**kwargs)

Retrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    networkId='string',
    nextToken='string',
    maxResults=123,
    sortFields='string',
    sortDirection='ASC'|'DESC',
    firstName='string',
    lastName='string',
    username='string',
    status=123,
    groupId='string'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

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

  • nextToken (string) – The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

  • maxResults (integer) – The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

  • sortFields (string) – The fields to sort users by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘username’, ‘firstName’, ‘lastName’, ‘status’, and ‘groupId’.

  • sortDirection (string) – The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

  • firstName (string) – Filter results to only include users with first names matching this value.

  • lastName (string) – Filter results to only include users with last names matching this value.

  • username (string) – Filter results to only include users with usernames matching this value.

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

  • groupId (string) – Filter results to only include users belonging to this security group.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'users': [
        {
            'userId': 'string',
            'firstName': 'string',
            'lastName': 'string',
            'username': 'string',
            'securityGroups': [
                'string',
            ],
            'isAdmin': True|False,
            'suspended': True|False,
            'status': 123,
            'otpEnabled': True|False,
            'scimId': 'string',
            'type': 'string',
            'cell': 'string',
            'countryCode': 'string',
            'challengeFailures': 123,
            'isInviteExpired': True|False,
            'isUser': True|False,
            'inviteCode': 'string',
            'codeValidation': True|False,
            'uname': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token to use for retrieving the next page of results. If this is not present, there are no more results.

    • users (list) –

      A list of user objects matching the specified filters and within the current page.

      • (dict) –

        Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.

        Note

        codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.

        • userId (string) –

          The unique identifier for the user within the network.

        • firstName (string) –

          The first name of the user.

        • lastName (string) –

          The last name of the user.

        • username (string) –

          The email address or username of the user. For bots, this must end in ‘bot’.

        • securityGroups (list) –

          A list of security group IDs to which the user is assigned, determining their permissions and feature access.

          • (string) –

        • isAdmin (boolean) –

          Indicates whether the user has administrator privileges in the network.

        • suspended (boolean) –

          Indicates whether the user is currently suspended and unable to access the network.

        • status (integer) –

          The current status of the user (1 for pending invitation, 2 for active).

        • otpEnabled (boolean) –

          Indicates whether one-time password (OTP) authentication is enabled for the user.

        • scimId (string) –

          The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.

        • type (string) –

          The descriptive type of the user account (e.g., ‘user’).

        • cell (string) –

          The phone number minus country code, used for cloud deployments.

        • countryCode (string) –

          The country code for the user’s phone number, used for cloud deployments.

        • challengeFailures (integer) –

          The number of failed password attempts for enterprise deployments, used for account lockout policies.

        • isInviteExpired (boolean) –

          Indicates whether the user’s email invitation code has expired, applicable to cloud deployments.

        • isUser (boolean) –

          Indicates whether this account is a user (as opposed to a bot or other account type).

        • inviteCode (string) –

          The invitation code for this user, used during registration to join the network.

        • codeValidation (boolean) –

          Indicates whether the user can be verified through a custom invite code.

        • uname (string) –

          The unique identifier for the user.

Exceptions