WickrAdminAPI / Client / get_user

get_user

WickrAdminAPI.Client.get_user(**kwargs)

Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.

See also: AWS API Documentation

Request Syntax

response = client.get_user(
    networkId='string',
    userId='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network containing the user.

  • userId (string) –

    [REQUIRED]

    The unique identifier of the user to retrieve.

  • startTime (datetime) – The start time for filtering the user’s last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.

  • endTime (datetime) – The end time for filtering the user’s last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.

Return type:

dict

Returns:

Response Syntax

{
    'userId': 'string',
    'firstName': 'string',
    'lastName': 'string',
    'username': 'string',
    'isAdmin': True|False,
    'suspended': True|False,
    'status': 123,
    'lastActivity': 123,
    'lastLogin': 123,
    'securityGroupIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • userId (string) –

      The unique identifier of the user.

    • 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.

    • isAdmin (boolean) –

      Indicates whether the user has administrator privileges in the network.

    • suspended (boolean) –

      Indicates whether the user is currently suspended.

    • status (integer) –

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

    • lastActivity (integer) –

      The timestamp of the user’s last activity in the network, specified in epoch seconds.

    • lastLogin (integer) –

      The timestamp of the user’s last login to the network, specified in epoch seconds.

    • securityGroupIds (list) –

      A list of security group IDs to which the user belongs.

      • (string) –

Exceptions