Documentation/canton-network-docs/Ledger APIOpenAPIView on canton-network-docs ↗
canton-network-docs/Ledger APIOpenAPI

POST /v2/parties

POST
/
v2
/
parties
Try it
POST /v2/parties

cURL

curl --request POST \
  --url https://api.example.com/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
400
default
{
  "partyDetails": {
    "party": "<string>",
    "isLocal": true,
    "localMetadata": {
      "resourceVersion": "<string>",
      "annotations": {}
    },
    "identityProviderId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Ledger API standard JWT token

Body

application/json

Required authorization: HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(identity_provider_id) OR IsAuthenticatedUser(user_id)

​
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
ObjectMeta · object

Formerly "display_name" Participant-local metadata to be stored in the PartyDetails of this newly allocated party.

Optional

Show child attributes

​
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

Response

200
application/json
​
partyDetails
PartyDetails · object
required

The allocated party details

Required

Show child attributes