dependency-tracker-client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE +201 -0
  4. data/README.md +276 -0
  5. data/Rakefile +10 -0
  6. data/dependency-tracker-client.gemspec +39 -0
  7. data/docs/About.md +25 -0
  8. data/docs/Analysis.md +21 -0
  9. data/docs/AnalysisApi.md +177 -0
  10. data/docs/AnalysisComment.md +21 -0
  11. data/docs/AnalysisRequest.md +27 -0
  12. data/docs/ApiKey.md +17 -0
  13. data/docs/BadgeApi.md +102 -0
  14. data/docs/BodyPart.md +31 -0
  15. data/docs/BomApi.md +335 -0
  16. data/docs/BomSubmitRequest.md +25 -0
  17. data/docs/CalculatorApi.md +61 -0
  18. data/docs/CloneProjectRequest.md +19 -0
  19. data/docs/Component.md +69 -0
  20. data/docs/ComponentApi.md +373 -0
  21. data/docs/ComponentMetrics.md +43 -0
  22. data/docs/ConfigProperty.md +25 -0
  23. data/docs/ConfigPropertyApi.md +167 -0
  24. data/docs/ContentDisposition.md +29 -0
  25. data/docs/Cwe.md +19 -0
  26. data/docs/CweApi.md +110 -0
  27. data/docs/DefaultApi.md +434 -0
  28. data/docs/Dependency.md +27 -0
  29. data/docs/DependencyApi.md +222 -0
  30. data/docs/DependencyMetrics.md +45 -0
  31. data/docs/DependencyRequest.md +21 -0
  32. data/docs/Finding.md +23 -0
  33. data/docs/FindingApi.md +113 -0
  34. data/docs/FormDataBodyPart.md +39 -0
  35. data/docs/FormDataContentDisposition.md +31 -0
  36. data/docs/FormDataMultiPart.md +35 -0
  37. data/docs/Framework.md +23 -0
  38. data/docs/IdentifiableObject.md +17 -0
  39. data/docs/LdapApi.md +220 -0
  40. data/docs/LdapUser.md +25 -0
  41. data/docs/License.md +37 -0
  42. data/docs/LicenseApi.md +159 -0
  43. data/docs/ManagedUser.md +37 -0
  44. data/docs/MappedLdapGroup.md +19 -0
  45. data/docs/MappedLdapGroupRequest.md +19 -0
  46. data/docs/MediaType.md +25 -0
  47. data/docs/MetricsApi.md +922 -0
  48. data/docs/MultiPart.md +33 -0
  49. data/docs/NotificationPublisher.md +29 -0
  50. data/docs/NotificationRule.md +35 -0
  51. data/docs/PackageURL.md +29 -0
  52. data/docs/ParameterizedHeader.md +19 -0
  53. data/docs/Permission.md +19 -0
  54. data/docs/PermissionApi.md +279 -0
  55. data/docs/PortfolioMetrics.md +53 -0
  56. data/docs/Project.md +43 -0
  57. data/docs/ProjectApi.md +445 -0
  58. data/docs/ProjectMetrics.md +47 -0
  59. data/docs/ProjectProperty.md +27 -0
  60. data/docs/ProjectPropertyApi.md +232 -0
  61. data/docs/Repository.md +29 -0
  62. data/docs/RepositoryApi.md +325 -0
  63. data/docs/RepositoryMetaComponent.md +27 -0
  64. data/docs/Score.md +23 -0
  65. data/docs/SearchApi.md +120 -0
  66. data/docs/SearchResult.md +17 -0
  67. data/docs/Tag.md +19 -0
  68. data/docs/Team.md +29 -0
  69. data/docs/TeamApi.md +432 -0
  70. data/docs/UserApi.md +715 -0
  71. data/docs/UserPrincipal.md +27 -0
  72. data/docs/VersionApi.md +52 -0
  73. data/docs/Vulnerability.md +69 -0
  74. data/docs/VulnerabilityApi.md +666 -0
  75. data/docs/VulnerabilityMetrics.md +23 -0
  76. data/docs/VulnerableSoftware.md +69 -0
  77. data/lib/dependency-tracker-client/api/analysis_api.rb +209 -0
  78. data/lib/dependency-tracker-client/api/badge_api.rb +148 -0
  79. data/lib/dependency-tracker-client/api/bom_api.rb +382 -0
  80. data/lib/dependency-tracker-client/api/calculator_api.rb +83 -0
  81. data/lib/dependency-tracker-client/api/component_api.rb +422 -0
  82. data/lib/dependency-tracker-client/api/config_property_api.rb +192 -0
  83. data/lib/dependency-tracker-client/api/cwe_api.rb +136 -0
  84. data/lib/dependency-tracker-client/api/default_api.rb +491 -0
  85. data/lib/dependency-tracker-client/api/dependency_api.rb +254 -0
  86. data/lib/dependency-tracker-client/api/finding_api.rb +140 -0
  87. data/lib/dependency-tracker-client/api/ldap_api.rb +254 -0
  88. data/lib/dependency-tracker-client/api/license_api.rb +190 -0
  89. data/lib/dependency-tracker-client/api/metrics_api.rb +1086 -0
  90. data/lib/dependency-tracker-client/api/permission_api.rb +342 -0
  91. data/lib/dependency-tracker-client/api/project_api.rb +504 -0
  92. data/lib/dependency-tracker-client/api/project_property_api.rb +274 -0
  93. data/lib/dependency-tracker-client/api/repository_api.rb +376 -0
  94. data/lib/dependency-tracker-client/api/search_api.rb +143 -0
  95. data/lib/dependency-tracker-client/api/team_api.rb +486 -0
  96. data/lib/dependency-tracker-client/api/user_api.rb +796 -0
  97. data/lib/dependency-tracker-client/api/version_api.rb +78 -0
  98. data/lib/dependency-tracker-client/api/vulnerability_api.rb +780 -0
  99. data/lib/dependency-tracker-client/api_client.rb +388 -0
  100. data/lib/dependency-tracker-client/api_error.rb +57 -0
  101. data/lib/dependency-tracker-client/configuration.rb +261 -0
  102. data/lib/dependency-tracker-client/models/about.rb +242 -0
  103. data/lib/dependency-tracker-client/models/analysis.rb +265 -0
  104. data/lib/dependency-tracker-client/models/analysis_comment.rb +234 -0
  105. data/lib/dependency-tracker-client/models/analysis_request.rb +371 -0
  106. data/lib/dependency-tracker-client/models/api_key.rb +250 -0
  107. data/lib/dependency-tracker-client/models/body_part.rb +273 -0
  108. data/lib/dependency-tracker-client/models/bom_submit_request.rb +328 -0
  109. data/lib/dependency-tracker-client/models/clone_project_request.rb +267 -0
  110. data/lib/dependency-tracker-client/models/component.rb +900 -0
  111. data/lib/dependency-tracker-client/models/component_metrics.rb +338 -0
  112. data/lib/dependency-tracker-client/models/config_property.rb +421 -0
  113. data/lib/dependency-tracker-client/models/content_disposition.rb +262 -0
  114. data/lib/dependency-tracker-client/models/cwe.rb +259 -0
  115. data/lib/dependency-tracker-client/models/dependency.rb +266 -0
  116. data/lib/dependency-tracker-client/models/dependency_metrics.rb +352 -0
  117. data/lib/dependency-tracker-client/models/dependency_request.rb +257 -0
  118. data/lib/dependency-tracker-client/models/finding.rb +239 -0
  119. data/lib/dependency-tracker-client/models/form_data_body_part.rb +309 -0
  120. data/lib/dependency-tracker-client/models/form_data_content_disposition.rb +271 -0
  121. data/lib/dependency-tracker-client/models/form_data_multi_part.rb +295 -0
  122. data/lib/dependency-tracker-client/models/framework.rb +233 -0
  123. data/lib/dependency-tracker-client/models/identifiable_object.rb +206 -0
  124. data/lib/dependency-tracker-client/models/ldap_user.rb +351 -0
  125. data/lib/dependency-tracker-client/models/license.rb +373 -0
  126. data/lib/dependency-tracker-client/models/managed_user.rb +480 -0
  127. data/lib/dependency-tracker-client/models/mapped_ldap_group.rb +255 -0
  128. data/lib/dependency-tracker-client/models/mapped_ldap_group_request.rb +267 -0
  129. data/lib/dependency-tracker-client/models/media_type.rb +244 -0
  130. data/lib/dependency-tracker-client/models/multi_part.rb +284 -0
  131. data/lib/dependency-tracker-client/models/notification_publisher.rb +388 -0
  132. data/lib/dependency-tracker-client/models/notification_rule.rb +426 -0
  133. data/lib/dependency-tracker-client/models/package_url.rb +262 -0
  134. data/lib/dependency-tracker-client/models/parameterized_header.rb +217 -0
  135. data/lib/dependency-tracker-client/models/permission.rb +250 -0
  136. data/lib/dependency-tracker-client/models/portfolio_metrics.rb +378 -0
  137. data/lib/dependency-tracker-client/models/project.rb +420 -0
  138. data/lib/dependency-tracker-client/models/project_metrics.rb +356 -0
  139. data/lib/dependency-tracker-client/models/project_property.rb +430 -0
  140. data/lib/dependency-tracker-client/models/repository.rb +319 -0
  141. data/lib/dependency-tracker-client/models/repository_meta_component.rb +305 -0
  142. data/lib/dependency-tracker-client/models/score.rb +233 -0
  143. data/lib/dependency-tracker-client/models/search_result.rb +208 -0
  144. data/lib/dependency-tracker-client/models/tag.rb +252 -0
  145. data/lib/dependency-tracker-client/models/team.rb +310 -0
  146. data/lib/dependency-tracker-client/models/user_principal.rb +255 -0
  147. data/lib/dependency-tracker-client/models/vulnerability.rb +729 -0
  148. data/lib/dependency-tracker-client/models/vulnerability_metrics.rb +238 -0
  149. data/lib/dependency-tracker-client/models/vulnerable_software.rb +442 -0
  150. data/lib/dependency-tracker-client/version.rb +15 -0
  151. data/lib/dependency-tracker-client.rb +109 -0
  152. data/pkg/dependency-tracker-client-1.0.0.gem +0 -0
  153. data/spec/api/analysis_api_spec.rb +70 -0
  154. data/spec/api/badge_api_spec.rb +58 -0
  155. data/spec/api/bom_api_spec.rb +106 -0
  156. data/spec/api/calculator_api_spec.rb +46 -0
  157. data/spec/api/component_api_spec.rb +110 -0
  158. data/spec/api/config_property_api_spec.rb +67 -0
  159. data/spec/api/cwe_api_spec.rb +56 -0
  160. data/spec/api/default_api_spec.rb +123 -0
  161. data/spec/api/dependency_api_spec.rb +79 -0
  162. data/spec/api/finding_api_spec.rb +57 -0
  163. data/spec/api/ldap_api_spec.rb +79 -0
  164. data/spec/api/license_api_spec.rb +66 -0
  165. data/spec/api/metrics_api_spec.rb +233 -0
  166. data/spec/api/permission_api_spec.rb +94 -0
  167. data/spec/api/project_api_spec.rb +126 -0
  168. data/spec/api/project_property_api_spec.rb +82 -0
  169. data/spec/api/repository_api_spec.rb +100 -0
  170. data/spec/api/search_api_spec.rb +59 -0
  171. data/spec/api/team_api_spec.rb +122 -0
  172. data/spec/api/user_api_spec.rb +183 -0
  173. data/spec/api/version_api_spec.rb +46 -0
  174. data/spec/api/vulnerability_api_spec.rb +177 -0
  175. data/spec/api_client_spec.rb +226 -0
  176. data/spec/configuration_spec.rb +42 -0
  177. data/spec/models/about_spec.rb +65 -0
  178. data/spec/models/analysis_comment_spec.rb +53 -0
  179. data/spec/models/analysis_request_spec.rb +75 -0
  180. data/spec/models/analysis_spec.rb +57 -0
  181. data/spec/models/api_key_spec.rb +41 -0
  182. data/spec/models/body_part_spec.rb +83 -0
  183. data/spec/models/bom_submit_request_spec.rb +65 -0
  184. data/spec/models/clone_project_request_spec.rb +47 -0
  185. data/spec/models/component_metrics_spec.rb +119 -0
  186. data/spec/models/component_spec.rb +201 -0
  187. data/spec/models/config_property_spec.rb +69 -0
  188. data/spec/models/content_disposition_spec.rb +77 -0
  189. data/spec/models/cwe_spec.rb +47 -0
  190. data/spec/models/dependency_metrics_spec.rb +125 -0
  191. data/spec/models/dependency_request_spec.rb +53 -0
  192. data/spec/models/dependency_spec.rb +71 -0
  193. data/spec/models/finding_spec.rb +59 -0
  194. data/spec/models/form_data_body_part_spec.rb +107 -0
  195. data/spec/models/form_data_content_disposition_spec.rb +83 -0
  196. data/spec/models/form_data_multi_part_spec.rb +95 -0
  197. data/spec/models/framework_spec.rb +59 -0
  198. data/spec/models/identifiable_object_spec.rb +41 -0
  199. data/spec/models/ldap_user_spec.rb +65 -0
  200. data/spec/models/license_spec.rb +101 -0
  201. data/spec/models/managed_user_spec.rb +101 -0
  202. data/spec/models/mapped_ldap_group_request_spec.rb +47 -0
  203. data/spec/models/mapped_ldap_group_spec.rb +47 -0
  204. data/spec/models/media_type_spec.rb +65 -0
  205. data/spec/models/multi_part_spec.rb +89 -0
  206. data/spec/models/notification_publisher_spec.rb +77 -0
  207. data/spec/models/notification_rule_spec.rb +107 -0
  208. data/spec/models/package_url_spec.rb +77 -0
  209. data/spec/models/parameterized_header_spec.rb +47 -0
  210. data/spec/models/permission_spec.rb +47 -0
  211. data/spec/models/portfolio_metrics_spec.rb +149 -0
  212. data/spec/models/project_metrics_spec.rb +131 -0
  213. data/spec/models/project_property_spec.rb +75 -0
  214. data/spec/models/project_spec.rb +119 -0
  215. data/spec/models/repository_meta_component_spec.rb +75 -0
  216. data/spec/models/repository_spec.rb +81 -0
  217. data/spec/models/score_spec.rb +59 -0
  218. data/spec/models/search_result_spec.rb +41 -0
  219. data/spec/models/tag_spec.rb +47 -0
  220. data/spec/models/team_spec.rb +77 -0
  221. data/spec/models/user_principal_spec.rb +71 -0
  222. data/spec/models/vulnerability_metrics_spec.rb +59 -0
  223. data/spec/models/vulnerability_spec.rb +201 -0
  224. data/spec/models/vulnerable_software_spec.rb +197 -0
  225. data/spec/spec_helper.rb +111 -0
  226. data/tmp/tmp.rb +11 -0
  227. metadata +402 -0
