WickrAdminAPI / Client / get_users_count

get_users_count

WickrAdminAPI.Client.get_users_count(**kwargs)

Retrieves the count of users in a Wickr network, categorized by their status (pending, active, rejected) and showing how many users can still be added.

See also: AWS API Documentation

Request Syntax

response = client.get_users_count(
    networkId='string'
)
Parameters:

networkId (string) –

[REQUIRED]

The ID of the Wickr network for which to retrieve user counts.

Return type:

dict

Returns:

Response Syntax

{
    'pending': 123,
    'active': 123,
    'rejected': 123,
    'remaining': 123,
    'total': 123
}

Response Structure

  • (dict) –

    • pending (integer) –

      The number of users with pending status (invited but not yet accepted).

    • active (integer) –

      The number of users with active status in the network.

    • rejected (integer) –

      The number of users who have rejected network invitations.

    • remaining (integer) –

      The number of additional users that can be added to the network while maintaining premium free trial eligibility.

    • total (integer) –

      The total number of users in the network (active and pending combined).

Exceptions