Class: ForemanApi::Resources::AuthSourceLdap

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/auth_source_ldap.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) doc



4
5
6
# File 'lib/foreman_api/resources/auth_source_ldap.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["auth_source_ldaps"]
end

Instance Method Details

- (Array) create(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • auth_source_ldap (Hash)

    allowed keys are:

    • account [String]
    • account_password [String] Required if onthefly_register is true
    • attr_firstname [String] Required if onthefly_register is true
    • attr_lastname [String] Required if onthefly_register is true
    • attr_login [String] Required if onthefly_register is true
    • attr_mail [String] Required if onthefly_register is true
    • base_dn [String]
    • host [String]
    • name [String]
    • onthefly_register [String]
    • port [String] Defaults to 389
    • tls [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



45
46
47
# File 'lib/foreman_api/resources/auth_source_ldap.rb', line 45

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) destroy(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



77
78
79
# File 'lib/foreman_api/resources/auth_source_ldap.rb', line 77

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) index(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • page (String)

    Paginate results

  • per_page (String)

    Number of entries per request

Returns:

  • (Array)

    First item: parsed data; second item: raw body



14
15
16
# File 'lib/foreman_api/resources/auth_source_ldap.rb', line 14

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) show(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • id (String)

Returns:

  • (Array)

    First item: parsed data; second item: raw body



23
24
25
# File 'lib/foreman_api/resources/auth_source_ldap.rb', line 23

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

- (Array) update(params = {}, headers = {})

First item: parsed data; second item: raw body

Parameters:

  • params (Hash) (defaults to: {})

    a hash of params to be passed to the service

  • headers (Hash) (defaults to: {})

    additional http headers

Options Hash (params):

  • id (String)
  • auth_source_ldap (Hash)

    allowed keys are:

    • account [String]
    • account_password [String] Required if onthefly_register is true
    • attr_firstname [String] Required if onthefly_register is true
    • attr_lastname [String] Required if onthefly_register is true
    • attr_login [String] Required if onthefly_register is true
    • attr_mail [String] Required if onthefly_register is true
    • base_dn [String]
    • host [String]
    • name [String]
    • onthefly_register [String]
    • port [String] Defaults to 389
    • tls [String]

Returns:

  • (Array)

    First item: parsed data; second item: raw body



68
69
70
# File 'lib/foreman_api/resources/auth_source_ldap.rb', line 68

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end