Packages

case class Role(bindSecretId: Boolean = true, secretIdBoundCidrs: List[String] = List.empty, secretIdNumUses: Int = 0, secretIdTtl: Duration = Duration.Undefined, tokenPolicies: List[String] = List.empty, tokenTtl: Duration = Duration.Undefined, tokenMaxTtl: Duration = Duration.Undefined, tokenExplicitMaxTtl: Duration = Duration.Undefined, tokenPeriod: Duration = Duration.Undefined, tokenBoundCidrs: List[String] = List.empty, tokenNumUses: Int = 0, tokenNoDefaultPolicy: Boolean = false, tokenType: TokenType = TokenType.Service, enableLocalSecretIds: Boolean = false) extends Product with Serializable

bindSecretId

Require secret_id to be presented when logging in using this AppRole.

secretIdBoundCidrs

list of CIDR blocks; if set, specifies blocks of IP addresses which can perform the login operation.

secretIdNumUses

Number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

secretIdTtl

Duration in either an integer number of seconds (3600) or an integer time unit (60m) after which any SecretID expires.

tokenPolicies

list of policies set on tokens issued via this AppRole.

tokenTtl

Duration in either an integer number of seconds (3600) or an integer time unit (60m) to set as the TTL for issued tokens and at renewal time.

tokenMaxTtl

Duration in either an integer number of seconds (3600) or an integer time unit (60m) after which the issued token can no longer be renewed.

tokenExplicitMaxTtl

If set, will encode an explicit max TTL onto the token. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

tokenPeriod

Duration in either an integer number of seconds (3600) or an integer time unit (60m). If set, the token generated using this AppRole is a periodic token; so long as it is renewed it never expires, but the TTL set on the token at each renewal is fixed to the value specified here. If this value is modified, the token will pick up the new value at its next renewal.

tokenBoundCidrs

list of CIDR blocks; if set, specifies blocks of IP addresses which can use the auth tokens generated by this role.

tokenNumUses

Number of times issued tokens can be used. A value of 0 means unlimited uses.

tokenNoDefaultPolicy

If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in tokenPolicies.

tokenType

The type of token that should be generated via this role. Can be service, batch, or default to use the mount's default (which unless changed will be service tokens).

enableLocalSecretIds

If set, the secret IDs generated using this role will be cluster local. This can only be set during role creation and once set, it can't be reset later.

Source
Role.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Role
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. 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 Role(bindSecretId: Boolean = true, secretIdBoundCidrs: List[String] = List.empty, secretIdNumUses: Int = 0, secretIdTtl: Duration = Duration.Undefined, tokenPolicies: List[String] = List.empty, tokenTtl: Duration = Duration.Undefined, tokenMaxTtl: Duration = Duration.Undefined, tokenExplicitMaxTtl: Duration = Duration.Undefined, tokenPeriod: Duration = Duration.Undefined, tokenBoundCidrs: List[String] = List.empty, tokenNumUses: Int = 0, tokenNoDefaultPolicy: Boolean = false, tokenType: TokenType = TokenType.Service, enableLocalSecretIds: Boolean = false)

    bindSecretId

    Require secret_id to be presented when logging in using this AppRole.

    secretIdBoundCidrs

    list of CIDR blocks; if set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses

    Number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl

    Duration in either an integer number of seconds (3600) or an integer time unit (60m) after which any SecretID expires.

    tokenPolicies

    list of policies set on tokens issued via this AppRole.

    tokenTtl

    Duration in either an integer number of seconds (3600) or an integer time unit (60m) to set as the TTL for issued tokens and at renewal time.

    tokenMaxTtl

    Duration in either an integer number of seconds (3600) or an integer time unit (60m) after which the issued token can no longer be renewed.

    tokenExplicitMaxTtl

    If set, will encode an explicit max TTL onto the token. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

    tokenPeriod

    Duration in either an integer number of seconds (3600) or an integer time unit (60m). If set, the token generated using this AppRole is a periodic token; so long as it is renewed it never expires, but the TTL set on the token at each renewal is fixed to the value specified here. If this value is modified, the token will pick up the new value at its next renewal.

    tokenBoundCidrs

    list of CIDR blocks; if set, specifies blocks of IP addresses which can use the auth tokens generated by this role.

    tokenNumUses

    Number of times issued tokens can be used. A value of 0 means unlimited uses.

    tokenNoDefaultPolicy

    If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in tokenPolicies.

    tokenType

    The type of token that should be generated via this role. Can be service, batch, or default to use the mount's default (which unless changed will be service tokens).

    enableLocalSecretIds

    If set, the secret IDs generated using this role will be cluster local. This can only be set during role creation and once set, it can't be reset later.

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): (Role, B)
    Implicit
    This member is added by an implicit conversion from Role toArrowAssoc[Role] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val bindSecretId: Boolean
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val enableLocalSecretIds: Boolean
  9. def ensuring(cond: (Role) => Boolean, msg: => Any): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Role) => Boolean): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Role
    Implicit
    This member is added by an implicit conversion from Role toEnsuring[Role] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Role toStringFormat[Role] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val secretIdBoundCidrs: List[String]
  23. val secretIdNumUses: Int
  24. val secretIdTtl: Duration
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val tokenBoundCidrs: List[String]
  27. val tokenExplicitMaxTtl: Duration
  28. val tokenMaxTtl: Duration
  29. val tokenNoDefaultPolicy: Boolean
  30. val tokenNumUses: Int
  31. val tokenPeriod: Duration
  32. val tokenPolicies: List[String]
  33. val tokenTtl: Duration
  34. val tokenType: TokenType
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (Role, B)
    Implicit
    This member is added by an implicit conversion from Role toArrowAssoc[Role] 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromRole to StringFormat[Role]

Inherited by implicit conversion Ensuring fromRole to Ensuring[Role]

Inherited by implicit conversion ArrowAssoc fromRole to ArrowAssoc[Role]

Ungrouped