wickr/aws.sdk.kotlin.services.wickr.model/ListUsersRequest

ListUsersRequest

class ListUsersRequest

Types

object Companion

Properties

val firstName: String?

Filter results to only include users with first names matching this value.

val groupId: String?

Filter results to only include users belonging to this security group.

val lastName: String?

Filter results to only include users with last names matching this value.

val maxResults: Int?

The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

val networkId: String?

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

val nextToken: String?

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

val sortDirection: SortDirection?

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

val sortFields: String?

The fields to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'lastName', 'status', and 'groupId'.

val status: UserStatus?

Filter results to only include users with this status (1 for pending, 2 for active).

val username: String?

Filter results to only include users with usernames matching this value.

Functions

inline fun copy(block: ListUsersRequest.Builder.() -> Unit = {}): ListUsersRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String