Class: DependencyTracker::LdapApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/api/ldap_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LdapApi

Returns a new instance of LdapApi.



19
20
21
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_mapping(opts = {}) ⇒ MappedLdapGroup

Adds a mapping

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



26
27
28
29
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 26

def add_mapping(opts = {})
  data, _status_code, _headers = add_mapping_with_http_info(opts)
  data
end

#add_mapping_with_http_info(opts = {}) ⇒ Array<(MappedLdapGroup, Integer, Hash)>

Adds a mapping

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(MappedLdapGroup, Integer, Hash)>) —

    MappedLdapGroup data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 35

def add_mapping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.add_mapping ...'
  end
  # resource path
  local_var_path = '/v1/ldap/mapping'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  # return_type
  return_type = opts[:return_type] || 'MappedLdapGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#add_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_mapping(uuid, opts = {}) ⇒ MappedLdapGroup

Removes a mapping

Parameters:

  • uuid (String) —

    The UUID of the mapping to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 82

def delete_mapping(uuid, opts = {})
  data, _status_code, _headers = delete_mapping_with_http_info(uuid, opts)
  data
end

#delete_mapping_with_http_info(uuid, opts = {}) ⇒ Array<(MappedLdapGroup, Integer, Hash)>

Removes a mapping

Parameters:

  • uuid (String) —

    The UUID of the mapping to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MappedLdapGroup, Integer, Hash)>) —

    MappedLdapGroup data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 91

def delete_mapping_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.delete_mapping ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling LdapApi.delete_mapping"
  end
  # resource path
  local_var_path = '/v1/ldap/mapping/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'MappedLdapGroup' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#delete_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_ldap_groups(opts = {}) ⇒ Array<String>

Returns the DNs of all accessible groups within the directory This API performs a pass-thru query to the configured LDAP server. Search criteria results are cached using default Alpine CacheManager policy

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<String>) 


142
143
144
145
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 142

def retrieve_ldap_groups(opts = {})
  data, _status_code, _headers = retrieve_ldap_groups_with_http_info(opts)
  data
end

#retrieve_ldap_groups1(uuid, opts = {}) ⇒ Array<String>

Returns the DNs of all groups mapped to the specified team

Parameters:

  • uuid (String) —

    The UUID of the team to retrieve mappings for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<String>) 


198
199
200
201
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 198

def retrieve_ldap_groups1(uuid, opts = {})
  data, _status_code, _headers = retrieve_ldap_groups1_with_http_info(uuid, opts)
  data
end

#retrieve_ldap_groups1_with_http_info(uuid, opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

Returns the DNs of all groups mapped to the specified team

Parameters:

  • uuid (String) —

    The UUID of the team to retrieve mappings for

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<String>, Integer, Hash)>) —

    Array<String> data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 207

def retrieve_ldap_groups1_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.retrieve_ldap_groups1 ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling LdapApi.retrieve_ldap_groups1"
  end
  # resource path
  local_var_path = '/v1/ldap/team/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<String>' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#retrieve_ldap_groups1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_ldap_groups_with_http_info(opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

Returns the DNs of all accessible groups within the directory This API performs a pass-thru query to the configured LDAP server. Search criteria results are cached using default Alpine CacheManager policy

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<String>, Integer, Hash)>) —

    Array<String> data, response status code and response headers



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/dependency-tracker-client/api/ldap_api.rb', line 151

def retrieve_ldap_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LdapApi.retrieve_ldap_groups ...'
  end
  # resource path
  local_var_path = '/v1/ldap/groups'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<String>' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LdapApi#retrieve_ldap_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end