object ClaimSet
- Alphabetic
- By Inheritance
- ClaimSet
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
Claims(claims: Seq[Claim], ledgerId: Option[String] = None, participantId: Option[String] = None, applicationId: Option[String] = None, expiration: Option[Instant] = None) extends ClaimSet with Product with Serializable
Claims define what actions an authenticated user can perform on the Ledger API.
Claims define what actions an authenticated user can perform on the Ledger API.
They also optionally specify an expiration epoch time that statically specifies the time on or after which the token will no longer be considered valid by the Ledger API.
Please note that Health and ServerReflection services do NOT require authentication.
The following is a full list of services and the corresponding required claims: +-------------------------------------+----------------------------+------------------------------------------+
Ledger API service
Method
Access with
+-------------------------------------+----------------------------+------------------------------------------+
LedgerIdentityService
GetLedgerIdentity
isPublic
CommandSubmissionService
Submit
for submitting party p: canActAs(p)
CommandCompletionService
CompletionEnd
isPublic
CommandCompletionService
CompletionStream
for each requested party p: canReadAs(p)
CommandService
*
for submitting party p: canActAs(p)
Health
*
N/A (authentication not required)
LedgerConfigurationService
GetLedgerConfiguration
isPublic
PackageService
*
isPublic
PackageManagementService
*
isAdmin
PartyManagementService
*
isAdmin
ResetService
*
isAdmin
ServerReflection
*
N/A (authentication not required)
TimeService
GetTime
isPublic
TimeService
SetTime
isAdmin
TransactionService
LedgerEnd
isPublic
TransactionService
*
for each requested party p: canReadAs(p)
+-------------------------------------+----------------------------+------------------------------------------+
- claims
List of Claims describing the authorization this object describes.
- ledgerId
If set, the claims will only be valid on the given ledger identifier.
- participantId
If set, the claims will only be valid on the given participant identifier.
- applicationId
If set, the claims will only be valid on the given application identifier.
- expiration
If set, the claims will cease to be valid at the given time.
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
-
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
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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()
- object Claims extends Serializable
- object Unauthenticated extends ClaimSet