curl --request PATCH \
--url 'http://localhost:7575/v2/users/{user-id}/rights' \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}'
import json
import requests
url = "http://localhost:7575/v2/users/{user-id}/rights"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}''')
response = requests.request(
"PATCH", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/users/{user-id}/rights', {
method: 'PATCH',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/users/{user-id}/rights',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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("PATCH", "http://localhost:7575/v2/users/{user-id}/rights", bytes.NewBufferString(`{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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/users/{user-id}/rights"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("""
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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/users/{user-id}/rights')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"newlyRevokedRights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
]
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
PATCH /v2/users/:user-id/rights
Revoke rights from a user. Revoking rights does not affect the resource version of the corresponding user.
curl --request PATCH \
--url 'http://localhost:7575/v2/users/{user-id}/rights' \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}'
import json
import requests
url = "http://localhost:7575/v2/users/{user-id}/rights"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}''')
response = requests.request(
"PATCH", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/users/{user-id}/rights', {
method: 'PATCH',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/users/{user-id}/rights',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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("PATCH", "http://localhost:7575/v2/users/{user-id}/rights", bytes.NewBufferString(`{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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/users/{user-id}/rights"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("""
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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/users/{user-id}/rights')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"newlyRevokedRights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
]
}
<string>
{
"code": "<string>",
"cause": "<string>",
"correlationId": "<string>",
"traceId": "<string>",
"context": {},
"resources": [
[
"<string>"
]
],
"errorCategory": 123,
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": false
}
Revoke rights from a user. Revoking rights does not affect the resource version of the corresponding user.
curl --request PATCH \
--url 'http://localhost:7575/v2/users/{user-id}/rights' \
--header 'Authorization: Bearer $TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}'
import json
import requests
url = "http://localhost:7575/v2/users/{user-id}/rights"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}''')
response = requests.request(
"PATCH", url, headers=headers, json=payload
)
print(response.text)
const response = await fetch('http://localhost:7575/v2/users/{user-id}/rights', {
method: 'PATCH',
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}),
});
console.log(await response.text());
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'http://localhost:7575/v2/users/{user-id}/rights',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_POSTFIELDS => <<<'JSON'
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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("PATCH", "http://localhost:7575/v2/users/{user-id}/rights", bytes.NewBufferString(`{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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/users/{user-id}/rights"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("""
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<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/users/{user-id}/rights')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
"userId": "<string>",
"rights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<string>"
}
}
}
}
],
"identityProviderId": "<string>"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
http.request(request)
end
puts response.body
{
"newlyRevokedRights": [
{
"kind": {
"CanActAs": {
"value": {
"party": "<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
Path parameters
Body
Right[].The rights to revoke. Optional: can be emptyShow child attributes
Show child attributes
Kind.RequiredShow child attributes
Show child attributes
Show child attributes
Show child attributes
CanExecuteAs.Show child attributes
Show child attributes
CanExecuteAs1.Show child attributes
Show child attributes
Show child attributes
Show child attributes
CanExecuteAsAnyParty.The rights of a user to prepare and execute transactions as any party. Its utility is predominantly for users that perform interactive submissions on behalf of many parties.Show child attributes
Show child attributes
CanExecuteAsAnyParty1.The rights of a user to prepare and execute transactions as any party. Its utility is predominantly for users that perform interactive submissions on behalf of many parties.Show child attributes
Show child attributes
CanReadAsAnyParty.The rights of a participant’s super reader. Its utility is predominantly for feeding external tools, such as PQS, continually without the need to change subscriptions as new parties pop in and out of existence.Show child attributes
Show child attributes
CanReadAsAnyParty1.The rights of a participant’s super reader. Its utility is predominantly for feeding external tools, such as PQS, continually without the need to change subscriptions as new parties pop in and out of existence.Show child attributes
Show child attributes
IdentityProviderAdmin.The right to administer the identity provider that the user is assigned to. It means, being able to manage users and parties that are also assigned to the same identity provider.Show child attributes
Show child attributes
IdentityProviderAdmin1.The right to administer the identity provider that the user is assigned to. It means, being able to manage users and parties that are also assigned to the same identity provider.Identity Provider If not set, assume the user is managed by the default identity provider. OptionalResponses
200
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
400
Invalid value, Invalid value for: bodydefault
History
3.5The PATCH /v2/users/{user-id}/rights operation was updated in this snapshot.
3.4