Complete documentation page mirrored and translated for learning. Attribution is shown at the bottom of each article.

阅读中文版

referencegrpc-ledger-api-referencecom-daml-ledger-api-v2-admin

v2.admin

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.

v2.admin

Package-level overview for com.daml.ledger.api.v2.admin.

Back to overview

Protobuf Package

v2.admin

6 services, 28 endpoints, 79 messages, 3 enums

gRPC
Files
7
<div class="x2mdx-ref-meta-item">
  <dt>Services</dt>
  <dd>6</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Endpoints</dt>
  <dd>28</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Messages</dt>
  <dd>79</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>Enums</dt>
  <dd>3</dd>
</div>

Source Files

command\_inspection\_service.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>7</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command\_inspection\_service.proto</a></dd>
  </div>
</dl>

identity\_provider\_config\_service.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>11</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity\_provider\_config\_service.proto</a></dd>
  </div>
</dl>

object\_meta.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object\_meta.proto</a></dd>
  </div>
</dl>

package\_management\_service.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>11</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package\_management\_service.proto</a></dd>
  </div>
</dl>

participant\_pruning\_service.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>2</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant\_pruning\_service.proto</a></dd>
  </div>
</dl>

party\_management\_service.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>17</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party\_management\_service.proto</a></dd>
  </div>
</dl>

user\_management\_service.proto

<p class="x2mdx-ref-card-summary">Source file from the latest descriptor snapshot.</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Services</dt>
    <dd>1</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Messages</dt>
    <dd>20</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Enums</dt>
    <dd>0</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Source</dt>
    <dd><a href="https://github.com/DACH-NY/canton/blob/v3.5.1/community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto">community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user\_management\_service.proto</a></dd>
  </div>
</dl>

CommandInspectionService

Operations
1

IdentityProviderConfigService

Operations
5

