CAcargill
Biome

GET /biome/users

Lists all users

This endpoint requires the permission "biome.user.read".

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/biome/users
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.

SplinterProtocolVersioninteger
Example:2

The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.

Response

List of users registered in Biome

usernamestring

Username used for login

user_idstring

Internal unique identifier for the user

Example response

[
  {
    "username": "alice@acme.com",
    "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
  }
]

Changes

No recorded changes to this operation across all 69 revisions of this API.