v1

latestOpenAPI 3.0.02026-07-17493090.2 KB
Biome

Verifies a user with username and password credentials

post/biome/verify

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

{"stackTrail":"paths:/biome/verify:post:requestBody:content:application/json:schema:properties:username","oasType":"schema","type":"unknown","description":"username of user"}
{"stackTrail":"paths:/biome/verify:post:requestBody:content:application/json:schema:properties:hashed_password","oasType":"schema","type":"unknown","description":"Hashed password to be used for user authentication\n"}

Example request

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

Response

Successful operation

messagestring
user_idstring

Internal unique identifier for the user

Example response

{
  "message": "Successful verification",
  "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
}