Skip to main content
PATCH
/
v2
/
users
/
{user-id}
/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>"
  },
  "updateMask": {
    "unknownFields": {
      "fields": {}
    },
    "paths": [
      "<string>"
    ]
  }
}
'
{
  "user": {
    "id": "<string>",
    "primaryParty": "<string>",
    "isDeactivated": true,
    "metadata": {
      "resourceVersion": "<string>",
      "annotations": {}
    },
    "identityProviderId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Ledger API standard JWT token

Path Parameters

​
user-id
string
required

Body

application/json

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

​
user
User · object
required

The user to update. Modifiable

Required

​
updateMask
FieldMask · object
required

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:

  1. contain at least one update path,
  2. 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:

  1. to identify the user resource subject to the update,
  2. 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

Response

​
user
User · object
required

Updated user

Required