CAcargill
Biome

POST /biome/keys

Add a new key for user

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/biome/keys
  • 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.

Request body

display_namestring

Display name for key

encrypted_private_keystring

Encrypted private key

public_keystring

Public key

user_idstring

Internal unique identifier for the user

Example request

{
  "display_name": "Biome Admin Key",
  "encrypted_private_key": "XNzIjoic2VsZi1pc3N1ZWQiLCJleHAiOjE1ODAyMzkyMjh9.P8hA0ru_xriYX7qryl08ZEp86t5HD_AEVPEUXY70Ehc",
  "public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
  "user_id": "f35aacc1-a9cd-4eda-b6d0-2efaddf0c8a4"
}

Response

User added successfully

messagestring

Example response

{
  "message": "Key added 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

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