IdentityProviderConfigService.CreateIdentityProviderConfig

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc IdentityProviderConfigService.CreateIdentityProviderConfig(com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.CreateIden...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.CreateIdentityProviderConfigResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

IdentityProviderConfigService.DeleteIdentityProviderConfig

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc IdentityProviderConfigService.DeleteIdentityProviderConfig(com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.DeleteIden...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.DeleteIdentityProviderConfigResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

IdentityProviderConfigService.GetIdentityProviderConfig

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc IdentityProviderConfigService.GetIdentityProviderConfig(com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest) returns (com.daml.ledger.api.v2.admin.GetIdentityProvi...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.GetIdentityProviderConfigRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.GetIdentityProviderConfigResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

IdentityProviderConfigService.ListIdentityProviderConfigs

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc IdentityProviderConfigService.ListIdentityProviderConfigs(com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest) returns (com.daml.ledger.api.v2.admin.ListIdentity...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.ListIdentityProviderConfigsResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PackageManagementService

Operations
4

PackageManagementService.ListKnownPackages

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PackageManagementService.ListKnownPackages(com.daml.ledger.api.v2.admin.ListKnownPackagesRequest) returns (com.daml.ledger.api.v2.admin.ListKnownPackagesResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.ListKnownPackagesRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.ListKnownPackagesResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PackageManagementService.UpdateVettedPackages

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PackageManagementService.UpdateVettedPackages(com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest) returns (com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PackageManagementService.UploadDarFile

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PackageManagementService.UploadDarFile(com.daml.ledger.api.v2.admin.UploadDarFileRequest) returns (com.daml.ledger.api.v2.admin.UploadDarFileResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.UploadDarFileRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.UploadDarFileResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

ParticipantPruningService

Operations
1

PartyManagementService

Operations
8

PartyManagementService.AllocateExternalParty

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.AllocateExternalParty(com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest) returns (com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PartyManagementService.AllocateParty

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.AllocateParty(com.daml.ledger.api.v2.admin.AllocatePartyRequest) returns (com.daml.ledger.api.v2.admin.AllocatePartyResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.AllocatePartyRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.AllocatePartyResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PartyManagementService.GenerateExternalPartyTopology

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.GenerateExternalPartyTopology(com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest) returns (com.daml.ledger.api.v2.admin.GenerateExterna...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.GenerateExternalPartyTopologyResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PartyManagementService.GetParticipantId

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.GetParticipantId(com.daml.ledger.api.v2.admin.GetParticipantIdRequest) returns (com.daml.ledger.api.v2.admin.GetParticipantIdResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.GetParticipantIdRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.GetParticipantIdResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PartyManagementService.GetParties

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.GetParties(com.daml.ledger.api.v2.admin.GetPartiesRequest) returns (com.daml.ledger.api.v2.admin.GetPartiesResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.GetPartiesRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.GetPartiesResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PartyManagementService.ListKnownParties

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.ListKnownParties(com.daml.ledger.api.v2.admin.ListKnownPartiesRequest) returns (com.daml.ledger.api.v2.admin.ListKnownPartiesResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.ListKnownPartiesRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.ListKnownPartiesResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

PartyManagementService.UpdatePartyDetails

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc PartyManagementService.UpdatePartyDetails(com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest) returns (com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService

Operations
9

UserManagementService.CreateUser

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.CreateUser(com.daml.ledger.api.v2.admin.CreateUserRequest) returns (com.daml.ledger.api.v2.admin.CreateUserResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.CreateUserRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.CreateUserResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.DeleteUser

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.DeleteUser(com.daml.ledger.api.v2.admin.DeleteUserRequest) returns (com.daml.ledger.api.v2.admin.DeleteUserResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.DeleteUserRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.DeleteUserResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.GetUser

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.GetUser(com.daml.ledger.api.v2.admin.GetUserRequest) returns (com.daml.ledger.api.v2.admin.GetUserResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.GetUserRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.GetUserResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.GrantUserRights

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.GrantUserRights(com.daml.ledger.api.v2.admin.GrantUserRightsRequest) returns (com.daml.ledger.api.v2.admin.GrantUserRightsResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.GrantUserRightsRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.GrantUserRightsResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.ListUserRights

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.ListUserRights(com.daml.ledger.api.v2.admin.ListUserRightsRequest) returns (com.daml.ledger.api.v2.admin.ListUserRightsResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.ListUserRightsRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.ListUserRightsResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.ListUsers

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.ListUsers(com.daml.ledger.api.v2.admin.ListUsersRequest) returns (com.daml.ledger.api.v2.admin.ListUsersResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.ListUsersRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.ListUsersResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.RevokeUserRights

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.RevokeUserRights(com.daml.ledger.api.v2.admin.RevokeUserRightsRequest) returns (com.daml.ledger.api.v2.admin.RevokeUserRightsResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.RevokeUserRightsRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.RevokeUserRightsResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

UserManagementService.UpdateUser

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.4.4</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">rpc UserManagementService.UpdateUser(com.daml.ledger.api.v2.admin.UpdateUserRequest) returns (com.daml.ledger.api.v2.admin.UpdateUserResponse);</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>Request</dt>
    <dd>com.daml.ledger.api.v2.admin.UpdateUserRequest</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Response</dt>
    <dd>com.daml.ledger.api.v2.admin.UpdateUserResponse</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Client stream</dt>
    <dd>No</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>Server stream</dt>
    <dd>No</dd>
  </div>
</dl>

Type Inventory

These are the package-level message and enum shapes in the publish-version snapshot.

AllocateExternalPartyRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 6 fields</p>
synchronizer string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">onboarding\_transactions</code>
    <span class="x2mdx-ref-type-badge">repeated SignedTransaction</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">multi\_hash\_signatures</code>
    <span class="x2mdx-ref-type-badge">repeated Signature</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">wait\_for\_allocation</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">user\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

AllocateExternalPartyRequest.SignedTransaction

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
transaction bytes
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signatures</code>
    <span class="x2mdx-ref-type-badge">repeated Signature</span>
  </div>
</div>

Signature

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 fields</p>
format SignatureFormat
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signature</code>
    <span class="x2mdx-ref-type-badge">bytes</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signed\_by</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">signing\_algorithm\_spec</code>
    <span class="x2mdx-ref-type-badge">SigningAlgorithmSpec</span>
  </div>
</div>

SignatureFormat

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 5 values</p>
  • SIGNATURE\_FORMAT\_UNSPECIFIED
  • <li><code>SIGNATURE\_FORMAT\_RAW</code></li>
    
    <li><code>SIGNATURE\_FORMAT\_DER</code></li>
    
    <li><code>SIGNATURE\_FORMAT\_CONCAT</code></li>
    
    <li><code>SIGNATURE\_FORMAT\_SYMBOLIC</code></li>

SigningAlgorithmSpec

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 values</p>
  • SIGNING\_ALGORITHM\_SPEC\_UNSPECIFIED
  • <li><code>SIGNING\_ALGORITHM\_SPEC\_ED25519</code></li>
    
    <li><code>SIGNING\_ALGORITHM\_SPEC\_EC\_DSA\_SHA\_256</code></li>
    
    <li><code>SIGNING\_ALGORITHM\_SPEC\_EC\_DSA\_SHA\_384</code></li>

AllocateExternalPartyResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party\_id string

AllocatePartyRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 5 fields</p>
party\_id\_hint string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">local\_metadata</code>
    <span class="x2mdx-ref-type-badge">ObjectMeta</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">user\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ObjectMeta

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
resource\_version string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">annotations</code>
    <span class="x2mdx-ref-type-badge">repeated map</span>
  </div>
</div>

AllocatePartyResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party\_details PartyDetails

PartyDetails

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 4 fields</p>
party string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">is\_local</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">local\_metadata</code>
    <span class="x2mdx-ref-type-badge">ObjectMeta</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

CommandStatus

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 9 fields</p>
started Timestamp
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">completed</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">completion</code>
    <span class="x2mdx-ref-type-badge">Completion</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">state</code>
    <span class="x2mdx-ref-type-badge">CommandState</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">commands</code>
    <span class="x2mdx-ref-type-badge">repeated Command</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">request\_statistics</code>
    <span class="x2mdx-ref-type-badge">RequestStatistics</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">updates</code>
    <span class="x2mdx-ref-type-badge">CommandUpdates</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">timings</code>
    <span class="x2mdx-ref-type-badge">repeated Timing</span>
  </div>
</div>

Completion

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 12 fields</p>
command\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">status</code>
    <span class="x2mdx-ref-type-badge">Status</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">update\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">user\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">act\_as</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">submission\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">deduplication\_offset</code>
    <span class="x2mdx-ref-type-badge">int64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">deduplication\_duration</code>
    <span class="x2mdx-ref-type-badge">Duration</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">trace\_context</code>
    <span class="x2mdx-ref-type-badge">TraceContext</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">offset</code>
    <span class="x2mdx-ref-type-badge">int64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_time</code>
    <span class="x2mdx-ref-type-badge">SynchronizerTime</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">paid\_traffic\_cost</code>
    <span class="x2mdx-ref-type-badge">int64</span>
  </div>
</div>

TraceContext

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
traceparent string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">tracestate</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

SynchronizerTime

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
synchronizer\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">record\_time</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

CommandState

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 4 values</p>
  • COMMAND\_STATE\_UNSPECIFIED
  • <li><code>COMMAND\_STATE\_PENDING</code></li>
    
    <li><code>COMMAND\_STATE\_SUCCEEDED</code></li>
    
    <li><code>COMMAND\_STATE\_FAILED</code></li>

Command

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 fields</p>
create CreateCommand
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">exercise</code>
    <span class="x2mdx-ref-type-badge">ExerciseCommand</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">exercise\_by\_key</code>
    <span class="x2mdx-ref-type-badge">ExerciseByKeyCommand</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">create\_and\_exercise</code>
    <span class="x2mdx-ref-type-badge">CreateAndExerciseCommand</span>
  </div>
</div>

CreateCommand

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
template\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">create\_arguments</code>
    <span class="x2mdx-ref-type-badge">Record</span>
  </div>
</div>

Identifier

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 3 fields</p>
package\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">module\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">entity\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

Record

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
record\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">fields</code>
    <span class="x2mdx-ref-type-badge">repeated RecordField</span>
  </div>
</div>

RecordField

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
label string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Value

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 16 fields</p>
unit Empty
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">bool</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">int64</code>
    <span class="x2mdx-ref-type-badge">sint64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">date</code>
    <span class="x2mdx-ref-type-badge">int32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">timestamp</code>
    <span class="x2mdx-ref-type-badge">sfixed64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">numeric</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">party</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">text</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">optional</code>
    <span class="x2mdx-ref-type-badge">Optional</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">list</code>
    <span class="x2mdx-ref-type-badge">List</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">text\_map</code>
    <span class="x2mdx-ref-type-badge">TextMap</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">gen\_map</code>
    <span class="x2mdx-ref-type-badge">GenMap</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">record</code>
    <span class="x2mdx-ref-type-badge">Record</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">variant</code>
    <span class="x2mdx-ref-type-badge">Variant</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">enum</code>
    <span class="x2mdx-ref-type-badge">Enum</span>
  </div>
</div>

Optional

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
value Value

List

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
elements repeated Value

TextMap

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
entries repeated Entry

TextMap.Entry

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
key string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

GenMap

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 1 fields</p>
entries repeated Entry

GenMap.Entry

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
key Value
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Variant

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 3 fields</p>
variant\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">constructor</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">value</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Enum

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
enum\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">constructor</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ExerciseCommand

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 fields</p>
template\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice\_argument</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

ExerciseByKeyCommand

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 fields</p>
template\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_key</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice\_argument</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

CreateAndExerciseCommand

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 fields</p>
template\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">create\_arguments</code>
    <span class="x2mdx-ref-type-badge">Record</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">choice\_argument</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

RequestStatistics

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
envelopes uint32
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">request\_size</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">recipients</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

CommandUpdates

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 5 fields</p>
created repeated Contract
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">archived</code>
    <span class="x2mdx-ref-type-badge">repeated Contract</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">exercised</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">fetched</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">looked\_up\_by\_key</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

Contract

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
template\_id Identifier
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">contract\_key</code>
    <span class="x2mdx-ref-type-badge">Value</span>
  </div>
</div>

Timing

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
description string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">duration\_ms</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

CreateIdentityProviderConfigRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_config IdentityProviderConfig

IdentityProviderConfig

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 5 fields</p>
identity\_provider\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">is\_deactivated</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">issuer</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">jwks\_url</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">audience</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

CreateIdentityProviderConfigResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_config IdentityProviderConfig

CreateUserRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
user User
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">rights</code>
    <span class="x2mdx-ref-type-badge">repeated Right</span>
  </div>
</div>

User

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 6 fields</p>
id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">primary\_party</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">is\_deactivated</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">metadata</code>
    <span class="x2mdx-ref-type-badge">ObjectMeta</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">primary\_party\_authentication</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

Right

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 7 fields</p>
participant\_admin ParticipantAdmin
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">can\_act\_as</code>
    <span class="x2mdx-ref-type-badge">CanActAs</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">can\_read\_as</code>
    <span class="x2mdx-ref-type-badge">CanReadAs</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_admin</code>
    <span class="x2mdx-ref-type-badge">IdentityProviderAdmin</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">can\_read\_as\_any\_party</code>
    <span class="x2mdx-ref-type-badge">CanReadAsAnyParty</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">can\_execute\_as</code>
    <span class="x2mdx-ref-type-badge">CanExecuteAs</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">can\_execute\_as\_any\_party</code>
    <span class="x2mdx-ref-type-badge">CanExecuteAsAnyParty</span>
  </div>
</div>

Right.ParticipantAdmin

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

Right.CanActAs

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party string

Right.CanReadAs

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party string

Right.CanExecuteAs

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party string

Right.IdentityProviderAdmin

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

Right.CanReadAsAnyParty

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

Right.CanExecuteAsAnyParty

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

CreateUserResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
user User

DeleteIdentityProviderConfigRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_id string

DeleteIdentityProviderConfigResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

DeleteUserRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
user\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

DeleteUserResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

GenerateExternalPartyTopologyRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 7 fields</p>
synchronizer string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">party\_hint</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">public\_key</code>
    <span class="x2mdx-ref-type-badge">SigningPublicKey</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">local\_participant\_observation\_only</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">other\_confirming\_participant\_uids</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">confirmation\_threshold</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">observing\_participant\_uids</code>
    <span class="x2mdx-ref-type-badge">repeated string</span>
  </div>
</div>

SigningPublicKey

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 3 fields</p>
format CryptoKeyFormat
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key\_data</code>
    <span class="x2mdx-ref-type-badge">bytes</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">key\_spec</code>
    <span class="x2mdx-ref-type-badge">SigningKeySpec</span>
  </div>
</div>

CryptoKeyFormat

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 values</p>
  • CRYPTO\_KEY\_FORMAT\_UNSPECIFIED
  • <li><code>CRYPTO\_KEY\_FORMAT\_DER</code></li>
    
    <li><code>CRYPTO\_KEY\_FORMAT\_RAW</code></li>
    
    <li><code>CRYPTO\_KEY\_FORMAT\_DER\_X509\_SUBJECT\_PUBLIC\_KEY\_INFO</code></li>

SigningKeySpec

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 5 values</p>
  • SIGNING\_KEY\_SPEC\_UNSPECIFIED
  • <li><code>SIGNING\_KEY\_SPEC\_EC\_CURVE25519</code></li>
    
    <li><code>SIGNING\_KEY\_SPEC\_EC\_P256</code></li>
    
    <li><code>SIGNING\_KEY\_SPEC\_EC\_P384</code></li>
    
    <li><code>SIGNING\_KEY\_SPEC\_EC\_SECP256K1</code></li>

GenerateExternalPartyTopologyResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 4 fields</p>
party\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">public\_key\_fingerprint</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">topology\_transactions</code>
    <span class="x2mdx-ref-type-badge">repeated bytes</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">multi\_hash</code>
    <span class="x2mdx-ref-type-badge">bytes</span>
  </div>
</div>

GetCommandStatusRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
command\_id\_prefix string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">state</code>
    <span class="x2mdx-ref-type-badge">CommandState</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">limit</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

GetCommandStatusResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
command\_status repeated CommandStatus

GetIdentityProviderConfigRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_id string

GetIdentityProviderConfigResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_config IdentityProviderConfig

GetParticipantIdRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

GetParticipantIdResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
participant\_id string

GetPartiesRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
parties repeated string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

GetPartiesResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party\_details repeated PartyDetails

GetUserRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
user\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

GetUserResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
user User

GrantUserRightsRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
user\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">rights</code>
    <span class="x2mdx-ref-type-badge">repeated Right</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

GrantUserRightsResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
newly\_granted\_rights repeated Right

ListIdentityProviderConfigsRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

ListIdentityProviderConfigsResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_configs repeated IdentityProviderConfig

ListKnownPackagesRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

ListKnownPackagesResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
package\_details repeated PackageDetails

PackageDetails

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 5 fields</p>
package\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_size</code>
    <span class="x2mdx-ref-type-badge">uint64</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">known\_since</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">version</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ListKnownPartiesRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 4 fields</p>
page\_token string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">page\_size</code>
    <span class="x2mdx-ref-type-badge">int32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">filter\_party</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ListKnownPartiesResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
party\_details repeated PartyDetails
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">next\_page\_token</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ListUserRightsRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
user\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ListUserRightsResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
rights repeated Right

ListUsersRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
page\_token string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">page\_size</code>
    <span class="x2mdx-ref-type-badge">int32</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ListUsersResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
users repeated User
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">next\_page\_token</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

PruneRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
prune\_up\_to int64
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">submission\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">prune\_all\_divulged\_contracts</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

PruneResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

RevokeUserRightsRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
user\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">rights</code>
    <span class="x2mdx-ref-type-badge">repeated Right</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

RevokeUserRightsResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
newly\_revoked\_rights repeated Right

UpdateIdentityProviderConfigRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
identity\_provider\_config IdentityProviderConfig
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">update\_mask</code>
    <span class="x2mdx-ref-type-badge">FieldMask</span>
  </div>
</div>

UpdateIdentityProviderConfigResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
identity\_provider\_config IdentityProviderConfig

UpdatePartyDetailsRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
party\_details PartyDetails
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">update\_mask</code>
    <span class="x2mdx-ref-type-badge">FieldMask</span>
  </div>
</div>

UpdatePartyDetailsResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
party\_details PartyDetails

UpdatePartyIdentityProviderIdRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
party string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">source\_identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">target\_identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

UpdatePartyIdentityProviderIdResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

UpdateUserIdentityProviderIdRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
user\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">source\_identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">target\_identity\_provider\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

UpdateUserIdentityProviderIdResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

UpdateUserRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
user User
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">update\_mask</code>
    <span class="x2mdx-ref-type-badge">FieldMask</span>
  </div>
</div>

UpdateUserResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
user User

UpdateVettedPackagesRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 5 fields</p>
changes repeated VettedPackagesChange
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">dry\_run</code>
    <span class="x2mdx-ref-type-badge">bool</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">expected\_topology\_serial</code>
    <span class="x2mdx-ref-type-badge">PriorTopologySerial</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">update\_vetted\_packages\_force\_flags</code>
    <span class="x2mdx-ref-type-badge">repeated UpdateVettedPackagesForceFlag</span>
  </div>
</div>

VettedPackagesChange

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
vet Vet
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">unvet</code>
    <span class="x2mdx-ref-type-badge">Unvet</span>
  </div>
</div>

VettedPackagesChange.Unvet

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 1 fields</p>
packages repeated VettedPackagesRef

VettedPackagesRef

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
package\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_version</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

VettedPackagesChange.Vet

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
packages repeated VettedPackagesRef
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">new\_valid\_from\_inclusive</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">new\_valid\_until\_exclusive</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

PriorTopologySerial

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 2 fields</p>
prior uint32
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">no\_prior</code>
    <span class="x2mdx-ref-type-badge">Empty</span>
  </div>
</div>

UpdateVettedPackagesForceFlag

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 values</p>
  • UPDATE\_VETTED\_PACKAGES\_FORCE\_FLAG\_UNSPECIFIED
  • <li><code>UPDATE\_VETTED\_PACKAGES\_FORCE\_FLAG\_ALLOW\_VET\_INCOMPATIBLE\_UPGRADES</code></li>
    
    <li><code>UPDATE\_VETTED\_PACKAGES\_FORCE\_FLAG\_ALLOW\_UNVETTED\_DEPENDENCIES</code></li>

UpdateVettedPackagesResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 2 fields</p>
past\_vetted\_packages VettedPackages
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">new\_vetted\_packages</code>
    <span class="x2mdx-ref-type-badge">VettedPackages</span>
  </div>
</div>

VettedPackages

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 4 fields</p>
packages repeated VettedPackage
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">participant\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">topology\_serial</code>
    <span class="x2mdx-ref-type-badge">uint32</span>
  </div>
</div>

VettedPackage

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2 · 5 fields</p>
package\_id string
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">valid\_from\_inclusive</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">valid\_until\_exclusive</code>
    <span class="x2mdx-ref-type-badge">Timestamp</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_name</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">package\_version</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

UploadDarFileRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 4 fields</p>
dar\_file bytes
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">submission\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">vetting\_change</code>
    <span class="x2mdx-ref-type-badge">VettingChange</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

UploadDarFileRequest.VettingChange

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 values</p>
  • VETTING\_CHANGE\_UNSPECIFIED
  • <li><code>VETTING\_CHANGE\_VET\_ALL\_PACKAGES</code></li>
    
    <li><code>VETTING\_CHANGE\_DONT\_VET\_ANY\_PACKAGES</code></li>

UploadDarFileResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

ValidateDarFileRequest

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 3 fields</p>
dar\_file bytes
<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">submission\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

<div class="x2mdx-ref-field-row">
  <div class="x2mdx-ref-field-main">
    <code class="x2mdx-ref-field-name">synchronizer\_id</code>
    <span class="x2mdx-ref-type-badge">string</span>
  </div>
</div>

ValidateDarFileResponse

<p class="x2mdx-ref-schema-summary">com.daml.ledger.api.v2.admin · 0 fields</p>

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.