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>"
}'
import json
import requests
url = "http://localhost:7575/v2/parties"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/parties', {
method: 'POST',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/parties',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
JSON,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "http://localhost:7575/v2/parties", bytes.NewBufferString(`{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}`))
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:7575/v2/parties"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/parties')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"partyDetails": {
"party": "<string>",
"isLocal": false,
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>"
}
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
POST /v2/parties
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.
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>"
}'
import json
import requests
url = "http://localhost:7575/v2/parties"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/parties', {
method: 'POST',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/parties',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
JSON,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "http://localhost:7575/v2/parties", bytes.NewBufferString(`{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}`))
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:7575/v2/parties"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/parties')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"partyDetails": {
"party": "<string>",
"isLocal": false,
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>"
}
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
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.
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>"
}'
import json
import requests
url = "http://localhost:7575/v2/parties"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}''')
response = requests.request(
"POST", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/parties', {
method: 'POST',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/parties',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
JSON,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
echo $response;
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "http://localhost:7575/v2/parties", bytes.NewBufferString(`{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}`))
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(req)
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var request = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:7575/v2/parties"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
"""))
.build();
var response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
require 'net/http'
require 'uri'
uri = URI('http://localhost:7575/v2/parties')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"partyIdHint": "<string>",
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"synchronizerId": "<string>",
"userId": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"partyDetails": {
"party": "<string>",
"isLocal": false,
"localMetadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>"
}
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
Authorizations
httpAuth
Authorization: Bearer <token>. Ledger API standard JWT tokenapiKeyAuth
Body
value.proto). OptionalObjectMeta.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#L640Show child attributes
Show child attributes
ObjectMeta message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. OptionalMap_String.A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a ’/’ (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a ’.’ (dot), ’-’ (dash) or ’_’ (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: https://developers.google.com/protocol-buffers/docs/proto3#maps Annotations may be a part of a modifiable resource. Use the resource’s update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. In order to remove an annotation using an update RPC, provide the target annotation’s key but set its value to the empty string in the update request. Modifiable Optional: can be emptyIdentity Provider If not set, assume the party is managed by the default identity provider or party is not hosted by the participant. OptionalResponses
200
Show child attributes
Show child attributes
value.proto). RequiredObjectMeta meta used in Kubernetes API. See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640Show child attributes
Show child attributes
ObjectMeta message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. OptionalIdentity Provider Optional, if not set, there could be 3 options: 1. the party is managed by the default identity provider. 2. party is not hosted by the participant. 3. party is hosted by the participant, but is outside of the user’s identity provider. Optional400
Invalid value, Invalid value for: bodydefault
History
3.5The POST /v2/parties operation was updated in this snapshot.
3.4