case class AuthServiceJWTPayload(ledgerId: Option[String], participantId: Option[String], applicationId: Option[String], exp: Option[Instant], admin: Boolean, actAs: List[String], readAs: List[String]) extends Product with Serializable
The JWT token payload used in AuthServiceJWT
- 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).
- Alphabetic
- By Inheritance
- AuthServiceJWTPayload
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
AuthServiceJWTPayload(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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val actAs: List[String]
- val admin: Boolean
- val applicationId: Option[String]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val exp: Option[Instant]
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val ledgerId: Option[String]
-
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 participantId: Option[String]
-
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.
- val readAs: List[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()