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

CreateUser

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

com.daml.ledger.api.v2.admin

​
CreateUser

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

​
Protocol Details

​
Inputs

​
CreateUserRequest

userUser
rightsrepeated Right

​
Outputs

​
CreateUserResponse

userUser

​
Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.admin.CreateUserRequest

userUser
rightsrepeated Right

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.Right

participant_adminParticipantAdmin
can_act_asCanActAs
can_read_asCanReadAs
identity_provider_adminIdentityProviderAdmin
can_read_as_any_partyCanReadAsAnyParty
can_execute_asCanExecuteAs
can_execute_as_any_partyCanExecuteAsAnyParty

com.daml.ledger.api.v2.admin.Right.ParticipantAdmin

com.daml.ledger.api.v2.admin.Right.CanActAs

partystring

com.daml.ledger.api.v2.admin.Right.CanReadAs

partystring

com.daml.ledger.api.v2.admin.Right.CanExecuteAs

partystring

com.daml.ledger.api.v2.admin.Right.IdentityProviderAdmin

com.daml.ledger.api.v2.admin.Right.CanReadAsAnyParty

com.daml.ledger.api.v2.admin.Right.CanExecuteAsAnyParty

com.daml.ledger.api.v2.admin.CreateUserResponse

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