final class Token[F[_]] extends AnyRef
- Alphabetic
- By Inheritance
- Token
- AnyRef
- Any
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def ->[B](y: B): (Token[F], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val accessors: F[List[String]]
- returns
a list with all token accessor. This requires sudo capability, and access to it should be tightly controlled as the accessors can be used to revoke very large numbers of tokens and their associated leases at once.
- 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 create(options: CreateOptions): F[Auth]
Creates a new token.
Creates a new token. Certain options are only available when called by a root token. Orphan tokens require a root token to be created. However invoking
createOrphanallows one to be created without a root token. If a role is used, the token will be created against the specified role name; this may override options set during this call.- options
the options to use while creating the token.
- returns
the created token and its properties.
- def createOrphan(options: CreateOptions): F[Auth]
Creates a new token.
Creates a new token. Certain options are only available when called by a root token. If a role is used, the token will be created against the specified role name; this may override options set during this call.
- options
the options to use while creating the token.
- returns
the created token and its properties
- def createRole(role: String, options: CreateOptions): F[Auth]
Creates a new token.
Creates a new token. Certain options are only available when called by a root token. If a role is used, the token will be created against the specified role name; this may override options set during this call.
- options
the options to use while creating the token.
- returns
the created token and its properties
- def ensuring(cond: (Token[F]) => Boolean, msg: => Any): Token[F]
- def ensuring(cond: (Token[F]) => Boolean): Token[F]
- def ensuring(cond: Boolean, msg: => Any): Token[F]
- def ensuring(cond: Boolean): Token[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
- def listAccessorsWithRootPolicy: F[List[models.Token]]
Iterates through all token accessors, looks up the accessor and only returns the ones containing the root policy.
Iterates through all token accessors, looks up the accessor and only returns the ones containing the root policy. This is a very heavy operation. It should normally be invoked with a root token. And it is very helpful to clean dangling root tokens.
- def lookup(token: String): F[Option[models.Token]]
- token
the token for which to retrieve information.
- returns
returns information about the
token.
- def lookupAccessor(accessor: String): F[Option[models.Token]]
- accessor
the token accessor for which to retrieve the information.
- returns
returns information about the client token from the
accessor.
- val lookupSelf: F[models.Token]
- returns
returns information about the current client token.
- 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
- def renew(token: String, increment: Option[FiniteDuration] = None): F[Auth]
Renews a lease associated with a token.
Renews a lease associated with a token. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.
- token
the token to renew.
- increment
An optional requested lease increment can be provided. This increment may be ignored.
- returns
the renewed token information.
- def renewAccessor(accessor: String, increment: Option[FiniteDuration]): F[Auth]
Renews a lease associated with a token using its accessor.
Renews a lease associated with a token using its accessor. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.
- accessor
Accessor associated with the token to renew.
- increment
An optional requested lease increment can be provided.
- returns
returns information about the client token from the
accessor.
- def renewSelf(increment: Option[FiniteDuration] = None): F[Auth]
Renews a lease associated with the calling token.
Renews a lease associated with the calling token. This is used to prevent the expiration of a token, and the automatic revocation of it. Token renewal is possible only if there is a lease associated with it.
- increment
An optional requested lease increment can be provided. This increment may be ignored.
- returns
the renewed token information.
- def revoke(token: String): F[Unit]
Revokes a token and all child tokens.
Revokes a token and all child tokens. When the token is revoked, all dynamic secrets generated with it are also revoked.
- token
the token to revoke.
- def revokeAccessor(accessor: String): F[Unit]
Revoke the token associated with the accessor and all the child tokens.
Revoke the token associated with the accessor and all the child tokens. This is meant for purposes where there is no access to token ID but there is need to revoke a token and its children.
- accessor
Accessor of the token.
- val revokeSelf: F[Unit]
Revokes the token used to call it and all child tokens.
Revokes the token used to call it and all child tokens. When the token is revoked, all dynamic secrets generated with it are also revoked.
- def revokeTokenAndOrphanChildren(token: String): F[Unit]
Revokes a token but not its child tokens.
Revokes a token but not its child tokens. When the token is revoked, all secrets generated with it are also revoked. All child tokens are orphaned, but can be revoked sub-sequently using /auth/token/revoke/. This is a root-protected endpoint.
- token
Token to revoke.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- val uri: Uri
- 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()
- object roles extends RolesCRUD[F, Role]
Deprecated Value Members
- def →[B](y: B): (Token[F], B)
- Implicit
- This member is added by an implicit conversion from Token[F] toArrowAssoc[Token[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.