GetUsersResult

data class GetUsersResult(val active: Boolean? = null, val blocked: Boolean? = null, val createdAfter: String? = null, val createdBefore: String? = null, val excludeExternal: Boolean? = null, val excludeInternal: Boolean? = null, val externProvider: String? = null, val externUid: String? = null, val external: Boolean? = null, val id: String, val orderBy: String? = null, val search: String? = null, val sort: String? = null, val username: String? = null, val users: List<GetUsersUser>, val withoutProjectBots: Boolean? = null)

A collection of values returned by getUsers.

Constructors

Link copied to clipboard
constructor(active: Boolean? = null, blocked: Boolean? = null, createdAfter: String? = null, createdBefore: String? = null, excludeExternal: Boolean? = null, excludeInternal: Boolean? = null, externProvider: String? = null, externUid: String? = null, external: Boolean? = null, id: String, orderBy: String? = null, search: String? = null, sort: String? = null, username: String? = null, users: List<GetUsersUser>, withoutProjectBots: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val active: Boolean? = null

Filter users that are active.

Link copied to clipboard
val blocked: Boolean? = null

Filter users that are blocked.

Link copied to clipboard
val createdAfter: String? = null

Search for users created after a specific date. (Requires administrator privileges)

Link copied to clipboard
val createdBefore: String? = null

Search for users created before a specific date. (Requires administrator privileges)

Link copied to clipboard

Filters only non external users.

Link copied to clipboard

Filters only non internal users.

Link copied to clipboard
val external: Boolean? = null

Filters only external users.

Link copied to clipboard
val externProvider: String? = null

Lookup users by external provider. (Requires administrator privileges)

Link copied to clipboard
val externUid: String? = null

Lookup users by external UID. (Requires administrator privileges)

Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard
val orderBy: String? = null

Order the users' list by id, name, username, created_at or updated_at. (Requires administrator privileges)

Link copied to clipboard
val search: String? = null

Search users by username, name or email.

Link copied to clipboard
val sort: String? = null

Sort users' list in asc or desc order. (Requires administrator privileges)

Link copied to clipboard
val username: String? = null

Get a single user with a specific username.

Link copied to clipboard

The list of users.

Link copied to clipboard

Filters user without project bots.