WickrAdminAPI / Client / list_devices_for_user

list_devices_for_user¶

WickrAdminAPI.Client.list_devices_for_user(**kwargs)¶

Retrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.

Request Syntax

response = client.list_devices_for_user(
    networkId='string',
    userId='string',
    nextToken='string',
    maxResults=123,
    sortFields='string',
    sortDirection='ASC'|'DESC'
)

Parameters:

networkId (string) –
[REQUIRED]

The ID of the Wickr network containing the user.
userId (string) –
[REQUIRED]

The unique identifier of the user whose devices will be listed.
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 devices to return in a single page. Valid range is 1-100. Default is 10.
sortFields (string) – The fields to sort devices by. Multiple fields can be specified by separating them with ‘+’. Accepted values include ‘lastlogin’, ‘type’, ‘suspend’, and ‘created’.
sortDirection (string) – The direction to sort results. Valid values are ‘ASC’ (ascending) or ‘DESC’ (descending). Default is ‘DESC’.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'devices': [
        {
            'appId': 'string',
            'created': 'string',
            'lastLogin': 'string',
            'statusText': 'string',
            'suspend': True|False,
            'type': '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.
- devices (list) –
  
  A list of device objects associated with the user within the current page.
  - (dict) –
    
    Represents a device where a user has logged into Wickr, containing information about the device’s type, status, and login history.
    - appId (string) –
      
      The unique application ID for the Wickr app on this device.
    - created (string) –
      
      The timestamp when the device first appeared in the Wickr database.
    - lastLogin (string) –
      
      The timestamp when the device last successfully logged into Wickr. This is also used to determine SSO idle time.
    - statusText (string) –
      
      The current status of the device, either ‘Active’ or ‘Reset’ depending on whether the device is currently active or has been marked for reset.
    - suspend (boolean) –
      
      Indicates whether the device is suspended.
    - type (string) –
      
      The operating system of the device (e.g., ‘MacOSX’, ‘Windows’, ‘iOS’, ‘Android’).

Exceptions

WickrAdminAPI.Client.exceptions.ValidationError
WickrAdminAPI.Client.exceptions.BadRequestError
WickrAdminAPI.Client.exceptions.ResourceNotFoundError
WickrAdminAPI.Client.exceptions.ForbiddenError
WickrAdminAPI.Client.exceptions.UnauthorizedError
WickrAdminAPI.Client.exceptions.InternalServerError
WickrAdminAPI.Client.exceptions.RateLimitError