WickrAdminAPI / Paginator / ListBlockedGuestUsers

ListBlockedGuestUsers

class WickrAdminAPI.Paginator.ListBlockedGuestUsers
paginator = client.get_paginator('list_blocked_guest_users')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

  • networkId (string) –

    [REQUIRED]

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

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

  • sortFields (string) – The field to sort blocked guest users by. Accepted values include ‘username’, ‘admin’, and ‘modified’.

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

  • admin (string) – Filter results to only include blocked guest users that were blocked by this administrator.

  • 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

{
    'blocklist': [
        {
            'username': 'string',
            'admin': 'string',
            'modified': 'string',
            'usernameHash': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • blocklist (list) –

      A list of blocked guest user objects within the current page.

      • (dict) –

        Represents a guest user who has been blocked from accessing a Wickr network.

        • username (string) –

          The username of the blocked guest user.

        • admin (string) –

          The username of the administrator who blocked this guest user.

        • modified (string) –

          The timestamp when the guest user was blocked or last modified.

        • usernameHash (string) –

          The unique username hash identifier for the blocked guest user.

    • NextToken (string) –

      A token to resume pagination.