Allocates a new party on a ledger and adds it to the set managed by the participant

POST /v2/parties

Request

curl --request POST \
  --url 'http://localhost:7575/v2/parties' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"partyIdHint":"string","localMetadata":{"resourceVersion":"string","annotations":{}},"identityProviderId":"string","synchronizerId":"string","userId":"string"}'

200 response

{
  "partyDetails": {
    "party": "string",
    "isLocal": false,
    "localMetadata": {},
    "identityProviderId": "string"
  }
}

JSON Ledger API

Allocates a new party on a ledger and adds it to the set managed by the participant

OpenAPISince 3.4Changed 3.5

Allocates a new party on a ledger and adds it to the set managed by the participant. Caller specifies a party identifier suggestion, the actual identifier allocated might be different and is implementation specific. Caller can specify party metadata that is stored locally on the participant. This call may: - Succeed, in which case the actual allocated identifier is visible in the response. - Respond with a gRPC error daml-on-kv-ledger: suggestion’s uniq…

Protocol Details

Inputs

Request body

application/json

partyIdHint · string

A hint to the participant which party ID to allocate. It can be ignored. Must be a valid PartyIdString (as described in value.proto). Optional

localMetadata · object

OpenAPI type: ObjectMeta.

Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party). Based on ObjectMeta meta used in Kubernetes API. See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640

identityProviderId · string

The id of the Identity Provider If not set, assume the party is managed by the default identity provider or party is not hosted by the participant. Optional

synchronizerId · string

The synchronizer, on which the party should be allocated. For backwards compatibility, this field may be omitted, if the participant is connected to only one synchronizer. Otherwise a synchronizer must be specified. Optional

userId · string

The user who will get the act_as rights to the newly allocated party. If set to an empty string (the default), no user will get rights to the party. Optional

Outputs

200

application/json

partyDetails · PartyDetails · required

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The POST /v2/parties operation changed in this snapshot.

Introduced3.4

Request

curl --request POST \
  --url 'http://localhost:7575/v2/parties' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"partyIdHint":"string","localMetadata":{"resourceVersion":"string","annotations":{}},"identityProviderId":"string","synchronizerId":"string","userId":"string"}'

200 response

{
  "partyDetails": {
    "party": "string",
    "isLocal": false,
    "localMetadata": {},
    "identityProviderId": "string"
  }
}