class ForemanApi::Resources::AuthSourceLdap

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/auth_source_ldap.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["auth_source_ldaps"]
end

Public Instance Methods

create(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [Hash, nil] auth_source_ldap

allowed keys are:
* account [String, nil]
* account_password [String, nil]  required if onthefly_register is true 
* attr_firstname [String, nil]  required if onthefly_register is true 
* attr_lastname [String, nil]  required if onthefly_register is true 
* attr_login [String, nil]  required if onthefly_register is true 
* attr_mail [String, nil]  required if onthefly_register is true 
* base_dn [String, nil]
* host [String]
* name [String]
* onthefly_register [String, nil]
* port [String, nil]  defaults to 389 
* tls [String, nil]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/auth_source_ldap.rb, line 45
def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
destroy(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/auth_source_ldap.rb, line 77
def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
index(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] page paginate results @option params [String] per_page number of entries per request

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/auth_source_ldap.rb, line 14
def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
show(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/auth_source_ldap.rb, line 23
def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
update(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id @option params [Hash, nil] auth_source_ldap

allowed keys are:
* account [String, nil]
* account_password [String, nil]  required if onthefly_register is true 
* attr_firstname [String, nil]  required if onthefly_register is true 
* attr_lastname [String, nil]  required if onthefly_register is true 
* attr_login [String, nil]  required if onthefly_register is true 
* attr_mail [String, nil]  required if onthefly_register is true 
* base_dn [String, nil]
* host [String]
* name [String]
* onthefly_register [String, nil]
* port [String, nil]  defaults to 389 
* tls [String, nil]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/auth_source_ldap.rb, line 68
def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end