Sign in

v1

latestOpenAPI 3.0.02026-07-17493090.2 KB
Biome

Authenticates a user with username and password credentials

post/biome/login

Headers

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/login:post:requestBody:content:application/json:schema:properties:username","oasType":"schema","type":"unknown","description":"username of user"}
{"stackTrail":"paths:/biome/login: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

tokenstring

JWT access token used for authorizing access to protected resources

refresh_tokenstring

JWT refresh token used for obtaining a new access to token

Example response

{
  "message": "Successful login",
  "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4",
  "token": "Biome:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc",
  "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZjM1YWFjYzEtYTljZC00ZWRhLWI2ZDAtMmVmYWRkZjBjOGE0IiwiaXNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc"
}