Class: PlatformAPI::Key

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Key

Returns a new instance of Key.



811
812
813
 
# File 'lib/platform-api/client.rb', line 811

def initialize(client)
  @client = client
end

Instance Method Details

#create(body) ⇒ Object

Create a new key.

Parameters:

  • body: —

    the object to pass as the request payload



818
819
820
 
# File 'lib/platform-api/client.rb', line 818

def create(body)
  @client.key.create(body)
end

#delete(key_id_or_key_fingerprint) ⇒ Object

Delete an existing key

Parameters:

  • key_id_or_key_fingerprint: —

    unique identifier of this key or a unique identifying string based on contents



825
826
827
 
# File 'lib/platform-api/client.rb', line 825

def delete(key_id_or_key_fingerprint)
  @client.key.delete(key_id_or_key_fingerprint)
end

#info(key_id_or_key_fingerprint) ⇒ Object

Info for existing key.

Parameters:

  • key_id_or_key_fingerprint: —

    unique identifier of this key or a unique identifying string based on contents



832
833
834
 
# File 'lib/platform-api/client.rb', line 832

def info(key_id_or_key_fingerprint)
  @client.key.info(key_id_or_key_fingerprint)
end

#list ⇒ Object

List existing keys.



837
838
839
 
# File 'lib/platform-api/client.rb', line 837

def list()
  @client.key.list()
end