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
- Alphabetic
- By Inheritance
- Auth
- MountService
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Auth(path: String, uri: Uri, vaultClient: VaultClient[F])(implicit arg0: Concurrent[F], arg1: Client[F], token: Raw)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (Auth[F], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(path: String): F[TuneOptions]
- Definition Classes
- MountService
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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
- 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
- def ensuring(cond: (Auth[F]) => Boolean, msg: => Any): Auth[F]
- def ensuring(cond: (Auth[F]) => Boolean): Auth[F]
- def ensuring(cond: Boolean, msg: => Any): Auth[F]
- def ensuring(cond: Boolean): Auth[F]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val list: F[Map[String, Mounted]]
Lists all the mounts.
Lists all the mounts.
- Definition Classes
- MountService
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val path: String
- Definition Classes
- MountService
- 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
- Auth → MountService
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- 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
- val uri: Uri
- Definition Classes
- MountService
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- 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.