Update selected modifiable attribute of a user resource described by the ``User`` message

PATCH /v2/users/{user-id}

Request

curl --request PATCH \
  --url 'http://localhost:7575/v2/users/{user-id}' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"user":{"id":"string","primaryParty":"string","isDeactivated":false,"metadata":{},"identityProviderId":"string","primaryPartyAuthentication":false},"updateMask":{"paths":["string"],"unknownFields":{}}}'

200 response

{
  "user": {
    "id": "string",
    "primaryParty": "string",
    "isDeactivated": false,
    "metadata": {},
    "identityProviderId": "string",
    "primaryPartyAuthentication": false
  }
}

JSON Ledger API

Update selected modifiable attribute of a user resource described by the User message

OpenAPISince 3.4Changed 3.5

Update selected modifiable attribute of a user resource described by the User message.

Protocol Details

Inputs

Path parameters

user-id · string · required

Request body

application/json

user · object · required

OpenAPI type: User.

Users and rights ///////////////// Users are used to dynamically manage the rights given to Daml applications. They are stored and managed per participant node.

updateMask · object · required

OpenAPI type: FieldMask.

Outputs

200

application/json

user · User · required

Users and rights ///////////////// Users are used to dynamically manage the rights given to Daml applications. They are stored and managed per participant node.

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The PATCH /v2/users/{user-id} operation changed in this snapshot.

Introduced3.4

Request

curl --request PATCH \
  --url 'http://localhost:7575/v2/users/{user-id}' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"user":{"id":"string","primaryParty":"string","isDeactivated":false,"metadata":{},"identityProviderId":"string","primaryPartyAuthentication":false},"updateMask":{"paths":["string"],"unknownFields":{}}}'

200 response

{
  "user": {
    "id": "string",
    "primaryParty": "string",
    "isDeactivated": false,
    "metadata": {},
    "identityProviderId": "string",
    "primaryPartyAuthentication": false
  }
}