Class: CryptomateApi::Management::Key

Inherits:
Base
  • Object
show all
Defined in:
lib/cryptomate_api/management/key.rb

Overview

Manage the api-keys of your clients. You can create, modify and delete them. This api-keys are used to authenticate the clients in the platform.

Class Method Summary collapse

Class Method Details

.create_key(name) ⇒ Object

Create a key cryptomate.me/docs/management#create-a-key Response: [

{
  "api_key": "string",
  "name": "string"
}

]

Parameters:

  • name (String) —

    (Alias name of the API-Key to create.)



46
47
48
 
# File 'lib/cryptomate_api/management/key.rb', line 46

def create_key(name)
  post('/management/keys/create', body: { name: }.to_json)
end

.delete_key(api_key) ⇒ Object

Delete a key cryptomate.me/docs/management#delete-a-key

Parameters:

  • api_key (String) —

    (Id of the API-Key. Ex: master-ac8ff424-426f-46a7-94c3-13932c6e8adf)



68
69
70
 
# File 'lib/cryptomate_api/management/key.rb', line 68

def delete_key(api_key)
  delete("/management/keys/#{api_key}")
end

.get_all_keys ⇒ Object

Get all keys cryptomate.me/docs/management#get-all-keys Response: [

{
  "api_key": "string",
  "name": "string"
}

]



19
20
21
 
# File 'lib/cryptomate_api/management/key.rb', line 19

def get_all_keys
  get('/management/keys/list')
end

.get_key(key_id) ⇒ Object

Get a specific key cryptomate.me/docs/management#get-a-key Response: [

{
  "api_key": "string",
  "name": "string"
}

]



32
33
34
 
# File 'lib/cryptomate_api/management/key.rb', line 32

def get_key(key_id)
  get("/management/keys/#{key_id}")
end

.modify_key(key_name, new_api_key_value) ⇒ Object

Modify a key cryptomate.me/docs/management#modify-a-key Response: [

{
  "api_key": "string",
  "name": "string"
}

]

Parameters:

  • key_name (String) —

    (Name of the key to modify.)

  • new_api_key_value (String) —

    (New api-key value.)



61
62
63
 
# File 'lib/cryptomate_api/management/key.rb', line 61

def modify_key(key_name, new_api_key_value)
  put("/management/keys/#{key_name}", body: { api_key: new_api_key_value }.to_json)
end