PATCH /v2/users/:user-id/rights

Revoke rights from a user. Revoking rights does not affect the resource version of the corresponding user.

PATCH /v2/users/{user-id}/rights

PATCH /v2/users/:user-id/rights

cURL

curl --request PATCH \
  --url https://api.example.com/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 requests

url = "https://api.example.com/v2/users/{user-id}/rights"

payload = {
    "userId": "<string>",
    "rights": [{ "kind": { "CanActAs": { "value": { "party": "<string>" } } } }],
    "identityProviderId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: '<string>',
    rights: [{kind: {CanActAs: {value: {party: '<string>'}}}}],
    identityProviderId: '<string>'
  })
};

fetch('https://api.example.com/v2/users/{user-id}/rights', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2/users/{user-id}/rights",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'userId' => '<string>',
    'rights' => [
        [
                'kind' => [
                                'CanActAs' => [
                                                                'value' => [
                                                                                                                                'party' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'identityProviderId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2/users/{user-id}/rights"

	payload := strings.NewReader("{\n  \"userId\": \"<string>\",\n  \"rights\": [\n    {\n      \"kind\": {\n        \"CanActAs\": {\n          \"value\": {\n            \"party\": \"<string>\"\n          }\n        }\n      }\n    }\n  ],\n  \"identityProviderId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/users/{user-id}/rights")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userId\": \"<string>\",\n  \"rights\": [\n    {\n      \"kind\": {\n        \"CanActAs\": {\n          \"value\": {\n            \"party\": \"<string>\"\n          }\n        }\n      }\n    }\n  ],\n  \"identityProviderId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/users/{user-id}/rights")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userId\": \"<string>\",\n  \"rights\": [\n    {\n      \"kind\": {\n        \"CanActAs\": {\n          \"value\": {\n            \"party\": \"<string>\"\n          }\n        }\n      }\n    }\n  ],\n  \"identityProviderId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "newlyRevokedRights": [
    {
      "kind": {
        "CanActAs": {
          "value": {
            "party": "<string>"
          }
        }
      }
    }
  ]
}

"<string>"

{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": 123,
  "correlationId": "<string>",
  "traceId": "<string>",
  "resources": [
    [
      "<string>"
    ]
  ],
  "grpcCodeValue": 123,
  "retryInfo": "<string>",
  "definiteAnswer": true
}

Authorizations

httpAuthapiKeyAuth

Authorization · string · header · required

Ledger API standard JWT token

Path Parameters

user-id · string · required

Body

application/json

Remove the rights from the set of rights granted to the user.

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

userId · string · required

The user from whom to revoke rights.

Required

rights · Right · object[]

The rights to revoke.

Optional: can be empty

Show child attributes

identityProviderId · string

The id of the Identity Provider If not set, assume the user is managed by the default identity provider.

Optional

Response

200

application/json

newlyRevokedRights · Right · object[]

The rights that were actually revoked by the request.

Optional: can be empty

Show child attributes