object users extends Helpful
- Annotations
- @Summary(s = "Manage Ledger Api Users", flag = FeatureFlag.Testing) @Group(name = "Ledger Api Users")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- users
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def create(id: String, actAs: Set[PartyId] = Set(), primaryParty: Option[PartyId] = None, readAs: Set[PartyId] = Set(), participantAdmin: Boolean = false, isActive: Boolean = true, annotations: Map[String, String] = Map.empty, identityProviderId: String = ""): User
- Annotations
- @Summary(s = "Create a user with the given id", flag = FeatureFlag.Testing) @Description(s = """Users are used to dynamically managing the rights given to Daml applications.
|They allow us to link a stable local identifier (of an application) with a set of parties.
id: the id used to identify the given user
actAs: the set of parties this user is allowed to act as
primaryParty: the optional party that should be linked to this user by default
readAs: the set of parties this user is allowed to read as
participantAdmin: flag (default false) indicating if the user is allowed to use the admin commands of the Ledger Api
isActive: flag (default true) indicating if the user is active
annotations: the set of key-value pairs linked to this user
identityProviderId: identity provider id
""")
- def delete(id: String, identityProviderId: String = ""): Unit
- Annotations
- @Summary(s = "Delete a user", flag = FeatureFlag.Testing) @Description(s = """Delete a user by id.
id: user id
identityProviderId: identity provider id""")
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def get(id: String, identityProviderId: String = ""): User
- Annotations
- @Summary(s = "Get the user data of the user with the given id", flag = FeatureFlag.Testing) @Description(s = """Fetch the data associated with the given user id failing if there is no such user.
|You will get the user's primary party, active status and annotations.
|If you need the user rights, use rights.list instead.
id: user id
identityProviderId: identity provider id""")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- Annotations
- @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def list(filterUser: String = "", pageToken: String = "", pageSize: Int = 100, identityProviderId: String = ""): UsersPage
- Annotations
- @Summary(s = "List users", flag = FeatureFlag.Testing) @Description(s = """List users of this participant node
filterUser: filter results using the given filter string
pageToken: used for pagination (the result contains a page token if there are further pages)
pageSize: default page size before the filter is applied
identityProviderId: identity provider id""")
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(id: String, modifier: (User) => User, identityProviderId: String = ""): User
- Annotations
- @Summary(s = "Update a user", flag = FeatureFlag.Testing) @Description(s = """Currently you can update the annotations, active status and primary party.
|You cannot update other user attributes.
id: id of the user to be updated
modifier: a function for modifying the user; e.g: `user => { user.copy(isActive = false, primaryParty = None, annotations = user.annotations.updated("a", "b").removed("c")) }`
identityProviderId: identity provider id
""")
- def update_idp(id: String, sourceIdentityProviderId: String, targetIdentityProviderId: String): Unit
- Annotations
- @Summary(s = "Update user's identity provider id", flag = FeatureFlag.Testing) @Description(s = """Updates user's identity provider id.
id: the id used to identify the given user
sourceIdentityProviderId: source identity provider id
targetIdentityProviderId: target identity provider id
""")
- 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])
- object rights extends Helpful
- Annotations
- @Summary(s = "Manage Ledger Api User Rights", flag = FeatureFlag.Testing) @Group(name = "Ledger Api User Rights")