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
command_inspection_service.proto
Source file from the latest descriptor snapshot.
identity_provider_config_service.proto
Source file from the latest descriptor snapshot.
object_meta.proto
Source file from the latest descriptor snapshot.
package_management_service.proto
Source file from the latest descriptor snapshot.
participant_pruning_service.proto
Source file from the latest descriptor snapshot.
party_management_service.proto
Source file from the latest descriptor snapshot.
user_management_service.proto
Source file from the latest 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.AllocateExternalPartyRequest
com.daml.ledger.api.v2.admin · 4 fields
synchronizerstringonboarding_transactionsrepeated SignedTransactionmulti_hash_signaturesrepeated Signatureidentity_provider_idstringAllocateExternalPartyRequest.SignedTransaction
com.daml.ledger.api.v2.admin · 2 fields
transactionbytessignaturesrepeated SignatureSignature
com.daml.ledger.api.v2 · 4 fields
formatSignatureFormatsignaturebytessigned_bystringsigning_algorithm_specSigningAlgorithmSpecSignatureFormat
com.daml.ledger.api.v2 · 5 values
SIGNATURE_FORMAT_UNSPECIFIEDSIGNATURE_FORMAT_RAWSIGNATURE_FORMAT_DERSIGNATURE_FORMAT_CONCATSIGNATURE_FORMAT_SYMBOLIC
SigningAlgorithmSpec
com.daml.ledger.api.v2 · 4 values
SIGNING_ALGORITHM_SPEC_UNSPECIFIEDSIGNING_ALGORITHM_SPEC_ED25519SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384
AllocateExternalPartyResponse
com.daml.ledger.api.v2.admin · 1 fields
party_idstringAllocatePartyRequest
com.daml.ledger.api.v2.admin · 5 fields
party_id_hintstringlocal_metadataObjectMetaidentity_provider_idstringsynchronizer_idstringuser_idstringObjectMeta
com.daml.ledger.api.v2.admin · 2 fields
resource_versionstringannotationsrepeated mapAllocatePartyResponse
com.daml.ledger.api.v2.admin · 1 fields
party_detailsPartyDetailsPartyDetails
com.daml.ledger.api.v2.admin · 4 fields
partystringis_localboollocal_metadataObjectMetaidentity_provider_idstringCommandStatus
com.daml.ledger.api.v2.admin · 7 fields
startedTimestampcompletedTimestampcompletionCompletionstateCommandStatecommandsrepeated Commandrequest_statisticsRequestStatisticsupdatesCommandUpdatesCompletion
com.daml.ledger.api.v2 · 11 fields
command_idstringstatusStatusupdate_idstringuser_idstringact_asrepeated stringsubmission_idstringdeduplication_offsetint64deduplication_durationDurationtrace_contextTraceContextoffsetint64synchronizer_timeSynchronizerTimeTraceContext
com.daml.ledger.api.v2 · 2 fields
traceparentstringtracestatestringSynchronizerTime
com.daml.ledger.api.v2 · 2 fields
synchronizer_idstringrecord_timeTimestampCommandState
com.daml.ledger.api.v2.admin · 4 values
COMMAND_STATE_UNSPECIFIEDCOMMAND_STATE_PENDINGCOMMAND_STATE_SUCCEEDEDCOMMAND_STATE_FAILED
Command
com.daml.ledger.api.v2 · 4 fields
createCreateCommandexerciseExerciseCommandexercise_by_keyExerciseByKeyCommandcreate_and_exerciseCreateAndExerciseCommandCreateCommand
com.daml.ledger.api.v2 · 2 fields
template_idIdentifiercreate_argumentsRecordIdentifier
com.daml.ledger.api.v2 · 3 fields
package_idstringmodule_namestringentity_namestringRecord
com.daml.ledger.api.v2 · 2 fields
record_idIdentifierfieldsrepeated RecordFieldRecordField
com.daml.ledger.api.v2 · 2 fields
labelstringvalueValueValue
com.daml.ledger.api.v2 · 16 fields
unitEmptyboolboolint64sint64dateint32timestampsfixed64numericstringpartystringtextstringcontract_idstringoptionalOptionallistListtext_mapTextMapgen_mapGenMaprecordRecordvariantVariantenumEnumOptional
com.daml.ledger.api.v2 · 1 fields
valueValueList
com.daml.ledger.api.v2 · 1 fields
elementsrepeated ValueTextMap
com.daml.ledger.api.v2 · 1 fields
entriesrepeated EntryTextMap.Entry
com.daml.ledger.api.v2 · 2 fields
keystringvalueValueGenMap
com.daml.ledger.api.v2 · 1 fields
entriesrepeated EntryGenMap.Entry
com.daml.ledger.api.v2 · 2 fields
keyValuevalueValueVariant
com.daml.ledger.api.v2 · 3 fields
variant_idIdentifierconstructorstringvalueValueEnum
com.daml.ledger.api.v2 · 2 fields
enum_idIdentifierconstructorstringExerciseCommand
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercontract_idstringchoicestringchoice_argumentValueExerciseByKeyCommand
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercontract_keyValuechoicestringchoice_argumentValueCreateAndExerciseCommand
com.daml.ledger.api.v2 · 4 fields
template_idIdentifiercreate_argumentsRecordchoicestringchoice_argumentValueRequestStatistics
com.daml.ledger.api.v2.admin · 3 fields
envelopesuint32request_sizeuint32recipientsuint32CommandUpdates
com.daml.ledger.api.v2.admin · 5 fields
createdrepeated Contractarchivedrepeated Contractexerciseduint32fetcheduint32looked_up_by_keyuint32Contract
com.daml.ledger.api.v2.admin · 3 fields
template_idIdentifiercontract_idstringcontract_keyValueCreateIdentityProviderConfigRequest
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_configIdentityProviderConfigIdentityProviderConfig
com.daml.ledger.api.v2.admin · 5 fields
identity_provider_idstringis_deactivatedboolissuerstringjwks_urlstringaudiencestringCreateIdentityProviderConfigResponse
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_configIdentityProviderConfigCreateUserRequest
com.daml.ledger.api.v2.admin · 2 fields
userUserrightsrepeated RightUser
com.daml.ledger.api.v2.admin · 5 fields
idstringprimary_partystringis_deactivatedboolmetadataObjectMetaidentity_provider_idstringRight
com.daml.ledger.api.v2.admin · 7 fields
participant_adminParticipantAdmincan_act_asCanActAscan_read_asCanReadAsidentity_provider_adminIdentityProviderAdmincan_read_as_any_partyCanReadAsAnyPartycan_execute_asCanExecuteAscan_execute_as_any_partyCanExecuteAsAnyPartyRight.ParticipantAdmin
com.daml.ledger.api.v2.admin · 0 fields
Right.CanActAs
com.daml.ledger.api.v2.admin · 1 fields
partystringRight.CanReadAs
com.daml.ledger.api.v2.admin · 1 fields
partystringRight.CanExecuteAs
com.daml.ledger.api.v2.admin · 1 fields
partystringRight.IdentityProviderAdmin
com.daml.ledger.api.v2.admin · 0 fields
Right.CanReadAsAnyParty
com.daml.ledger.api.v2.admin · 0 fields
Right.CanExecuteAsAnyParty
com.daml.ledger.api.v2.admin · 0 fields
CreateUserResponse
com.daml.ledger.api.v2.admin · 1 fields
userUserDeleteIdentityProviderConfigRequest
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_idstringDeleteIdentityProviderConfigResponse
com.daml.ledger.api.v2.admin · 0 fields
DeleteUserRequest
com.daml.ledger.api.v2.admin · 2 fields
user_idstringidentity_provider_idstringDeleteUserResponse
com.daml.ledger.api.v2.admin · 0 fields
GenerateExternalPartyTopologyRequest
com.daml.ledger.api.v2.admin · 7 fields
synchronizerstringparty_hintstringpublic_keySigningPublicKeylocal_participant_observation_onlyboolother_confirming_participant_uidsrepeated stringconfirmation_thresholduint32observing_participant_uidsrepeated stringSigningPublicKey
com.daml.ledger.api.v2 · 3 fields
formatCryptoKeyFormatkey_databyteskey_specSigningKeySpecCryptoKeyFormat
com.daml.ledger.api.v2 · 4 values
CRYPTO_KEY_FORMAT_UNSPECIFIEDCRYPTO_KEY_FORMAT_DERCRYPTO_KEY_FORMAT_RAWCRYPTO_KEY_FORMAT_DER_X509_SUBJECT_PUBLIC_KEY_INFO
SigningKeySpec
com.daml.ledger.api.v2 · 5 values
SIGNING_KEY_SPEC_UNSPECIFIEDSIGNING_KEY_SPEC_EC_CURVE25519SIGNING_KEY_SPEC_EC_P256SIGNING_KEY_SPEC_EC_P384SIGNING_KEY_SPEC_EC_SECP256K1
GenerateExternalPartyTopologyResponse
com.daml.ledger.api.v2.admin · 4 fields
party_idstringpublic_key_fingerprintstringtopology_transactionsrepeated bytesmulti_hashbytesGetCommandStatusRequest
com.daml.ledger.api.v2.admin · 3 fields
command_id_prefixstringstateCommandStatelimituint32GetCommandStatusResponse
com.daml.ledger.api.v2.admin · 1 fields
command_statusrepeated CommandStatusGetIdentityProviderConfigRequest
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_idstringGetIdentityProviderConfigResponse
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_configIdentityProviderConfigGetParticipantIdRequest
com.daml.ledger.api.v2.admin · 0 fields
GetParticipantIdResponse
com.daml.ledger.api.v2.admin · 1 fields
participant_idstringGetPartiesRequest
com.daml.ledger.api.v2.admin · 2 fields
partiesrepeated stringidentity_provider_idstringGetPartiesResponse
com.daml.ledger.api.v2.admin · 1 fields
party_detailsrepeated PartyDetailsGetUserRequest
com.daml.ledger.api.v2.admin · 2 fields
user_idstringidentity_provider_idstringGetUserResponse
com.daml.ledger.api.v2.admin · 1 fields
userUserGrantUserRightsRequest
com.daml.ledger.api.v2.admin · 3 fields
user_idstringrightsrepeated Rightidentity_provider_idstringGrantUserRightsResponse
com.daml.ledger.api.v2.admin · 1 fields
newly_granted_rightsrepeated RightListIdentityProviderConfigsRequest
com.daml.ledger.api.v2.admin · 0 fields
ListIdentityProviderConfigsResponse
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_configsrepeated IdentityProviderConfigListKnownPackagesRequest
com.daml.ledger.api.v2.admin · 0 fields
ListKnownPackagesResponse
com.daml.ledger.api.v2.admin · 1 fields
package_detailsrepeated PackageDetailsPackageDetails
com.daml.ledger.api.v2.admin · 5 fields
package_idstringpackage_sizeuint64known_sinceTimestampnamestringversionstringListKnownPartiesRequest
com.daml.ledger.api.v2.admin · 4 fields
page_tokenstringpage_sizeint32identity_provider_idstringfilter_partystringListKnownPartiesResponse
com.daml.ledger.api.v2.admin · 2 fields
party_detailsrepeated PartyDetailsnext_page_tokenstringListUserRightsRequest
com.daml.ledger.api.v2.admin · 2 fields
user_idstringidentity_provider_idstringListUserRightsResponse
com.daml.ledger.api.v2.admin · 1 fields
rightsrepeated RightListUsersRequest
com.daml.ledger.api.v2.admin · 3 fields
page_tokenstringpage_sizeint32identity_provider_idstringListUsersResponse
com.daml.ledger.api.v2.admin · 2 fields
usersrepeated Usernext_page_tokenstringPruneRequest
com.daml.ledger.api.v2.admin · 3 fields
prune_up_toint64submission_idstringprune_all_divulged_contractsboolPruneResponse
com.daml.ledger.api.v2.admin · 0 fields
RevokeUserRightsRequest
com.daml.ledger.api.v2.admin · 3 fields
user_idstringrightsrepeated Rightidentity_provider_idstringRevokeUserRightsResponse
com.daml.ledger.api.v2.admin · 1 fields
newly_revoked_rightsrepeated RightUpdateIdentityProviderConfigRequest
com.daml.ledger.api.v2.admin · 2 fields
identity_provider_configIdentityProviderConfigupdate_maskFieldMaskUpdateIdentityProviderConfigResponse
com.daml.ledger.api.v2.admin · 1 fields
identity_provider_configIdentityProviderConfigUpdatePartyDetailsRequest
com.daml.ledger.api.v2.admin · 2 fields
party_detailsPartyDetailsupdate_maskFieldMaskUpdatePartyDetailsResponse
com.daml.ledger.api.v2.admin · 1 fields
party_detailsPartyDetailsUpdatePartyIdentityProviderIdRequest
com.daml.ledger.api.v2.admin · 3 fields
partystringsource_identity_provider_idstringtarget_identity_provider_idstringUpdatePartyIdentityProviderIdResponse
com.daml.ledger.api.v2.admin · 0 fields
UpdateUserIdentityProviderIdRequest
com.daml.ledger.api.v2.admin · 3 fields
user_idstringsource_identity_provider_idstringtarget_identity_provider_idstringUpdateUserIdentityProviderIdResponse
com.daml.ledger.api.v2.admin · 0 fields
UpdateUserRequest
com.daml.ledger.api.v2.admin · 2 fields
userUserupdate_maskFieldMaskUpdateUserResponse
com.daml.ledger.api.v2.admin · 1 fields
userUserUpdateVettedPackagesRequest
com.daml.ledger.api.v2.admin · 5 fields
changesrepeated VettedPackagesChangedry_runboolsynchronizer_idstringexpected_topology_serialPriorTopologySerialupdate_vetted_packages_force_flagsrepeated UpdateVettedPackagesForceFlagVettedPackagesChange
com.daml.ledger.api.v2.admin · 2 fields
vetVetunvetUnvetVettedPackagesChange.Unvet
com.daml.ledger.api.v2.admin · 1 fields
packagesrepeated VettedPackagesRefVettedPackagesRef
com.daml.ledger.api.v2.admin · 3 fields
package_idstringpackage_namestringpackage_versionstringVettedPackagesChange.Vet
com.daml.ledger.api.v2.admin · 3 fields
packagesrepeated VettedPackagesRefnew_valid_from_inclusiveTimestampnew_valid_until_exclusiveTimestampPriorTopologySerial
com.daml.ledger.api.v2 · 2 fields
prioruint32no_priorEmptyUpdateVettedPackagesForceFlag
com.daml.ledger.api.v2.admin · 3 values
UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIEDUPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADESUPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES
UpdateVettedPackagesResponse
com.daml.ledger.api.v2.admin · 2 fields
past_vetted_packagesVettedPackagesnew_vetted_packagesVettedPackagesVettedPackages
com.daml.ledger.api.v2 · 4 fields
packagesrepeated VettedPackageparticipant_idstringsynchronizer_idstringtopology_serialuint32VettedPackage
com.daml.ledger.api.v2 · 5 fields
package_idstringvalid_from_inclusiveTimestampvalid_until_exclusiveTimestamppackage_namestringpackage_versionstringUploadDarFileRequest
com.daml.ledger.api.v2.admin · 4 fields
dar_filebytessubmission_idstringvetting_changeVettingChangesynchronizer_idstringUploadDarFileRequest.VettingChange
com.daml.ledger.api.v2.admin · 3 values
VETTING_CHANGE_UNSPECIFIEDVETTING_CHANGE_VET_ALL_PACKAGESVETTING_CHANGE_DONT_VET_ANY_PACKAGES
UploadDarFileResponse
com.daml.ledger.api.v2.admin · 0 fields
ValidateDarFileRequest
com.daml.ledger.api.v2.admin · 3 fields
dar_filebytessubmission_idstringsynchronizer_idstringValidateDarFileResponse
com.daml.ledger.api.v2.admin · 0 fields