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

GET /v2/users

GET
/
v2
/
users
Try it
GET /v2/users

cURL

curl --request GET \
  --url https://api.example.com/v2/users \
  --header 'Authorization: Bearer <token>'
200
400
default
{
  "users": [
    {
      "id": "<string>",
      "primaryParty": "<string>",
      "isDeactivated": true,
      "metadata": {
        "resourceVersion": "<string>",
        "annotations": {}
      },
      "identityProviderId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

Ledger API standard JWT token

Query Parameters

​
pageSize
integer<int32>

maximum number of elements in a returned page

​
pageToken
string

token - to continue results from a given page, leave empty to start from the beginning of the list, obtain token from the result of previous page

Response

200
application/json
​
users
User · object[]

A subset of users of the participant node that fit into this page. Can be empty if no more users

Optional: can be empty

Show child attributes

​
nextPageToken
string

Pagination token to retrieve the next page. Empty, if there are no further results.

Optional