WickrAdminAPI / Client / update_guest_user

update_guest_user

WickrAdminAPI.Client.update_guest_user(**kwargs)

Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.

See also: AWS API Documentation

Request Syntax

response = client.update_guest_user(
    networkId='string',
    usernameHash='string',
    block=True|False
)
Parameters:

  • networkId (string) –

    [REQUIRED]

    The ID of the Wickr network where the guest user’s status will be updated.

  • usernameHash (string) –

    [REQUIRED]

    The username hash (unique identifier) of the guest user to update.

  • block (boolean) –

    [REQUIRED]

    Set to true to block the guest user or false to unblock them.

Return type:

dict

Returns:

Response Syntax

{
    'message': 'string'
}

Response Structure

  • (dict) –

    • message (string) –

      A message indicating the result of the update operation.

Exceptions