Packages

final case class JwtStaticClaim(claim: String = "", value: Seq[String] = _root_.scala.Seq.empty, pattern: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[JwtStaticClaim] with Product with Serializable

claim

The claim name needs to be a hardcoded literal (e.g. "role")

value

The value can be set as: a hardcoded literal (e.g. "admin"), an ENV variable (e.g "${ENV_VAR}") or a combination of both (e.g. "${ENV_VAR}-admin"). Providing multiple values means ALL of them will be required when validating and ALL will be included when signing.

pattern

This receives a regex expression (Java flavor) used to match on the incoming claim value. Cannot be used in conjunction with value field above. It's one or the other. NOTE: when signing, a static claim defined with a pattern will not be included in the token. Usage examples:

  • claim value is not empty: "&92;&92;S+"
  • claim value has one of 2 possible values: "^(admin|manager)$"
Annotations
@SerialVersionUID()
Source
JwtStaticClaim.scala
Linear Supertypes
Updatable[JwtStaticClaim], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JwtStaticClaim
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JwtStaticClaim(claim: String = "", value: Seq[String] = _root_.scala.Seq.empty, pattern: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    claim

    The claim name needs to be a hardcoded literal (e.g. "role")

    value

    The value can be set as: a hardcoded literal (e.g. "admin"), an ENV variable (e.g "${ENV_VAR}") or a combination of both (e.g. "${ENV_VAR}-admin"). Providing multiple values means ALL of them will be required when validating and ALL will be included when signing.

    pattern

    This receives a regex expression (Java flavor) used to match on the incoming claim value. Cannot be used in conjunction with value field above. It's one or the other. NOTE: when signing, a static claim defined with a pattern will not be included in the token. Usage examples:

    • claim value is not empty: "&92;&92;S+"
    • claim value has one of 2 possible values: "^(admin|manager)$"

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toany2stringadd[JwtStaticClaim] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JwtStaticClaim, B)
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toArrowAssoc[JwtStaticClaim] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAllValue(__vs: Iterable[String]): JwtStaticClaim
  7. def addValue(__vs: String*): JwtStaticClaim
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val claim: String
  10. def clearValue: JwtStaticClaim
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def companion: JwtStaticClaim.type
    Definition Classes
    JwtStaticClaim → GeneratedMessage
  13. def discardUnknownFields: JwtStaticClaim
  14. def ensuring(cond: (JwtStaticClaim) => Boolean, msg: => Any): JwtStaticClaim
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toEnsuring[JwtStaticClaim] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (JwtStaticClaim) => Boolean): JwtStaticClaim
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toEnsuring[JwtStaticClaim] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): JwtStaticClaim
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toEnsuring[JwtStaticClaim] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): JwtStaticClaim
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toEnsuring[JwtStaticClaim] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    JwtStaticClaim → GeneratedMessage
  21. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    JwtStaticClaim → GeneratedMessage
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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 pattern: String
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. def serializedSize: Int
    Definition Classes
    JwtStaticClaim → GeneratedMessage
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  31. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  32. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  33. def toProtoString: String
    Definition Classes
    JwtStaticClaim → GeneratedMessage
  34. val unknownFields: UnknownFieldSet
  35. def update(ms: (Lens[JwtStaticClaim, JwtStaticClaim]) => Mutation[JwtStaticClaim]*): JwtStaticClaim
    Definition Classes
    Updatable
  36. val value: Seq[String]
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. def withClaim(__v: String): JwtStaticClaim
  41. def withPattern(__v: String): JwtStaticClaim
  42. def withUnknownFields(__v: UnknownFieldSet): JwtStaticClaim
  43. def withValue(__v: Seq[String]): JwtStaticClaim
  44. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  45. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    JwtStaticClaim → GeneratedMessage
  46. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JwtStaticClaim toStringFormat[JwtStaticClaim] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromJwtStaticClaim to any2stringadd[JwtStaticClaim]

Inherited by implicit conversion StringFormat fromJwtStaticClaim to StringFormat[JwtStaticClaim]

Inherited by implicit conversion Ensuring fromJwtStaticClaim to Ensuring[JwtStaticClaim]

Inherited by implicit conversion ArrowAssoc fromJwtStaticClaim to ArrowAssoc[JwtStaticClaim]

Ungrouped