Documentation/canton-network-docs/Ledger APIOpenAPIView on canton-network-docs ↗
canton-network-docs/Ledger APIOpenAPI

POST /v2/users

POST
/
v2
/
users
Try it
POST /v2/users

cURL

curl --request POST \
  --url https://api.example.com/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "id": "<string>",
    "primaryParty": "<string>",
    "isDeactivated": true,
    "metadata": {
      "resourceVersion": "<string>",
      "annotations": {}
    },
    "identityProviderId": "<string>"
  },
  "rights": [
    {
      "kind": {
        "CanActAs": {
          "value": {
            "party": "<string>"
          }
        }
      }
    }
  ]
}
'
200
400
default
{
  "user": {
    "id": "<string>",
    "primaryParty": "<string>",
    "isDeactivated": true,
    "metadata": {
      "resourceVersion": "<string>",
      "annotations": {}
    },
    "identityProviderId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Ledger API standard JWT token

Body

application/json

RPC requests and responses /////////////////////////// Required authorization: HasRight(ParticipantAdmin) OR IsAuthenticatedIdentityProviderAdmin(user.identity_provider_id)

​
user
User · object
required

The user to create.

Required

Show child attributes

​
rights
Right · object[]

The rights to be assigned to the user upon creation, which SHOULD include appropriate rights for the user.primary_party.

Optional: can be empty

Show child attributes

Response

200
application/json
​
user
User · object
required

Created user.

Required

Show child attributes