Documentation/canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesUserManagementServiceView on canton-network-docs ↗
canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesUserManagementService

UpdateUser

Ledger API›Protobuf›com.daml.ledger.api.v2.admin›UpdateUser

com.daml.ledger.api.v2.admin

​
UpdateUser

gRPCSince 3.4.0
RPC/com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser

​
Protocol Details

​
Inputs

​
UpdateUserRequest

userUser
update_maskFieldMask

​
Outputs

​
UpdateUserResponse

userUser

​
Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.admin.UpdateUserRequest

userUser
update_maskFieldMask

com.daml.ledger.api.v2.admin.User

idstring
primary_partystring
is_deactivatedbool
metadataObjectMeta
identity_provider_idstring
primary_party_authenticationbool

com.daml.ledger.api.v2.admin.ObjectMeta

resource_versionstring
annotationsrepeated map

com.daml.ledger.api.v2.admin.UpdateUserResponse

userUser
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.UserManagementService/UpdateUser <<'EOF'
{
  "user": {
    "id": "string",
    "primaryParty": "string",
    "isDeactivated": true,
    "metadata": {
      "resourceVersion": "string",
      "annotations": [
        {
          "key": "string"
        }
      ]
    },
    "identityProviderId": "string",
    "primaryPartyAuthentication": true
  },
  "updateMask": "string"
}
EOF
OKapplication/json
OK
{
  "user": {
    "id": "string",
    "primaryParty": "string",
    "isDeactivated": true,
    "metadata": {
      "resourceVersion": "string",
      "annotations": [
        {
          "key": "string"
        }
      ]
    },
    "identityProviderId": "string",
    "primaryPartyAuthentication": true
  }
}