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

AllocateExternalParty

Ledger API›gRPC API›v2.admin›AllocateExternalParty

com.daml.ledger.api.v2.admin

​
AllocateExternalParty

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

​
Protocol Details

​
Inputs

​
AllocateExternalPartyRequest

synchronizerstring
onboarding_transactionsrepeated SignedTransaction
multi_hash_signaturesrepeated Signature
identity_provider_idstring
wait_for_allocationbool
user_idstring

​
Outputs

​
AllocateExternalPartyResponse

party_idstring

​
Lifecycle Changes

3.4.4introduced

com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest

synchronizerstring
onboarding_transactionsrepeated SignedTransaction
multi_hash_signaturesrepeated Signature
identity_provider_idstring
wait_for_allocationbool
user_idstring

com.daml.ledger.api.v2.admin.AllocateExternalPartyRequest.SignedTransaction

transactionbytes
signaturesrepeated Signature

com.daml.ledger.api.v2.Signature

formatSignatureFormat
signaturebytes
signed_bystring
signing_algorithm_specSigningAlgorithmSpec

com.daml.ledger.api.v2.SignatureFormat

  • SIGNATURE_FORMAT_UNSPECIFIED
  • SIGNATURE_FORMAT_RAW
  • SIGNATURE_FORMAT_DER
  • SIGNATURE_FORMAT_CONCAT
  • SIGNATURE_FORMAT_SYMBOLIC

com.daml.ledger.api.v2.SigningAlgorithmSpec

  • SIGNING_ALGORITHM_SPEC_UNSPECIFIED
  • SIGNING_ALGORITHM_SPEC_ED25519
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_256
  • SIGNING_ALGORITHM_SPEC_EC_DSA_SHA_384

com.daml.ledger.api.v2.admin.AllocateExternalPartyResponse

party_idstring
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.PartyManagementService/AllocateExternalParty <<'EOF'
{
  "synchronizer": "string",
  "onboardingTransactions": [
    {
      "transaction": "BASE64_ENCODED_BYTES",
      "signatures": [
        {
          "format": "SIGNATURE_FORMAT_UNSPECIFIED",
          "signature": "BASE64_ENCODED_BYTES",
          "signedBy": "string",
          "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED"
        }
      ]
    }
  ],
  "multiHashSignatures": [
    {
      "format": "SIGNATURE_FORMAT_UNSPECIFIED",
      "signature": "BASE64_ENCODED_BYTES",
      "signedBy": "string",
      "signingAlgorithmSpec": "SIGNING_ALGORITHM_SPEC_UNSPECIFIED"
    }
  ],
  "identityProviderId": "string",
  "waitForAllocation": true,
  "userId": "string"
}
EOF
OKapplication/json
OK
{
  "partyId": "string"
}