CAcargill
Biome

PATCH /biome/keys

Changed on

Update a key's display name

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

public_keystring required

Public key

new_display_namestring required

Updated display name for the key

Example request

{
  "public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
  "new_display_name": "Admin key pair"
}

Response

User updated successfully

messagestring

Example response

{
  "message": "Key updated successfully"
}

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