wickr/aws.sdk.kotlin.services.wickr/WickrClient/listGuestUsers

listGuestUsers

abstract suspend fun listGuestUsers(input: ListGuestUsersRequest): ListGuestUsersResponse

Retrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.

Samples

// Get paginated list of guest users
val resp = wickrClient.listGuestUsers {
    networkId = "12345678"
    maxResults = 20
    sortDirection = SortDirection.fromValue("DESC")
    sortFields = "billingPeriod"
}

// Filter by billing period
val resp = wickrClient.listGuestUsers {
    networkId = "12345678"
    billingPeriod = "2024-01"
    maxResults = 10
}

// Empty guest list
val resp = wickrClient.listGuestUsers {
    networkId = "87654321"
}