Type Members

1.  class AsyncUserManager extends AnyRef
2.  sealed trait AuthDomain extends AnyRef
3.  case class Group(name: String, description: String = "", roles: Seq[Role] = Seq(), ldapGroupReference: Option[String] = None) extends Product with Serializable

   Defines a set of roles that may be inherited by users.

   Defines a set of roles that may be inherited by users.

   name

   the groups' name

   description

   the group's description

   roles

   any roles associated with the group

4.  case class Origin(typ: String, name: Option[String] = None) extends Product with Serializable

   Indicates why the user has a specific role.

   Indicates why the user has a specific role.

   If the type is "user" it means the role is assigned directly to the user. If the type is "group" it means the role is inherited from the group identified by the "name" field.

   typ

   the type - "user" or "group"

   name

   only present if the type is "group"

5.  class ReactiveUserManager extends AnyRef
6.  case class Role(name: String, bucket: Option[String] = None, scope: Option[String] = None, collection: Option[String] = None) extends Product with Serializable

   Identifies a specific permission possessed by a user.

   Identifies a specific permission possessed by a user.

   name

   the role's name

   bucket

   the name of the bucket the role applies to. If empty, it is a system-wide role.

   scope

   the name of the scope the role applies to. If empty, the role applies to all scopes and collections on the bucket

   collection

   the name of the collection the role applies to. If empty, the role applies to all collections on the scope

7.  case class RoleAndDescription(role: Role, displayName: String, description: String) extends Product with Serializable

   Associates a role with its display name and description.

   Associates a role with its display name and description.

   role

   the role itself

   displayName

   the role's display name

   description

   the role's description

8.  case class RoleAndOrigins(role: Role, origins: Seq[Origin]) extends Product with Serializable

   Associates a role with its origins.

   Associates a role with its origins.

   role

   the role

   origins

   the role's origins

9.  case class User(username: String, displayName: String = "", groups: Seq[String] = Seq(), _roles: Seq[Role] = Seq(), password: Option[String] = None) extends Product with Serializable

   Models a Couchbase user.

   Models a Couchbase user.

   username

   the user's username

   displayName

   the user's display name

   groups

   any groups that the user belongs to

   _roles

   any roles directly assigned to the user (not those inherited through groups)

10.  case class UserAndMetadata(domain: AuthDomain, username: String, displayName: String, _effectiveRoles: Seq[RoleAndOrigins], _passwordChanged: Option[String] = None, groups: Seq[String] = Seq(), externalGroups: Seq[String] = Seq()) extends Product with Serializable

    Associates a User with any derived properties, such as the effective roles inherited from groups.

11.  class UserManager extends AnyRef