WickrAdminAPI / Client / list_blocked_guest_users

list_blocked_guest_users

WickrAdminAPI.Client.list_blocked_guest_users(**kwargs)

Retrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.

See also: AWS API Documentation

Request Syntax

response = client.list_blocked_guest_users(
    networkId='string',
    maxResults=123,
    sortDirection='ASC'|'DESC',
    sortFields='string',
    username='string',
    admin='string',
    nextToken='string'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of blocked guest users to return in a single page. Valid range is 1-100. Default is 10.

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

  • nextToken (string) – The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'blocklist': [
        {
            'username': 'string',
            'admin': 'string',
            'modified': 'string',
            'usernameHash': '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.

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

Exceptions