Class: PlatformAPI::Key

Inherits:

Object

• Object
• PlatformAPI::Key

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

• #info(key_id_or_key_fingerprint) ⇒ Object

  Info for existing key.

• #initialize(client) ⇒ Key constructor

  A new instance of Key.

• #list ⇒ Object

  List existing keys.

Constructor Details

#initialize(client) ⇒ Key

Returns a new instance of Key.

# File 'lib/platform-api/client.rb', line 2014

def initialize(client)
  @client = client
end

Instance Method Details

#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

# File 'lib/platform-api/client.rb', line 2021

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

#list ⇒ Object

List existing keys.

# File 'lib/platform-api/client.rb', line 2026

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