Packages

final class Auth[F[_]] extends MountService[F, AuthMethod]

These endpoints require sudo capability in addition to any path-specific capabilities. However the same functionality can be achieved without sudo via the Mounts service.

Source
Auth.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Auth
  2. MountService
  3. AnyRef
  4. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Auth(path: String, uri: Uri, vaultClient: VaultClient[F])(implicit arg0: Concurrent[F], arg1: Client[F], token: Raw)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Auth[F], B)
    Implicit
    This member is added by an implicit conversion from Auth[F] toArrowAssoc[Auth[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def apply(path: String): F[TuneOptions]
    Definition Classes
    MountService
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def disable(path: String): F[Unit]

    Disables the mount point at path.

    Disables the mount point at path.

    path

    Specifies the path of the Mount that will be disabled.

    Definition Classes
    MountService
  9. def enable(path: String, mount: AuthMethod): F[Unit]

    Enables a new Mount at the given path.

    Enables a new Mount at the given path.

    path

    Specifies the path where the mount will be mounted.

    mount

    the Mount to enable.

    Definition Classes
    MountService
  10. def enableAndReturn(path: String, mount: AuthMethod): F[MountService.T.Out[F]]

    Enables a new Mount at the given path and returns the controller for it.

    Enables a new Mount at the given path and returns the controller for it.

    path

    Specifies the path where the Mount will be mounted.

    mount

    the Mount to enable.

    Definition Classes
    MountService
  11. def ensuring(cond: (Auth[F]) => Boolean, msg: => Any): Auth[F]
    Implicit
    This member is added by an implicit conversion from Auth[F] toEnsuring[Auth[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Auth[F]) => Boolean): Auth[F]
    Implicit
    This member is added by an implicit conversion from Auth[F] toEnsuring[Auth[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Auth[F]
    Implicit
    This member is added by an implicit conversion from Auth[F] toEnsuring[Auth[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Auth[F]
    Implicit
    This member is added by an implicit conversion from Auth[F] toEnsuring[Auth[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Auth[F] toStringFormat[Auth[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val list: F[Map[String, Mounted]]

    Lists all the mounts.

    Lists all the mounts.

    Definition Classes
    MountService
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val path: String
    Definition Classes
    MountService
  27. def remount(from: String, to: String): F[Unit]

    Moves an already-mounted backend to a new mount point.

    Moves an already-mounted backend to a new mount point.

    from

    Specifies the previous mount point.

    to

    Specifies the new destination mount point.

    Definition Classes
    AuthMountService
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. def tune(path: String, options: TuneOptions): F[Unit]

    Tunes configuration parameters for a given mount point.

    Tunes configuration parameters for a given mount point.

    path

    Specifies the path for the Mount.

    options

    the Mount tune options to tune.

    Definition Classes
    MountService
  31. def tuneOptions(path: String): F[Option[TuneOptions]]

    Reads the given mount's configuration.

    Reads the given mount's configuration.

    path

    Specifies the path for the secrets engine.

    Definition Classes
    MountService
  32. val uri: Uri
    Definition Classes
    MountService
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (Auth[F], B)
    Implicit
    This member is added by an implicit conversion from Auth[F] toArrowAssoc[Auth[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from MountService[F, AuthMethod]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromAuth[F] to StringFormat[Auth[F]]

Inherited by implicit conversion Ensuring fromAuth[F] to Ensuring[Auth[F]]

Inherited by implicit conversion ArrowAssoc fromAuth[F] to ArrowAssoc[Auth[F]]

Ungrouped