CAcargill
Biome

PUT /biome/users/{user_id}

Changed on

Update a user

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

Request

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

Path parameters

user_idstring required
Example:f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4

ID of the user

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.

Request body

usernamestring required

Existing username of user

hashed_passwordstring required

Hashed password to be used for user authentication

new_passwordstring

Hash of the new password to be used for user authentication

Example request

{
  "username": "alice@acme.com",
  "hashed_password": "8945622435187243046536949706b5272644c71336c7254563679727565494b376d4b3554696b734662685962652f6v52562e437a70462f6552489c8b"
}

Response

User updated successfully

messagestring

Example response

{
  "message": "Credentials and key updated successfully",
  "data": [
    {
      "display_name": "Biome Admin Key",
      "encrypted_private_key": "XNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc",
      "public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
      "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
    }
  ]
}

Changes

  • bb81d3866f1eRevision changes
    • breaking

      the request property type changed from no type to string

    • breaking

      the request property type changed from no type to string

    • breaking

      the request property type changed from no type to string