Method: Rundeck::Client::Key#key_contents

Defined in:

lib/rundeck/client/key.rb

#key_contents(path, options = {}) ⇒ Rundeck::ObjectifiedHash

Get the contents of a key. Only allowed for public keys. Note: This method returns a raw string of the public key, not at ObjectifiedHash.

Examples:

Rundeck.key_contents('path/to/key1')

Options Hash (options):

• :query (Hash) —

  The parameters to pass with the request Use this hash to specify Rundeck parameters.

  • query: { project: ‘anvils’, id: ‘123456’ }

Raises:

• (Rundeck::Error::BadRequest) —

  400 error - Most likely indicates a required parameter is missing.

• (Rundeck::Error::Unauthorized) —

  401 error - Unauthorized

• (Rundeck::Error::Forbidden) —

  403 forbidden - ACL policies prevent accessing the given resource

• (Rundeck::Error::NotFound) —

  404 not found - Indicates a resource could not be found at the location

• (Rundeck::Error::MethodNotAllowed) —

  405 method not allowed - The request method is not allowed. This probably indicates a misconfiguration in a reverse proxy, such as Nginx or Apache

• (Rundeck::Error::Conflict) —

  409 conflict - A conflicting resource exists.

• (Rundeck::Error::InternalServerError) —

  500 server error - Indicates the Rundeck server experienced an error.

• (Rundeck::Error::BadGateway) —

  502 bad gateway - Indicates something probably isn’t working right or is misconfigured on the Rundeck server.

• (Rundeck::Error::ServiceUnavailable) —

  503 error - Indicates an issue on the Rundeck server.

# File 'lib/rundeck/client/key.rb', line 68

def key_contents(path, options = {})
  # Check if key exists first. Otherwise we could return some
  # weird strings. Also, raise error if user is trying to get a
  # private key.
  key_content_type = key_metadata(path, options).rundeck_content_type
  if key_content_type == content_type('private')
    fail Error::Unauthorized,
         'You are not allowed to retrieve the contents of a private key'
  end

  options.merge!(format: :plain,
                 headers: { 'Accept' => 'application/pgp-keys' })
  key = get("#{STORAGE_KEYS_PATH}/#{path}", options)
  objectify 'public_key' => key
end