class CircleCi::User

User class to access user details for a specific API key

Public Class Methods

new(conf = nil) click to toggle source

Initialize a new User API interaction

@param conf [CircleCi::Config] - Optional config to use for request @return [CircleCi::User]

Calls superclass method CircleCi::ApiResource::new
# File lib/circleci/user.rb, line 14
def initialize(conf = nil)
  super(nil, nil, conf)
end

Public Instance Methods

heroku_key(apikey) click to toggle source

Add a Heroku API key to CircleCI

@param apikey [String] - The Heroku API key @return [CircleCi::Response] - Response object

# File lib/circleci/user.rb, line 33
def heroku_key(apikey)
  CircleCi.request(conf, '/user/heroku-key').post(apikey: apikey)
end
me() click to toggle source

Get user account details

@return [CircleCi::Response] - Response object

# File lib/circleci/user.rb, line 23
def me
  CircleCi.request(conf, '/me').get
end