PATCH /v2/users/:user-id
curl --request PATCH \
--url https://api.example.com/v2/users/{user-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": {
"id": "<string>",
"primaryParty": "<string>",
"isDeactivated": true,
"metadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"primaryPartyAuthentication": true
},
"updateMask": {
"unknownFields": {
"fields": {}
},
"paths": [
"<string>"
]
}
}
'import requests
url = "https://api.example.com/v2/users/{user-id}"
payload = {
"user": {
"id": "<string>",
"primaryParty": "<string>",
"isDeactivated": True,
"metadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"primaryPartyAuthentication": True
},
"updateMask": {
"unknownFields": { "fields": {} },
"paths": ["<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({
user: {
id: '<string>',
primaryParty: '<string>',
isDeactivated: true,
metadata: {resourceVersion: '<string>', annotations: {}},
identityProviderId: '<string>',
primaryPartyAuthentication: true
},
updateMask: {unknownFields: {fields: {}}, paths: ['<string>']}
})
};
fetch('https://api.example.com/v2/users/{user-id}', 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}",
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([
'user' => [
'id' => '<string>',
'primaryParty' => '<string>',
'isDeactivated' => true,
'metadata' => [
'resourceVersion' => '<string>',
'annotations' => [
]
],
'identityProviderId' => '<string>',
'primaryPartyAuthentication' => true
],
'updateMask' => [
'unknownFields' => [
'fields' => [
]
],
'paths' => [
'<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}"
payload := strings.NewReader("{\n \"user\": {\n \"id\": \"<string>\",\n \"primaryParty\": \"<string>\",\n \"isDeactivated\": true,\n \"metadata\": {\n \"resourceVersion\": \"<string>\",\n \"annotations\": {}\n },\n \"identityProviderId\": \"<string>\",\n \"primaryPartyAuthentication\": true\n },\n \"updateMask\": {\n \"unknownFields\": {\n \"fields\": {}\n },\n \"paths\": [\n \"<string>\"\n ]\n }\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}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": {\n \"id\": \"<string>\",\n \"primaryParty\": \"<string>\",\n \"isDeactivated\": true,\n \"metadata\": {\n \"resourceVersion\": \"<string>\",\n \"annotations\": {}\n },\n \"identityProviderId\": \"<string>\",\n \"primaryPartyAuthentication\": true\n },\n \"updateMask\": {\n \"unknownFields\": {\n \"fields\": {}\n },\n \"paths\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/users/{user-id}")
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 \"user\": {\n \"id\": \"<string>\",\n \"primaryParty\": \"<string>\",\n \"isDeactivated\": true,\n \"metadata\": {\n \"resourceVersion\": \"<string>\",\n \"annotations\": {}\n },\n \"identityProviderId\": \"<string>\",\n \"primaryPartyAuthentication\": true\n },\n \"updateMask\": {\n \"unknownFields\": {\n \"fields\": {}\n },\n \"paths\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "<string>",
"primaryParty": "<string>",
"isDeactivated": true,
"metadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"primaryPartyAuthentication": true
}
}"<string>"{
"code": "<string>",
"cause": "<string>",
"context": {},
"errorCategory": 123,
"correlationId": "<string>",
"traceId": "<string>",
"resources": [
[
"<string>"
]
],
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": true
}PATCH /v2/users/:user-id
Update selected modifiable attribute of a user resource described by the User message.
PATCH
/
v2
/
users
/
{user-id}
PATCH /v2/users/:user-id
curl --request PATCH \
--url https://api.example.com/v2/users/{user-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": {
"id": "<string>",
"primaryParty": "<string>",
"isDeactivated": true,
"metadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"primaryPartyAuthentication": true
},
"updateMask": {
"unknownFields": {
"fields": {}
},
"paths": [
"<string>"
]
}
}
'import requests
url = "https://api.example.com/v2/users/{user-id}"
payload = {
"user": {
"id": "<string>",
"primaryParty": "<string>",
"isDeactivated": True,
"metadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"primaryPartyAuthentication": True
},
"updateMask": {
"unknownFields": { "fields": {} },
"paths": ["<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({
user: {
id: '<string>',
primaryParty: '<string>',
isDeactivated: true,
metadata: {resourceVersion: '<string>', annotations: {}},
identityProviderId: '<string>',
primaryPartyAuthentication: true
},
updateMask: {unknownFields: {fields: {}}, paths: ['<string>']}
})
};
fetch('https://api.example.com/v2/users/{user-id}', 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}",
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([
'user' => [
'id' => '<string>',
'primaryParty' => '<string>',
'isDeactivated' => true,
'metadata' => [
'resourceVersion' => '<string>',
'annotations' => [
]
],
'identityProviderId' => '<string>',
'primaryPartyAuthentication' => true
],
'updateMask' => [
'unknownFields' => [
'fields' => [
]
],
'paths' => [
'<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}"
payload := strings.NewReader("{\n \"user\": {\n \"id\": \"<string>\",\n \"primaryParty\": \"<string>\",\n \"isDeactivated\": true,\n \"metadata\": {\n \"resourceVersion\": \"<string>\",\n \"annotations\": {}\n },\n \"identityProviderId\": \"<string>\",\n \"primaryPartyAuthentication\": true\n },\n \"updateMask\": {\n \"unknownFields\": {\n \"fields\": {}\n },\n \"paths\": [\n \"<string>\"\n ]\n }\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}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": {\n \"id\": \"<string>\",\n \"primaryParty\": \"<string>\",\n \"isDeactivated\": true,\n \"metadata\": {\n \"resourceVersion\": \"<string>\",\n \"annotations\": {}\n },\n \"identityProviderId\": \"<string>\",\n \"primaryPartyAuthentication\": true\n },\n \"updateMask\": {\n \"unknownFields\": {\n \"fields\": {}\n },\n \"paths\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/users/{user-id}")
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 \"user\": {\n \"id\": \"<string>\",\n \"primaryParty\": \"<string>\",\n \"isDeactivated\": true,\n \"metadata\": {\n \"resourceVersion\": \"<string>\",\n \"annotations\": {}\n },\n \"identityProviderId\": \"<string>\",\n \"primaryPartyAuthentication\": true\n },\n \"updateMask\": {\n \"unknownFields\": {\n \"fields\": {}\n },\n \"paths\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "<string>",
"primaryParty": "<string>",
"isDeactivated": true,
"metadata": {
"resourceVersion": "<string>",
"annotations": {}
},
"identityProviderId": "<string>",
"primaryPartyAuthentication": true
}
}"<string>"{
"code": "<string>",
"cause": "<string>",
"context": {},
"errorCategory": 123,
"correlationId": "<string>",
"traceId": "<string>",
"resources": [
[
"<string>"
]
],
"grpcCodeValue": 123,
"retryInfo": "<string>",
"definiteAnswer": true
}Authorizations
httpAuthapiKeyAuth
Ledger API standard JWT token
Path Parameters
Body
application/json
Required authorization: HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)
The user to update. Modifiable
Required
Show child attributes
Show child attributes
An update mask specifies how and which properties of the User message are to be updated.
An update mask consists of a set of update paths.
A valid update path points to a field or a subfield relative to the User message.
A valid update mask must:
- contain at least one update path,
- contain only valid update paths.
Fields that can be updated are marked as Modifiable.
An update path can also point to a non-Modifiable fields such as 'id' and 'metadata.resource_version'
because they are used:
- to identify the user resource subject to the update,
- for concurrent change control.
Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
For additional information see the documentation for standard protobuf3's google.protobuf.FieldMask.
For similar Ledger API see com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest.
Required
Show child attributes
Show child attributes
Response
Updated user
Required
Show child attributes
Show child attributes