kotlin-client/com.couchbase.client.kotlin.manager.user/User

User

class User(username: String, displayName: String, @SinceCouchbase(value = "6.5") groups: Set<String>, roles: Set<Role>, password: String?)

A Couchbase Server user account.

Constructors

User

fun User(username: String, displayName: String = "", @SinceCouchbase(value = "6.5") groups: Set<String> = emptySet(), roles: Set<Role> = emptySet(), password: String? = null)

Functions

copy

fun copy(username: String = this.username, displayName: String = this.displayName, groups: Set<String> = this.groups, roles: Set<Role> = this.roles, password: String? = this.password): User

toString

open override fun toString(): String

Properties

displayName

val displayName: String

An optional descriptive name.

groups

val groups: Set<String>

Names of the groups this user belongs to. Adding a user to a group indirectly grants them the roles associated with the group.

password

val password: String? = null

The user's password. Always null when getting a user. Must be non-null when creating a user. May be null when updating a user, if the intent is to preserve the user's existing password.

roles

val roles: Set<Role>

Roles assigned directly to the user. Does not include roles inherited from groups. (If you're interested in inherited roles as well, see UserAndMetadata.effectiveRoles.)

username

val username: String