final case class DeclarativeUserConfig(user: String, primaryParty: Option[String] = None, isDeactivated: Boolean = false, annotations: Map[String, String] = Map.empty, identityProviderId: String = "", rights: DeclarativeUserRightsConfig = DeclarativeUserRightsConfig())(resourceVersion: String = "") extends UniformCantonConfigValidation with Product with Serializable
Declaratively control users
- user
the user id
- primaryParty
the primary party that should be used for the user
- isDeactivated
if true then the user is deactivatedd
- annotations
a property bag of annotations that can be stored alongside the user
- identityProviderId
the idp of the given user
- rights
the rights granted to the party
- Alphabetic
- By Inheritance
- DeclarativeUserConfig
- Serializable
- Product
- Equals
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DeclarativeUserConfig(user: String, primaryParty: Option[String] = None, isDeactivated: Boolean = false, annotations: Map[String, String] = Map.empty, identityProviderId: String = "", rights: DeclarativeUserRightsConfig = DeclarativeUserRightsConfig())(resourceVersion: String = "")
- user
the user id
- primaryParty
the primary party that should be used for the user
- isDeactivated
if true then the user is deactivatedd
- annotations
a property bag of annotations that can be stored alongside the user
- identityProviderId
the idp of the given user
- rights
the rights granted to the party
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 annotations: Map[String, String]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]
Returns all validation errors that are specific to this Canton configuration class.
Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.
Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.
- Attributes
- protected
- Definition Classes
- UniformCantonConfigValidation → CustomCantonConfigValidation
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val identityProviderId: String
- val isDeactivated: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapPartiesToNamespace(namespace: Namespace, filterParty: (String) => Boolean): DeclarativeUserConfig
map party names to namespace and filter out parties that are not yet registered
map party names to namespace and filter out parties that are not yet registered
the ledger api server needs to know the parties that we add to a user. that requires a synchronizer connection. therefore, we filter here the parties that are not yet registered as otherwise the ledger api server will throw errors
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def needsUserChange(other: DeclarativeUserConfig): Boolean
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val primaryParty: Option[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val resourceVersion: String
- val rights: DeclarativeUserRightsConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val user: String
- final def validate[T >: DeclarativeUserConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
- Definition Classes
- CantonConfigValidation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])