Expand description
Generated Ledger API admin protobuf types (party & user management).
Modules§
- allocate_
external_ party_ request - Nested message and enum types in
AllocateExternalPartyRequest. - command_
inspection_ service_ client - Generated client implementations.
- identity_
provider_ config_ service_ client - Generated client implementations.
- package_
management_ service_ client - Generated client implementations.
- participant_
pruning_ service_ client - Generated client implementations.
- party_
management_ alpha_ service_ client - Generated client implementations.
- party_
management_ service_ client - Generated client implementations.
- party_
replication_ status - Nested message and enum types in
PartyReplicationStatus. - right
- Nested message and enum types in
Right. - upload_
dar_ file_ request - Nested message and enum types in
UploadDarFileRequest. - user_
management_ service_ client - Generated client implementations.
- vetted_
packages_ change - Nested message and enum types in
VettedPackagesChange.
Structs§
- AddParty
Arguments - AddParty
With AcsRequest - AddParty
With AcsResponse - Allocate
External Party Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id) - Allocate
External Party Response - Allocate
Party Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id) - Allocate
Party Response - Command
Status - Command
Updates - Contract
- Create
Identity Provider Config Request - Create
Identity Provider Config Response - Create
User Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id) - Create
User Response - Delete
Identity Provider Config Request - Delete
Identity Provider Config Response - Does not (yet) contain any data.
- Delete
User Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) - Delete
User Response - Does not (yet) contain any data.
- Export
Party AcsRequest - Export
Party AcsResponse - Generate
External Party Topology Request - Generate
External Party Topology Response - Response message with topology transactions and the multi-hash to be signed.
- GetAdd
Party Status Request - GetAdd
Party Status Response - GetCommand
Status Request - GetCommand
Status Response - GetIdentity
Provider Config Request - GetIdentity
Provider Config Response - GetParticipant
IdRequest - Required authorization:
HasRight(ParticipantAdmin) - GetParticipant
IdResponse - GetParties
Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) - GetParties
Response - GetUser
Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id) - GetUser
Response - Grant
User Rights Request - Add the rights to the set of rights granted to the user.
- Grant
User Rights Response - Identity
Provider Config - List
Identity Provider Configs Request - Pagination is not required as the resulting data set is small enough to be returned in a single call
- List
Identity Provider Configs Response - List
Known Packages Request - List
Known Packages Response - List
Known Parties Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) - List
Known Parties Response - List
User Rights Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id) - List
User Rights Response - List
Users Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) - List
Users Response - Object
Meta - Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party).
- Package
Details - Party
Details - Party
Replication Status - Describes the various lifecycle states of a party replication operation.
- Prune
Request - Prune
Response - Empty for now, but may contain fields in the future
- Request
Statistics - Revoke
User Rights Request - Remove the rights from the set of rights granted to the user.
- Revoke
User Rights Response - Right
- A right granted to a user.
- Timing
- Update
Identity Provider Config Request - Update
Identity Provider Config Response - Update
Party Details Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(party_details.identity_provider_id) - Update
Party Details Response - Update
Party Identity Provider IdRequest - Required authorization:
HasRight(ParticipantAdmin) - Update
Party Identity Provider IdResponse - Update
User Identity Provider IdRequest - Required authorization:
HasRight(ParticipantAdmin) - Update
User Identity Provider IdResponse - Update
User Request - Required authorization:
HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id) - Update
User Response - Update
Vetted Packages Request - Update
Vetted Packages Response - Upload
DarFile Request - Upload
DarFile Response - A message that is received when the upload operation succeeded.
- User
- Users are used to dynamically manage the rights given to Daml applications. They are stored and managed per participant node.
- Validate
DarFile Request - Performs the same checks that UploadDarFileRequest would perform, but doesn’t upload the DAR.
- Validate
DarFile Response - Vetted
Packages Change - A change to the set of vetted packages.
- Vetted
Packages Ref - A reference to identify one or more packages.