List all existing users

GET /v2/users

Request

curl --request GET \
  --url 'http://localhost:7575/v2/users' \
  --header 'Authorization: Bearer $TOKEN'

200 response

{
  "users": [
    {}
  ],
  "nextPageToken": "string"
}

JSON Ledger API

List all existing users

OpenAPISince 3.4Changed 3.5

List all existing users.

Protocol Details

Operation IDgetV2Users

AuthenticationBearer token

Published3.5

Inputs

Query parameters

pageSize · number

OpenAPI type: 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

Outputs

200

application/json

users · User[]

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

nextPageToken · string

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

400

text/plain

value · string · required

default

application/json

code · string · required

cause · string · required

correlationId · string

traceId · string

context · Map_String · required

resources · Tuple2_String_String[]

errorCategory · integer (int32) · required

grpcCodeValue · integer (int32)

retryInfo · string

definiteAnswer · boolean

History

Changed3.5

The GET /v2/users operation changed in this snapshot.

Introduced3.4

Request

curl --request GET \
  --url 'http://localhost:7575/v2/users' \
  --header 'Authorization: Bearer $TOKEN'

200 response

{
  "users": [
    {}
  ],
  "nextPageToken": "string"
}