Type Members

1.  final case class AuthenticatedUser(identityProviderId: IdentityProviderId, userId: String, participantId: Option[String], expiration: Option[Instant]) extends ClaimSet with Product with Serializable

   The representation of a user that was authenticated, but whose Claims have not yet been resolved.

2.  final case class Claims(claims: Seq[Claim], ledgerId: Option[String], participantId: Option[String], applicationId: Option[String], expiration: Option[Instant], identityProviderId: IdentityProviderId, resolvedFromUser: Boolean) 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.

   The precise authorization rules are documented in "//docs/source/app-dev/authorization.rst". Please use that file when writing or reviewing tests; and keep it up to date when adding new endpoints.

   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.

   identityProviderId

   If set, the claims will only be valid on the given Identity Provider configuration.

   resolvedFromUser

   If set, then the claims were resolved from a user in the user management service.