Documentation/canton-network-docs/Ledger APIgRPC APIPackagesv2.adminServicesPartyManagementServiceView on canton-network-docs ↗
canton-network-docs/Ledger APIgRPC APIPackagesv2.adminServicesPartyManagementService

ListKnownParties

Ledger API›gRPC API›v2.admin›ListKnownParties

com.daml.ledger.api.v2.admin

​
ListKnownParties

gRPCSince 3.4.4
RPC/com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties

​
Protocol Details

​
Inputs

​
ListKnownPartiesRequest

page_tokenstring
page_sizeint32
identity_provider_idstring
filter_partystring

​
Outputs

​
ListKnownPartiesResponse

party_detailsrepeated PartyDetails
next_page_tokenstring

​
Lifecycle Changes

3.4.4introduced

com.daml.ledger.api.v2.admin.ListKnownPartiesRequest

page_tokenstring
page_sizeint32
identity_provider_idstring
filter_partystring

com.daml.ledger.api.v2.admin.ListKnownPartiesResponse

party_detailsrepeated PartyDetails
next_page_tokenstring

com.daml.ledger.api.v2.admin.PartyDetails

partystring
is_localbool
local_metadataObjectMeta
identity_provider_idstring

com.daml.ledger.api.v2.admin.ObjectMeta

resource_versionstring
annotationsrepeated map
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.PartyManagementService/ListKnownParties <<'EOF'
{
  "pageToken": "string",
  "pageSize": 0,
  "identityProviderId": "string",
  "filterParty": "string"
}
EOF
OKapplication/json
OK
{
  "partyDetails": [
    {
      "party": "string",
      "isLocal": true,
      "localMetadata": {
        "resourceVersion": "string",
        "annotations": [
          {
            "key": "string"
          }
        ]
      },
      "identityProviderId": "string"
    }
  ],
  "nextPageToken": "string"
}