Documentation Index
Fetch the complete documentation index at: https://docs.canton.network/llms.txt
Use this file to discover all available pages before exploring further.
Source Files
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
Current source file in the latest published descriptor snapshot.
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
Current source file in the latest published descriptor snapshot.
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto
Current source file in the latest published descriptor snapshot.
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto
Current source file in the latest published descriptor snapshot.
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto
Current source file in the latest published descriptor snapshot.
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto
Current source file in the latest published descriptor snapshot.
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto
Current source file in the latest published descriptor snapshot.
CommandInspectionService
IdentityProviderConfigService
IdentityProviderConfigService.CreateIdentityProviderConfig
rpc IdentityProviderConfigService.CreateIdentityProviderConfig(com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.CreateIden…
IdentityProviderConfigService.DeleteIdentityProviderConfig
rpc IdentityProviderConfigService.DeleteIdentityProviderConfig(com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.DeleteIden…
IdentityProviderConfigService.GetIdentityProviderConfig
rpc IdentityProviderConfigService.GetIdentityProviderConfig(com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.GetIdentityProvi…
IdentityProviderConfigService.ListIdentityProviderConfigs
rpc IdentityProviderConfigService.ListIdentityProviderConfigs(com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest) returns (com.daml.ledger.api.v2.admin.ListIdentity…
IdentityProviderConfigService.UpdateIdentityProviderConfig
rpc IdentityProviderConfigService.UpdateIdentityProviderConfig(com.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.UpdateIden…
PackageManagementService
PackageManagementService.ListKnownPackages
rpc PackageManagementService.ListKnownPackages(com.daml.ledger.api.v2.admin.ListKnownPackagesRequest) returns (com.daml.ledger.api.v2.admin.ListKnownPackagesResponse);
PackageManagementService.UpdateVettedPackages
rpc PackageManagementService.UpdateVettedPackages(com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest) returns (com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse);
PackageManagementService.UploadDarFile
rpc PackageManagementService.UploadDarFile(com.daml.ledger.api.v2.admin.UploadDarFileRequest) returns (com.daml.ledger.api.v2.admin.UploadDarFileResponse);
PackageManagementService.ValidateDarFile
rpc PackageManagementService.ValidateDarFile(com.daml.ledger.api.v2.admin.ValidateDarFileRequest) returns (com.daml.ledger.api.v2.admin.ValidateDarFileResponse);
ParticipantPruningService
PartyManagementService
PartyManagementService.AllocateExternalParty
rpc PartyManagementService.AllocateExternalParty(com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest) returns (com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse);
PartyManagementService.AllocateParty
rpc PartyManagementService.AllocateParty(com.daml.ledger.api.v2.admin.AllocatePartyRequest) returns (com.daml.ledger.api.v2.admin.AllocatePartyResponse);
PartyManagementService.GenerateExternalPartyTopology
rpc PartyManagementService.GenerateExternalPartyTopology(com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest) returns (com.daml.ledger.api.v2.admin.GenerateExterna…
PartyManagementService.GetParticipantId
rpc PartyManagementService.GetParticipantId(com.daml.ledger.api.v2.admin.GetParticipantIdRequest) returns (com.daml.ledger.api.v2.admin.GetParticipantIdResponse);
PartyManagementService.GetParties
rpc PartyManagementService.GetParties(com.daml.ledger.api.v2.admin.GetPartiesRequest) returns (com.daml.ledger.api.v2.admin.GetPartiesResponse);
PartyManagementService.ListKnownParties
rpc PartyManagementService.ListKnownParties(com.daml.ledger.api.v2.admin.ListKnownPartiesRequest) returns (com.daml.ledger.api.v2.admin.ListKnownPartiesResponse);
PartyManagementService.UpdatePartyDetails
rpc PartyManagementService.UpdatePartyDetails(com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest) returns (com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse);
PartyManagementService.UpdatePartyIdentityProviderId
rpc PartyManagementService.UpdatePartyIdentityProviderId(com.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest) returns (com.daml.ledger.api.v2.admin.UpdatePartyIden…
UserManagementService
UserManagementService.CreateUser
rpc UserManagementService.CreateUser(com.daml.ledger.api.v2.admin.CreateUserRequest) returns (com.daml.ledger.api.v2.admin.CreateUserResponse);
UserManagementService.DeleteUser
rpc UserManagementService.DeleteUser(com.daml.ledger.api.v2.admin.DeleteUserRequest) returns (com.daml.ledger.api.v2.admin.DeleteUserResponse);
UserManagementService.GetUser
rpc UserManagementService.GetUser(com.daml.ledger.api.v2.admin.GetUserRequest) returns (com.daml.ledger.api.v2.admin.GetUserResponse);
UserManagementService.GrantUserRights
rpc UserManagementService.GrantUserRights(com.daml.ledger.api.v2.admin.GrantUserRightsRequest) returns (com.daml.ledger.api.v2.admin.GrantUserRightsResponse);
UserManagementService.ListUserRights
rpc UserManagementService.ListUserRights(com.daml.ledger.api.v2.admin.ListUserRightsRequest) returns (com.daml.ledger.api.v2.admin.ListUserRightsResponse);
UserManagementService.ListUsers
rpc UserManagementService.ListUsers(com.daml.ledger.api.v2.admin.ListUsersRequest) returns (com.daml.ledger.api.v2.admin.ListUsersResponse);
UserManagementService.RevokeUserRights
rpc UserManagementService.RevokeUserRights(com.daml.ledger.api.v2.admin.RevokeUserRightsRequest) returns (com.daml.ledger.api.v2.admin.RevokeUserRightsResponse);
UserManagementService.UpdateUser
rpc UserManagementService.UpdateUser(com.daml.ledger.api.v2.admin.UpdateUserRequest) returns (com.daml.ledger.api.v2.admin.UpdateUserResponse);
UserManagementService.UpdateUserIdentityProviderId
rpc UserManagementService.UpdateUserIdentityProviderId(com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest) returns (com.daml.ledger.api.v2.admin.UpdateUserIdentity…
Type Inventory
These are the package-level message and enum shapes in the publish-version snapshot.com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest
4 fields
synchronizerstringonboarding_transactionsrepeated SignedTransactionmulti_hash_signaturesrepeated Signatureidentity_provider_idstringcom.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction
2 fields
transactionbytessignaturesrepeated Signaturecom.daml.ledger.api.v2.Signature
4 fields
formatSignatureFormatsignaturebytessigned_bystringsigning_algorithm_specSigningAlgorithmSpeccom.daml.ledger.api.v2.SignatureFormat
5 values
SIGNATURE_FORMAT_UNSPECIFIEDSIGNATURE_FORMAT_RAWSIGNATURE_FORMAT_DERSIGNATURE_FORMAT_CONCATSIGNATURE_FORMAT_SYMBOLIC
com.daml.ledger.api.v2.SigningAlgorithmSpec
4 values
SIGNING_ALGORITHM_SPEC_UNSPECIFIEDSIGNING_ALGORITHM_SPEC_ED25519SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse
1 fields
party_idstringcom.daml.ledger.api.v2.admin.AllocatePartyRequest
5 fields
party_id_hintstringlocal_metadataObjectMetaidentity_provider_idstringsynchronizer_idstringuser_idstringcom.daml.ledger.api.v2.admin.ObjectMeta
2 fields
resource_versionstringannotationsrepeated mapcom.daml.ledger.api.v2.admin.AllocatePartyResponse
1 fields
party_detailsPartyDetailscom.daml.ledger.api.v2.admin.PartyDetails
4 fields
partystringis_localboollocal_metadataObjectMetaidentity_provider_idstringcom.daml.ledger.api.v2.admin.CommandStatus
7 fields
startedTimestampcompletedTimestampcompletionCompletionstateCommandStatecommandsrepeated Commandrequest_statisticsRequestStatisticsupdatesCommandUpdatescom.daml.ledger.api.v2.Completion
11 fields
command_idstringstatusStatusupdate_idstringuser_idstringact_asrepeated stringsubmission_idstringdeduplication_offsetint64deduplication_durationDurationtrace_contextTraceContextoffsetint64synchronizer_timeSynchronizerTimecom.daml.ledger.api.v2.TraceContext
2 fields
traceparentstringtracestatestringcom.daml.ledger.api.v2.SynchronizerTime
2 fields
synchronizer_idstringrecord_timeTimestampcom.daml.ledger.api.v2.admin.CommandState
4 values
COMMAND_STATE_UNSPECIFIEDCOMMAND_STATE_PENDINGCOMMAND_STATE_SUCCEEDEDCOMMAND_STATE_FAILED
com.daml.ledger.api.v2.Command
4 fields
createCreateCommandexerciseExerciseCommandexercise_by_keyExerciseByKeyCommandcreate_and_exerciseCreateAndExerciseCommandcom.daml.ledger.api.v2.CreateCommand
2 fields
template_idIdentifiercreate_argumentsRecordcom.daml.ledger.api.v2.Identifier
3 fields
package_idstringmodule_namestringentity_namestringcom.daml.ledger.api.v2.Record
2 fields
record_idIdentifierfieldsrepeated RecordFieldcom.daml.ledger.api.v2.RecordField
2 fields
labelstringvalueValuecom.daml.ledger.api.v2.Value
16 fields
unitEmptyboolboolint64sint64dateint32timestampsfixed64numericstringpartystringtextstringcontract_idstringoptionalOptionallistListtext_mapTextMapgen_mapGenMaprecordRecordvariantVariantenumEnumcom.daml.ledger.api.v2.Optional
1 fields
valueValuecom.daml.ledger.api.v2.List
1 fields
elementsrepeated Valuecom.daml.ledger.api.v2.TextMap
1 fields
entriesrepeated Entrycom.daml.ledger.api.v2.TextMap.Entry
2 fields
keystringvalueValuecom.daml.ledger.api.v2.GenMap
1 fields
entriesrepeated Entrycom.daml.ledger.api.v2.GenMap.Entry
2 fields
keyValuevalueValuecom.daml.ledger.api.v2.Variant
3 fields
variant_idIdentifierconstructorstringvalueValuecom.daml.ledger.api.v2.Enum
2 fields
enum_idIdentifierconstructorstringcom.daml.ledger.api.v2.ExerciseCommand
4 fields
template_idIdentifiercontract_idstringchoicestringchoice_argumentValuecom.daml.ledger.api.v2.ExerciseByKeyCommand
4 fields
template_idIdentifiercontract_keyValuechoicestringchoice_argumentValuecom.daml.ledger.api.v2.CreateAndExerciseCommand
4 fields
template_idIdentifiercreate_argumentsRecordchoicestringchoice_argumentValuecom.daml.ledger.api.v2.admin.RequestStatistics
3 fields
envelopesuint32request_sizeuint32recipientsuint32com.daml.ledger.api.v2.admin.CommandUpdates
5 fields
createdrepeated Contractarchivedrepeated Contractexerciseduint32fetcheduint32looked_up_by_keyuint32com.daml.ledger.api.v2.admin.Contract
3 fields
template_idIdentifiercontract_idstringcontract_keyValuecom.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest
1 fields
identity_provider_configIdentityProviderConfigcom.daml.ledger.api.v2.admin.IdentityProviderConfig
5 fields
identity_provider_idstringis_deactivatedboolissuerstringjwks_urlstringaudiencestringcom.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse
1 fields
identity_provider_configIdentityProviderConfigcom.daml.ledger.api.v2.admin.CreateUserRequest
2 fields
userUserrightsrepeated Rightcom.daml.ledger.api.v2.admin.User
5 fields
idstringprimary_partystringis_deactivatedboolmetadataObjectMetaidentity_provider_idstringcom.daml.ledger.api.v2.admin.Right
7 fields
participant_adminParticipantAdmincan_act_asCanActAscan_read_asCanReadAsidentity_provider_adminIdentityProviderAdmincan_read_as_any_partyCanReadAsAnyPartycan_execute_asCanExecuteAscan_execute_as_any_partyCanExecuteAsAnyPartycom.daml.ledger.api.v2.admin.Right.ParticipantAdmin
0 fields
com.daml.ledger.api.v2.admin.Right.CanActAs
1 fields
partystringcom.daml.ledger.api.v2.admin.Right.CanReadAs
1 fields
partystringcom.daml.ledger.api.v2.admin.Right.CanExecuteAs
1 fields
partystringcom.daml.ledger.api.v2.admin.Right.IdentityProviderAdmin
0 fields
com.daml.ledger.api.v2.admin.Right.CanReadAsAnyParty
0 fields
com.daml.ledger.api.v2.admin.Right.CanExecuteAsAnyParty
0 fields
com.daml.ledger.api.v2.admin.CreateUserResponse
1 fields
userUsercom.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest
1 fields
identity_provider_idstringcom.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse
0 fields
com.daml.ledger.api.v2.admin.DeleteUserRequest
2 fields
user_idstringidentity_provider_idstringcom.daml.ledger.api.v2.admin.DeleteUserResponse
0 fields
com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest
7 fields
synchronizerstringparty_hintstringpublic_keySigningPublicKeylocal_participant_observation_onlyboolother_confirming_participant_uidsrepeated stringconfirmation_thresholduint32observing_participant_uidsrepeated stringcom.daml.ledger.api.v2.SigningPublicKey
3 fields
formatCryptoKeyFormatkey_databyteskey_specSigningKeySpeccom.daml.ledger.api.v2.CryptoKeyFormat
4 values
CRYPTO_KEY_FORMAT_UNSPECIFIEDCRYPTO_KEY_FORMAT_DERCRYPTO_KEY_FORMAT_RAWCRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
com.daml.ledger.api.v2.SigningKeySpec
5 values
SIGNING_KEY_SPEC_UNSPECIFIEDSIGNING_KEY_SPEC_EC_CURVE25519SIGNING_KEY_SPEC_EC_P256SIGNING_KEY_SPEC_EC_P384SIGNING_KEY_SPEC_EC_SECP256K1
com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse
4 fields
party_idstringpublic_key_fingerprintstringtopology_transactionsrepeated bytesmulti_hashbytescom.daml.ledger.api.v2.admin.GetCommandStatusRequest
3 fields
command_id_prefixstringstateCommandStatelimituint32com.daml.ledger.api.v2.admin.GetCommandStatusResponse
1 fields
command_statusrepeated CommandStatuscom.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest
1 fields
identity_provider_idstringcom.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse
1 fields
identity_provider_configIdentityProviderConfigcom.daml.ledger.api.v2.admin.GetParticipantIdRequest
0 fields
com.daml.ledger.api.v2.admin.GetParticipantIdResponse
1 fields
participant_idstringcom.daml.ledger.api.v2.admin.GetPartiesRequest
2 fields
partiesrepeated stringidentity_provider_idstringcom.daml.ledger.api.v2.admin.GetPartiesResponse
1 fields
party_detailsrepeated PartyDetailscom.daml.ledger.api.v2.admin.GetUserRequest
2 fields
user_idstringidentity_provider_idstringcom.daml.ledger.api.v2.admin.GetUserResponse
1 fields
userUsercom.daml.ledger.api.v2.admin.GrantUserRightsRequest
3 fields
user_idstringrightsrepeated Rightidentity_provider_idstringcom.daml.ledger.api.v2.admin.GrantUserRightsResponse
1 fields
newly_granted_rightsrepeated Rightcom.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest
0 fields
com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse
1 fields
identity_provider_configsrepeated IdentityProviderConfigcom.daml.ledger.api.v2.admin.ListKnownPackagesRequest
0 fields
com.daml.ledger.api.v2.admin.ListKnownPackagesResponse
1 fields
package_detailsrepeated PackageDetailscom.daml.ledger.api.v2.admin.PackageDetails
5 fields
package_idstringpackage_sizeuint64known_sinceTimestampnamestringversionstringcom.daml.ledger.api.v2.admin.ListKnownPartiesRequest
4 fields
page_tokenstringpage_sizeint32identity_provider_idstringfilter_partystringcom.daml.ledger.api.v2.admin.ListKnownPartiesResponse
2 fields
party_detailsrepeated PartyDetailsnext_page_tokenstringcom.daml.ledger.api.v2.admin.ListUserRightsRequest
2 fields
user_idstringidentity_provider_idstringcom.daml.ledger.api.v2.admin.ListUserRightsResponse
1 fields
rightsrepeated Rightcom.daml.ledger.api.v2.admin.ListUsersRequest
3 fields
page_tokenstringpage_sizeint32identity_provider_idstringcom.daml.ledger.api.v2.admin.ListUsersResponse
2 fields
usersrepeated Usernext_page_tokenstringcom.daml.ledger.api.v2.admin.PruneRequest
3 fields
prune_up_toint64submission_idstringprune_all_divulged_contractsboolcom.daml.ledger.api.v2.admin.PruneResponse
0 fields
com.daml.ledger.api.v2.admin.RevokeUserRightsRequest
3 fields
user_idstringrightsrepeated Rightidentity_provider_idstringcom.daml.ledger.api.v2.admin.RevokeUserRightsResponse
1 fields
newly_revoked_rightsrepeated Rightcom.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigRequest
2 fields
identity_provider_configIdentityProviderConfigupdate_maskFieldMaskcom.daml.ledger.api.v2.admin.UpdateIdentityProviderConfigResponse
1 fields
identity_provider_configIdentityProviderConfigcom.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest
2 fields
party_detailsPartyDetailsupdate_maskFieldMaskcom.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse
1 fields
party_detailsPartyDetailscom.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdRequest
3 fields
partystringsource_identity_provider_idstringtarget_identity_provider_idstringcom.daml.ledger.api.v2.admin.UpdatePartyIdentityProviderIdResponse
0 fields
com.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdRequest
3 fields
user_idstringsource_identity_provider_idstringtarget_identity_provider_idstringcom.daml.ledger.api.v2.admin.UpdateUserIdentityProviderIdResponse
0 fields
com.daml.ledger.api.v2.admin.UpdateUserRequest
2 fields
userUserupdate_maskFieldMaskcom.daml.ledger.api.v2.admin.UpdateUserResponse
1 fields
userUsercom.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest
5 fields
changesrepeated VettedPackagesChangedry_runboolsynchronizer_idstringexpected_topology_serialPriorTopologySerialupdate_vetted_packages_force_flagsrepeated UpdateVettedPackagesForceFlagcom.daml.ledger.api.v2.admin.VettedPackagesChange
2 fields
vetVetunvetUnvetcom.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet
1 fields
packagesrepeated VettedPackagesRefcom.daml.ledger.api.v2.admin.VettedPackagesRef
3 fields
package_idstringpackage_namestringpackage_versionstringcom.daml.ledger.api.v2.admin.VettedPackagesChange.Vet
3 fields
packagesrepeated VettedPackagesRefnew_valid_from_inclusiveTimestampnew_valid_until_exclusiveTimestampcom.daml.ledger.api.v2.PriorTopologySerial
2 fields
prioruint32no_priorEmptycom.daml.ledger.api.v2.admin.UpdateVettedPackagesForceFlag
3 values
UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIEDUPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADESUPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse
2 fields
past_vetted_packagesVettedPackagesnew_vetted_packagesVettedPackagescom.daml.ledger.api.v2.VettedPackages
4 fields
packagesrepeated VettedPackageparticipant_idstringsynchronizer_idstringtopology_serialuint32com.daml.ledger.api.v2.VettedPackage
5 fields
package_idstringvalid_from_inclusiveTimestampvalid_until_exclusiveTimestamppackage_namestringpackage_versionstringcom.daml.ledger.api.v2.admin.UploadDarFileRequest
4 fields
dar_filebytessubmission_idstringvetting_changeVettingChangesynchronizer_idstringcom.daml.ledger.api.v2.admin.UploadDarFileRequest.VettingChange
3 values
VETTING_CHANGE_UNSPECIFIEDVETTING_CHANGE_VET_ALL_PACKAGESVETTING_CHANGE_DONT_VET_ANY_PACKAGES
com.daml.ledger.api.v2.admin.UploadDarFileResponse
0 fields
com.daml.ledger.api.v2.admin.ValidateDarFileRequest
3 fields
dar_filebytessubmission_idstringsynchronizer_idstringcom.daml.ledger.api.v2.admin.ValidateDarFileResponse
0 fields