WickrAdminAPI / Paginator / ListDevicesForUser

ListDevicesForUser

class WickrAdminAPI.Paginator.ListDevicesForUser

paginator = client.get_paginator('list_devices_for_user')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WickrAdminAPI.Client.list_devices_for_user().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    networkId='string',
    userId='string',
    sortFields='string',
    sortDirection='ASC'|'DESC',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'devices': [
        {
            'appId': 'string',
            'created': 'string',
            'lastLogin': 'string',
            'statusText': 'string',
            'suspend': True|False,
            'type': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.