@@ -0,0 +1,796 @@
1
+ =begin
2
+ #Dependency-Track API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: 3.8.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module DependencyTracker
16
+ class UserApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Adds the username to the specified team.
23
+ # @param username [String] A valid username
24
+ # @param body [IdentifiableObject] The UUID of the team to associate username with
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [UserPrincipal]
27
+ def add_team_to_user(username, body, opts = {})
28
+ data, _status_code, _headers = add_team_to_user_with_http_info(username, body, opts)
29
+ data
30
+ end
31
+
32
+ # Adds the username to the specified team.
33
+ # @param username [String] A valid username
34
+ # @param body [IdentifiableObject] The UUID of the team to associate username with
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(UserPrincipal, Integer, Hash)>] UserPrincipal data, response status code and response headers
37
+ def add_team_to_user_with_http_info(username, body, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: UserApi.add_team_to_user ...'
40
+ end
41
+ # verify the required parameter 'username' is set
42
+ if @api_client.config.client_side_validation && username.nil?
43
+ fail ArgumentError, "Missing the required parameter 'username' when calling UserApi.add_team_to_user"
44
+ end
45
+ # verify the required parameter 'body' is set
46
+ if @api_client.config.client_side_validation && body.nil?
47
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserApi.add_team_to_user"
48
+ end
49
+ # resource path
50
+ local_var_path = '/v1/user/{username}/membership'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+
55
+ # header parameters
56
+ header_params = opts[:header_params] || {}
57
+ # HTTP header 'Accept' (if needed)
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
59
+ # HTTP header 'Content-Type'
60
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
61
+
62
+ # form parameters
63
+ form_params = opts[:form_params] || {}
64
+
65
+ # http body (model)
66
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
67
+
68
+ # return_type
69
+ return_type = opts[:return_type] || 'UserPrincipal'
70
+
71
+ # auth_names
72
+ auth_names = opts[:auth_names] || ['X-Api-Key']
73
+
74
+ new_options = opts.merge(
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: UserApi#add_team_to_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Creates a new user that references an existing LDAP object.
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [LdapUser] :body
93
+ # @return [LdapUser]
94
+ def create_ldap_user(opts = {})
95
+ data, _status_code, _headers = create_ldap_user_with_http_info(opts)
96
+ data
97
+ end
98
+
99
+ # Creates a new user that references an existing LDAP object.
100
+ # @param [Hash] opts the optional parameters
101
+ # @option opts [LdapUser] :body
102
+ # @return [Array<(LdapUser, Integer, Hash)>] LdapUser data, response status code and response headers
103
+ def create_ldap_user_with_http_info(opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: UserApi.create_ldap_user ...'
106
+ end
107
+ # resource path
108
+ local_var_path = '/v1/user/ldap'
109
+
110
+ # query parameters
111
+ query_params = opts[:query_params] || {}
112
+
113
+ # header parameters
114
+ header_params = opts[:header_params] || {}
115
+ # HTTP header 'Accept' (if needed)
116
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
117
+ # HTTP header 'Content-Type'
118
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
119
+
120
+ # form parameters
121
+ form_params = opts[:form_params] || {}
122
+
123
+ # http body (model)
124
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
125
+
126
+ # return_type
127
+ return_type = opts[:return_type] || 'LdapUser'
128
+
129
+ # auth_names
130
+ auth_names = opts[:auth_names] || ['X-Api-Key']
131
+
132
+ new_options = opts.merge(
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: UserApi#create_ldap_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+
148
+ # Creates a new user.
149
+ # @param [Hash] opts the optional parameters
150
+ # @option opts [ManagedUser] :body
151
+ # @return [ManagedUser]
152
+ def create_managed_user(opts = {})
153
+ data, _status_code, _headers = create_managed_user_with_http_info(opts)
154
+ data
155
+ end
156
+
157
+ # Creates a new user.
158
+ # @param [Hash] opts the optional parameters
159
+ # @option opts [ManagedUser] :body
160
+ # @return [Array<(ManagedUser, Integer, Hash)>] ManagedUser data, response status code and response headers
161
+ def create_managed_user_with_http_info(opts = {})
162
+ if @api_client.config.debugging
163
+ @api_client.config.logger.debug 'Calling API: UserApi.create_managed_user ...'
164
+ end
165
+ # resource path
166
+ local_var_path = '/v1/user/managed'
167
+
168
+ # query parameters
169
+ query_params = opts[:query_params] || {}
170
+
171
+ # header parameters
172
+ header_params = opts[:header_params] || {}
173
+ # HTTP header 'Accept' (if needed)
174
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
175
+ # HTTP header 'Content-Type'
176
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
177
+
178
+ # form parameters
179
+ form_params = opts[:form_params] || {}
180
+
181
+ # http body (model)
182
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
183
+
184
+ # return_type
185
+ return_type = opts[:return_type] || 'ManagedUser'
186
+
187
+ # auth_names
188
+ auth_names = opts[:auth_names] || ['X-Api-Key']
189
+
190
+ new_options = opts.merge(
191
+ :header_params => header_params,
192
+ :query_params => query_params,
193
+ :form_params => form_params,
194
+ :body => post_body,
195
+ :auth_names => auth_names,
196
+ :return_type => return_type
197
+ )
198
+
199
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
200
+ if @api_client.config.debugging
201
+ @api_client.config.logger.debug "API called: UserApi#create_managed_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
202
+ end
203
+ return data, status_code, headers
204
+ end
205
+
206
+ # Deletes a user.
207
+ # @param [Hash] opts the optional parameters
208
+ # @option opts [LdapUser] :body
209
+ # @return [nil]
210
+ def delete_ldap_user(opts = {})
211
+ delete_ldap_user_with_http_info(opts)
212
+ nil
213
+ end
214
+
215
+ # Deletes a user.
216
+ # @param [Hash] opts the optional parameters
217
+ # @option opts [LdapUser] :body
218
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
219
+ def delete_ldap_user_with_http_info(opts = {})
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug 'Calling API: UserApi.delete_ldap_user ...'
222
+ end
223
+ # resource path
224
+ local_var_path = '/v1/user/ldap'
225
+
226
+ # query parameters
227
+ query_params = opts[:query_params] || {}
228
+
229
+ # header parameters
230
+ header_params = opts[:header_params] || {}
231
+ # HTTP header 'Content-Type'
232
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
233
+
234
+ # form parameters
235
+ form_params = opts[:form_params] || {}
236
+
237
+ # http body (model)
238
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
239
+
240
+ # return_type
241
+ return_type = opts[:return_type]
242
+
243
+ # auth_names
244
+ auth_names = opts[:auth_names] || ['X-Api-Key']
245
+
246
+ new_options = opts.merge(
247
+ :header_params => header_params,
248
+ :query_params => query_params,
249
+ :form_params => form_params,
250
+ :body => post_body,
251
+ :auth_names => auth_names,
252
+ :return_type => return_type
253
+ )
254
+
255
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
256
+ if @api_client.config.debugging
257
+ @api_client.config.logger.debug "API called: UserApi#delete_ldap_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
258
+ end
259
+ return data, status_code, headers
260
+ end
261
+
262
+ # Deletes a user.
263
+ # @param [Hash] opts the optional parameters
264
+ # @option opts [ManagedUser] :body
265
+ # @return [nil]
266
+ def delete_managed_user(opts = {})
267
+ delete_managed_user_with_http_info(opts)
268
+ nil
269
+ end
270
+
271
+ # Deletes a user.
272
+ # @param [Hash] opts the optional parameters
273
+ # @option opts [ManagedUser] :body
274
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
275
+ def delete_managed_user_with_http_info(opts = {})
276
+ if @api_client.config.debugging
277
+ @api_client.config.logger.debug 'Calling API: UserApi.delete_managed_user ...'
278
+ end
279
+ # resource path
280
+ local_var_path = '/v1/user/managed'
281
+
282
+ # query parameters
283
+ query_params = opts[:query_params] || {}
284
+
285
+ # header parameters
286
+ header_params = opts[:header_params] || {}
287
+ # HTTP header 'Content-Type'
288
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
289
+
290
+ # form parameters
291
+ form_params = opts[:form_params] || {}
292
+
293
+ # http body (model)
294
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
295
+
296
+ # return_type
297
+ return_type = opts[:return_type]
298
+
299
+ # auth_names
300
+ auth_names = opts[:auth_names] || ['X-Api-Key']
301
+
302
+ new_options = opts.merge(
303
+ :header_params => header_params,
304
+ :query_params => query_params,
305
+ :form_params => form_params,
306
+ :body => post_body,
307
+ :auth_names => auth_names,
308
+ :return_type => return_type
309
+ )
310
+
311
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
312
+ if @api_client.config.debugging
313
+ @api_client.config.logger.debug "API called: UserApi#delete_managed_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
314
+ end
315
+ return data, status_code, headers
316
+ end
317
+
318
+ # Asserts login credentials and upon successful authentication, verifies passwords match and changes users password
319
+ # Upon a successful login, a JSON Web Token will be returned in the response body. This functionality requires authentication to be enabled.
320
+ # @param [Hash] opts the optional parameters
321
+ # @option opts [String] :username
322
+ # @option opts [String] :password
323
+ # @option opts [String] :new_password
324
+ # @option opts [String] :confirm_password
325
+ # @return [String]
326
+ def force_change_password(opts = {})
327
+ data, _status_code, _headers = force_change_password_with_http_info(opts)
328
+ data
329
+ end
330
+
331
+ # Asserts login credentials and upon successful authentication, verifies passwords match and changes users password
332
+ # Upon a successful login, a JSON Web Token will be returned in the response body. This functionality requires authentication to be enabled.
333
+ # @param [Hash] opts the optional parameters
334
+ # @option opts [String] :username
335
+ # @option opts [String] :password
336
+ # @option opts [String] :new_password
337
+ # @option opts [String] :confirm_password
338
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
339
+ def force_change_password_with_http_info(opts = {})
340
+ if @api_client.config.debugging
341
+ @api_client.config.logger.debug 'Calling API: UserApi.force_change_password ...'
342
+ end
343
+ # resource path
344
+ local_var_path = '/v1/user/forceChangePassword'
345
+
346
+ # query parameters
347
+ query_params = opts[:query_params] || {}
348
+
349
+ # header parameters
350
+ header_params = opts[:header_params] || {}
351
+ # HTTP header 'Accept' (if needed)
352
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
353
+ # HTTP header 'Content-Type'
354
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
355
+
356
+ # form parameters
357
+ form_params = opts[:form_params] || {}
358
+ form_params['username'] = opts[:'username'] if !opts[:'username'].nil?
359
+ form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
360
+ form_params['newPassword'] = opts[:'new_password'] if !opts[:'new_password'].nil?
361
+ form_params['confirmPassword'] = opts[:'confirm_password'] if !opts[:'confirm_password'].nil?
362
+
363
+ # http body (model)
364
+ post_body = opts[:body]
365
+
366
+ # return_type
367
+ return_type = opts[:return_type] || 'String'
368
+
369
+ # auth_names
370
+ auth_names = opts[:auth_names] || ['X-Api-Key']
371
+
372
+ new_options = opts.merge(
373
+ :header_params => header_params,
374
+ :query_params => query_params,
375
+ :form_params => form_params,
376
+ :body => post_body,
377
+ :auth_names => auth_names,
378
+ :return_type => return_type
379
+ )
380
+
381
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
382
+ if @api_client.config.debugging
383
+ @api_client.config.logger.debug "API called: UserApi#force_change_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
384
+ end
385
+ return data, status_code, headers
386
+ end
387
+
388
+ # Returns a list of all LDAP users
389
+ # @param [Hash] opts the optional parameters
390
+ # @return [Array<LdapUser>]
391
+ def get_ldap_users(opts = {})
392
+ data, _status_code, _headers = get_ldap_users_with_http_info(opts)
393
+ data
394
+ end
395
+
396
+ # Returns a list of all LDAP users
397
+ # @param [Hash] opts the optional parameters
398
+ # @return [Array<(Array<LdapUser>, Integer, Hash)>] Array<LdapUser> data, response status code and response headers
399
+ def get_ldap_users_with_http_info(opts = {})
400
+ if @api_client.config.debugging
401
+ @api_client.config.logger.debug 'Calling API: UserApi.get_ldap_users ...'
402
+ end
403
+ # resource path
404
+ local_var_path = '/v1/user/ldap'
405
+
406
+ # query parameters
407
+ query_params = opts[:query_params] || {}
408
+
409
+ # header parameters
410
+ header_params = opts[:header_params] || {}
411
+ # HTTP header 'Accept' (if needed)
412
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
413
+
414
+ # form parameters
415
+ form_params = opts[:form_params] || {}
416
+
417
+ # http body (model)
418
+ post_body = opts[:body]
419
+
420
+ # return_type
421
+ return_type = opts[:return_type] || 'Array<LdapUser>'
422
+
423
+ # auth_names
424
+ auth_names = opts[:auth_names] || ['X-Api-Key']
425
+
426
+ new_options = opts.merge(
427
+ :header_params => header_params,
428
+ :query_params => query_params,
429
+ :form_params => form_params,
430
+ :body => post_body,
431
+ :auth_names => auth_names,
432
+ :return_type => return_type
433
+ )
434
+
435
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
436
+ if @api_client.config.debugging
437
+ @api_client.config.logger.debug "API called: UserApi#get_ldap_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
+ end
439
+ return data, status_code, headers
440
+ end
441
+
442
+ # Returns a list of all managed users
443
+ # @param [Hash] opts the optional parameters
444
+ # @return [Array<ManagedUser>]
445
+ def get_managed_users(opts = {})
446
+ data, _status_code, _headers = get_managed_users_with_http_info(opts)
447
+ data
448
+ end
449
+
450
+ # Returns a list of all managed users
451
+ # @param [Hash] opts the optional parameters
452
+ # @return [Array<(Array<ManagedUser>, Integer, Hash)>] Array<ManagedUser> data, response status code and response headers
453
+ def get_managed_users_with_http_info(opts = {})
454
+ if @api_client.config.debugging
455
+ @api_client.config.logger.debug 'Calling API: UserApi.get_managed_users ...'
456
+ end
457
+ # resource path
458
+ local_var_path = '/v1/user/managed'
459
+
460
+ # query parameters
461
+ query_params = opts[:query_params] || {}
462
+
463
+ # header parameters
464
+ header_params = opts[:header_params] || {}
465
+ # HTTP header 'Accept' (if needed)
466
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
467
+
468
+ # form parameters
469
+ form_params = opts[:form_params] || {}
470
+
471
+ # http body (model)
472
+ post_body = opts[:body]
473
+
474
+ # return_type
475
+ return_type = opts[:return_type] || 'Array<ManagedUser>'
476
+
477
+ # auth_names
478
+ auth_names = opts[:auth_names] || ['X-Api-Key']
479
+
480
+ new_options = opts.merge(
481
+ :header_params => header_params,
482
+ :query_params => query_params,
483
+ :form_params => form_params,
484
+ :body => post_body,
485
+ :auth_names => auth_names,
486
+ :return_type => return_type
487
+ )
488
+
489
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
490
+ if @api_client.config.debugging
491
+ @api_client.config.logger.debug "API called: UserApi#get_managed_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
492
+ end
493
+ return data, status_code, headers
494
+ end
495
+
496
+ # Returns information about the current logged in user.
497
+ # @param [Hash] opts the optional parameters
498
+ # @return [UserPrincipal]
499
+ def get_self(opts = {})
500
+ data, _status_code, _headers = get_self_with_http_info(opts)
501
+ data
502
+ end
503
+
504
+ # Returns information about the current logged in user.
505
+ # @param [Hash] opts the optional parameters
506
+ # @return [Array<(UserPrincipal, Integer, Hash)>] UserPrincipal data, response status code and response headers
507
+ def get_self_with_http_info(opts = {})
508
+ if @api_client.config.debugging
509
+ @api_client.config.logger.debug 'Calling API: UserApi.get_self ...'
510
+ end
511
+ # resource path
512
+ local_var_path = '/v1/user/self'
513
+
514
+ # query parameters
515
+ query_params = opts[:query_params] || {}
516
+
517
+ # header parameters
518
+ header_params = opts[:header_params] || {}
519
+ # HTTP header 'Accept' (if needed)
520
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
521
+
522
+ # form parameters
523
+ form_params = opts[:form_params] || {}
524
+
525
+ # http body (model)
526
+ post_body = opts[:body]
527
+
528
+ # return_type
529
+ return_type = opts[:return_type] || 'UserPrincipal'
530
+
531
+ # auth_names
532
+ auth_names = opts[:auth_names] || ['X-Api-Key']
533
+
534
+ new_options = opts.merge(
535
+ :header_params => header_params,
536
+ :query_params => query_params,
537
+ :form_params => form_params,
538
+ :body => post_body,
539
+ :auth_names => auth_names,
540
+ :return_type => return_type
541
+ )
542
+
543
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
544
+ if @api_client.config.debugging
545
+ @api_client.config.logger.debug "API called: UserApi#get_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
546
+ end
547
+ return data, status_code, headers
548
+ end
549
+
550
+ # Removes the username from the specified team.
551
+ # @param username [String] A valid username
552
+ # @param body [IdentifiableObject] The UUID of the team to un-associate username from
553
+ # @param [Hash] opts the optional parameters
554
+ # @return [UserPrincipal]
555
+ def remove_team_from_user(username, body, opts = {})
556
+ data, _status_code, _headers = remove_team_from_user_with_http_info(username, body, opts)
557
+ data
558
+ end
559
+
560
+ # Removes the username from the specified team.
561
+ # @param username [String] A valid username
562
+ # @param body [IdentifiableObject] The UUID of the team to un-associate username from
563
+ # @param [Hash] opts the optional parameters
564
+ # @return [Array<(UserPrincipal, Integer, Hash)>] UserPrincipal data, response status code and response headers
565
+ def remove_team_from_user_with_http_info(username, body, opts = {})
566
+ if @api_client.config.debugging
567
+ @api_client.config.logger.debug 'Calling API: UserApi.remove_team_from_user ...'
568
+ end
569
+ # verify the required parameter 'username' is set
570
+ if @api_client.config.client_side_validation && username.nil?
571
+ fail ArgumentError, "Missing the required parameter 'username' when calling UserApi.remove_team_from_user"
572
+ end
573
+ # verify the required parameter 'body' is set
574
+ if @api_client.config.client_side_validation && body.nil?
575
+ fail ArgumentError, "Missing the required parameter 'body' when calling UserApi.remove_team_from_user"
576
+ end
577
+ # resource path
578
+ local_var_path = '/v1/user/{username}/membership'.sub('{' + 'username' + '}', CGI.escape(username.to_s))
579
+
580
+ # query parameters
581
+ query_params = opts[:query_params] || {}
582
+
583
+ # header parameters
584
+ header_params = opts[:header_params] || {}
585
+ # HTTP header 'Accept' (if needed)
586
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
587
+ # HTTP header 'Content-Type'
588
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
589
+
590
+ # form parameters
591
+ form_params = opts[:form_params] || {}
592
+
593
+ # http body (model)
594
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
595
+
596
+ # return_type
597
+ return_type = opts[:return_type] || 'UserPrincipal'
598
+
599
+ # auth_names
600
+ auth_names = opts[:auth_names] || ['X-Api-Key']
601
+
602
+ new_options = opts.merge(
603
+ :header_params => header_params,
604
+ :query_params => query_params,
605
+ :form_params => form_params,
606
+ :body => post_body,
607
+ :auth_names => auth_names,
608
+ :return_type => return_type
609
+ )
610
+
611
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
612
+ if @api_client.config.debugging
613
+ @api_client.config.logger.debug "API called: UserApi#remove_team_from_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
614
+ end
615
+ return data, status_code, headers
616
+ end
617
+
618
+ # Updates a managed user.
619
+ # @param [Hash] opts the optional parameters
620
+ # @option opts [ManagedUser] :body
621
+ # @return [ManagedUser]
622
+ def update_managed_user(opts = {})
623
+ data, _status_code, _headers = update_managed_user_with_http_info(opts)
624
+ data
625
+ end
626
+
627
+ # Updates a managed user.
628
+ # @param [Hash] opts the optional parameters
629
+ # @option opts [ManagedUser] :body
630
+ # @return [Array<(ManagedUser, Integer, Hash)>] ManagedUser data, response status code and response headers
631
+ def update_managed_user_with_http_info(opts = {})
632
+ if @api_client.config.debugging
633
+ @api_client.config.logger.debug 'Calling API: UserApi.update_managed_user ...'
634
+ end
635
+ # resource path
636
+ local_var_path = '/v1/user/managed'
637
+
638
+ # query parameters
639
+ query_params = opts[:query_params] || {}
640
+
641
+ # header parameters
642
+ header_params = opts[:header_params] || {}
643
+ # HTTP header 'Accept' (if needed)
644
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
645
+ # HTTP header 'Content-Type'
646
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
647
+
648
+ # form parameters
649
+ form_params = opts[:form_params] || {}
650
+
651
+ # http body (model)
652
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
653
+
654
+ # return_type
655
+ return_type = opts[:return_type] || 'ManagedUser'
656
+
657
+ # auth_names
658
+ auth_names = opts[:auth_names] || ['X-Api-Key']
659
+
660
+ new_options = opts.merge(
661
+ :header_params => header_params,
662
+ :query_params => query_params,
663
+ :form_params => form_params,
664
+ :body => post_body,
665
+ :auth_names => auth_names,
666
+ :return_type => return_type
667
+ )
668
+
669
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
670
+ if @api_client.config.debugging
671
+ @api_client.config.logger.debug "API called: UserApi#update_managed_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
672
+ end
673
+ return data, status_code, headers
674
+ end
675
+
676
+ # Updates information about the current logged in user.
677
+ # @param [Hash] opts the optional parameters
678
+ # @option opts [ManagedUser] :body
679
+ # @return [UserPrincipal]
680
+ def update_self(opts = {})
681
+ data, _status_code, _headers = update_self_with_http_info(opts)
682
+ data
683
+ end
684
+
685
+ # Updates information about the current logged in user.
686
+ # @param [Hash] opts the optional parameters
687
+ # @option opts [ManagedUser] :body
688
+ # @return [Array<(UserPrincipal, Integer, Hash)>] UserPrincipal data, response status code and response headers
689
+ def update_self_with_http_info(opts = {})
690
+ if @api_client.config.debugging
691
+ @api_client.config.logger.debug 'Calling API: UserApi.update_self ...'
692
+ end
693
+ # resource path
694
+ local_var_path = '/v1/user/self'
695
+
696
+ # query parameters
697
+ query_params = opts[:query_params] || {}
698
+
699
+ # header parameters
700
+ header_params = opts[:header_params] || {}
701
+ # HTTP header 'Accept' (if needed)
702
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
703
+
704
+ # form parameters
705
+ form_params = opts[:form_params] || {}
706
+
707
+ # http body (model)
708
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
709
+
710
+ # return_type
711
+ return_type = opts[:return_type] || 'UserPrincipal'
712
+
713
+ # auth_names
714
+ auth_names = opts[:auth_names] || ['X-Api-Key']
715
+
716
+ new_options = opts.merge(
717
+ :header_params => header_params,
718
+ :query_params => query_params,
719
+ :form_params => form_params,
720
+ :body => post_body,
721
+ :auth_names => auth_names,
722
+ :return_type => return_type
723
+ )
724
+
725
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
726
+ if @api_client.config.debugging
727
+ @api_client.config.logger.debug "API called: UserApi#update_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
728
+ end
729
+ return data, status_code, headers
730
+ end
731
+
732
+ # Assert login credentials
733
+ # Upon a successful login, a JSON Web Token will be returned in the response body. This functionality requires authentication to be enabled.
734
+ # @param [Hash] opts the optional parameters
735
+ # @option opts [String] :username
736
+ # @option opts [String] :password
737
+ # @return [String]
738
+ def validate_credentials(opts = {})
739
+ data, _status_code, _headers = validate_credentials_with_http_info(opts)
740
+ data
741
+ end
742
+
743
+ # Assert login credentials
744
+ # Upon a successful login, a JSON Web Token will be returned in the response body. This functionality requires authentication to be enabled.
745
+ # @param [Hash] opts the optional parameters
746
+ # @option opts [String] :username
747
+ # @option opts [String] :password
748
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
749
+ def validate_credentials_with_http_info(opts = {})
750
+ if @api_client.config.debugging
751
+ @api_client.config.logger.debug 'Calling API: UserApi.validate_credentials ...'
752
+ end
753
+ # resource path
754
+ local_var_path = '/v1/user/login'
755
+
756
+ # query parameters
757
+ query_params = opts[:query_params] || {}
758
+
759
+ # header parameters
760
+ header_params = opts[:header_params] || {}
761
+ # HTTP header 'Accept' (if needed)
762
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
763
+ # HTTP header 'Content-Type'
764
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
765
+
766
+ # form parameters
767
+ form_params = opts[:form_params] || {}
768
+ form_params['username'] = opts[:'username'] if !opts[:'username'].nil?
769
+ form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
770
+
771
+ # http body (model)
772
+ post_body = opts[:body]
773
+
774
+ # return_type
775
+ return_type = opts[:return_type] || 'String'
776
+
777
+ # auth_names
778
+ auth_names = opts[:auth_names] || ['X-Api-Key']
779
+
780
+ new_options = opts.merge(
781
+ :header_params => header_params,
782
+ :query_params => query_params,
783
+ :form_params => form_params,
784
+ :body => post_body,
785
+ :auth_names => auth_names,
786
+ :return_type => return_type
787
+ )
788
+
789
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
790
+ if @api_client.config.debugging
791
+ @api_client.config.logger.debug "API called: UserApi#validate_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
792
+ end
793
+ return data, status_code, headers
794
+ end
795
+ end
796
+ end