o

com.digitalasset.canton.ledger.api.auth

AuthServiceJWTCodec

object AuthServiceJWTCodec

Codec for writing and reading AuthServiceJWTPayload to and from JSON.

In general: - All custom claims are placed in a namespace field according to the OpenID Connect standard. - Access tokens use a Daml-specific scope to distinguish them from other access tokens issued by the same issuer for different systems or APIs. - All fields are optional in JSON for forward/backward compatibility reasons, where appropriate. - Extra JSON fields are ignored when reading. - Null values and missing JSON fields map to None or a safe default value (if there is one).

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthServiceJWTCodec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def compactPrint(v: AuthServiceJWTPayload, enforceFormat: Option[StandardJWTTokenFormat] = None): String

    Writes the given payload to a compact JSON string

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val logger: Logger
    Attributes
    protected
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final val oidcNamespace: String
  17. def readAudienceBasedToken(value: JsValue): AuthServiceJWTPayload
  18. def readFromString(value: String): Try[AuthServiceJWTPayload]
  19. def readScopeBasedToken(value: JsValue): AuthServiceJWTPayload
  20. final val scopeLedgerApiFull: String
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. def writeAudienceBasedPayload: (AuthServiceJWTPayload) => JsValue
  27. def writePayload: (AuthServiceJWTPayload) => JsValue
  28. def writeScopeBasedPayload: (AuthServiceJWTPayload) => JsValue
  29. object AudienceBasedTokenJsonImplicits extends DefaultJsonProtocol
  30. object JsonImplicits extends DefaultJsonProtocol
  31. object ScopeBasedTokenJsonImplicits extends DefaultJsonProtocol

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped