Documentation/canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesPartyManagementServiceView on canton-network-docs ↗
canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesPartyManagementService

AllocateParty

Ledger API›Protobuf›com.daml.ledger.api.v2.admin›AllocateParty

com.daml.ledger.api.v2.admin

​
AllocateParty

gRPCSince 3.4.0
RPC/com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty

​
Protocol Details

​
Inputs

​
AllocatePartyRequest

party_id_hintstring
local_metadataObjectMeta
identity_provider_idstring
synchronizer_idstring
user_idstring

​
Outputs

​
AllocatePartyResponse

party_detailsPartyDetails

​
Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.admin.AllocatePartyRequest

party_id_hintstring
local_metadataObjectMeta
identity_provider_idstring
synchronizer_idstring
user_idstring

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

resource_versionstring
annotationsrepeated map

com.daml.ledger.api.v2.admin.AllocatePartyResponse

party_detailsPartyDetails

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

partystring
is_localbool
local_metadataObjectMeta
identity_provider_idstring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.PartyManagementService/AllocateParty <<'EOF'
{
  "partyIdHint": "string",
  "localMetadata": {
    "resourceVersion": "string",
    "annotations": [
      {
        "key": "string"
      }
    ]
  },
  "identityProviderId": "string",
  "synchronizerId": "string",
  "userId": "string"
}
EOF
OKapplication/json
OK
{
  "partyDetails": {
    "party": "string",
    "isLocal": true,
    "localMetadata": {
      "resourceVersion": "string",
      "annotations": [
        {
          "key": "string"
        }
      ]
    },
    "identityProviderId": "string"
  }
}