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

ListUsers

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

com.daml.ledger.api.v2.admin

​
ListUsers

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

​
Protocol Details

​
Inputs

​
ListUsersRequest

page_tokenstring
page_sizeint32
identity_provider_idstring

​
Outputs

​
ListUsersResponse

usersrepeated User
next_page_tokenstring

​
Lifecycle Changes

3.4.0introduced

com.daml.ledger.api.v2.admin.ListUsersRequest

page_tokenstring
page_sizeint32
identity_provider_idstring

com.daml.ledger.api.v2.admin.ListUsersResponse

usersrepeated User
next_page_tokenstring

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
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.daml.ledger.api.v2.admin.UserManagementService/ListUsers <<'EOF'
{
  "pageToken": "string",
  "pageSize": 0,
  "identityProviderId": "string"
}
EOF
OKapplication/json
OK
{
  "users": [
    {
      "id": "string",
      "primaryParty": "string",
      "isDeactivated": true,
      "metadata": {
        "resourceVersion": "string",
        "annotations": [
          {
            "key": "string"
          }
        ]
      },
      "identityProviderId": "string",
      "primaryPartyAuthentication": true
    }
  ],
  "nextPageToken": "string"
}