c

com.digitalasset.canton.ledger.api.auth

CustomDamlJWTPayload

final case class CustomDamlJWTPayload(ledgerId: Option[String], participantId: Option[String], applicationId: Option[String], exp: Option[Instant], admin: Boolean, actAs: List[String], readAs: List[String]) extends AuthServiceJWTPayload with Product with Serializable

A JWT token payload constructed from custom claims specific to Daml ledgers.

ledgerId

If set, the token is only valid for the given ledger ID. May also be used to fill in missing ledger ID fields in ledger API requests.

participantId

If set, the token is only valid for the given participant ID. May also be used to fill in missing participant ID fields in ledger API requests.

applicationId

If set, the token is only valid for the given application ID. May also be used to fill in missing application ID fields in ledger API requests.

exp

If set, the token is only valid before the given instant. Note: This is a registered claim in JWT

admin

Whether the token bearer is authorized to use admin endpoints of the ledger API.

actAs

List of parties the token bearer can act as. May also be used to fill in missing party fields in ledger API requests (e.g., submitter).

readAs

List of parties the token bearer can read data for. May also be used to fill in missing party fields in ledger API requests (e.g., transaction filter).

Linear Supertypes
AuthServiceJWTPayload, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CustomDamlJWTPayload
  2. AuthServiceJWTPayload
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CustomDamlJWTPayload(ledgerId: Option[String], participantId: Option[String], applicationId: Option[String], exp: Option[Instant], admin: Boolean, actAs: List[String], readAs: List[String])

    ledgerId

    If set, the token is only valid for the given ledger ID. May also be used to fill in missing ledger ID fields in ledger API requests.

    participantId

    If set, the token is only valid for the given participant ID. May also be used to fill in missing participant ID fields in ledger API requests.

    applicationId

    If set, the token is only valid for the given application ID. May also be used to fill in missing application ID fields in ledger API requests.

    exp

    If set, the token is only valid before the given instant. Note: This is a registered claim in JWT

    admin

    Whether the token bearer is authorized to use admin endpoints of the ledger API.

    actAs

    List of parties the token bearer can act as. May also be used to fill in missing party fields in ledger API requests (e.g., submitter).

    readAs

    List of parties the token bearer can read data for. May also be used to fill in missing party fields in ledger API requests (e.g., transaction filter).

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. val actAs: List[String]
  5. val admin: Boolean
  6. val applicationId: Option[String]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val exp: Option[Instant]
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val ledgerId: Option[String]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. val participantId: Option[String]
  18. def party: Option[String]

    If this token is associated with exactly one party, returns that party name.

    If this token is associated with exactly one party, returns that party name. Otherwise, returns None.

  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val readAs: List[String]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from AuthServiceJWTPayload

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped