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"}'

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

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

POST

parties

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"}'

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

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

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

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

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

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

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

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

required

400

text/plain

string

required

default

application/json

string

required

string

required

string

Map_String

required

Tuple2_String_String[]

integer (int32)

required

integer (int32)

string

boolean

History

Changed3.5

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

Introduced3.4

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"}'

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

{
  "code": "string",
  "cause": "string",
  "correlationId": "string",
  "traceId": "string",
  "context": {},
  "resources": [
    [
      "string"
    ]
  ],
  "errorCategory": 0,
  "grpcCodeValue": 0,
  "retryInfo": "string",
  "definiteAnswer": false
}

⌘I

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

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

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

Protocol Details

Inputs

Request body

Outputs

200

400

default

History

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

​Protocol Details

​Inputs

​Request body

​Outputs

​200

​400

​default

​History

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

Protocol Details

Inputs

Request body

Outputs

200

400

default

History