Skip to content
Documentation/canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesPartyManagementServiceView on canton-network-docs
canton-network-docs/Ledger APIProtobufsPackagescom.daml.ledger.api.v2.adminServicesPartyManagementService

UpdatePartyDetails

Ledger APIProtobufcom.daml.ledger.api.v2.adminUpdatePartyDetails

com.daml.ledger.api.v2.admin

UpdatePartyDetails

gRPCSince 3.4.0
RPC/com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails

Protocol Details

Inputs

UpdatePartyDetailsRequest

party_detailsPartyDetails
update_maskFieldMask

Outputs

UpdatePartyDetailsResponse

party_detailsPartyDetails

Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.admin.UpdatePartyDetailsRequest

party_detailsPartyDetails
update_maskFieldMask

com.daml.ledger.api.v2.admin.PartyDetails

partystring
is_localbool
local_metadataObjectMeta
identity_provider_idstring

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

resource_versionstring
annotationsrepeated map

com.daml.ledger.api.v2.admin.UpdatePartyDetailsResponse

party_detailsPartyDetails
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.PartyManagementService/UpdatePartyDetails <<'EOF'
{
  "partyDetails": {
    "party": "string",
    "isLocal": true,
    "localMetadata": {
      "resourceVersion": "string",
      "annotations": [
        {
          "key": "string"
        }
      ]
    },
    "identityProviderId": "string"
  },
  "updateMask": "string"
}
EOF
OKapplication/json
OK
{
  "partyDetails": {
    "party": "string",
    "isLocal": true,
    "localMetadata": {
      "resourceVersion": "string",
      "annotations": [
        {
          "key": "string"
        }
      ]
    },
    "identityProviderId": "string"
  }
}