harbor2_client 0.1.0 → 2.3.3.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (484) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +241 -13
  3. data/build_scripts/generate.sh +8 -0
  4. data/build_scripts/swagger-codegen-cli-ruby-config.json +12 -0
  5. data/docs/Access.md +10 -0
  6. data/docs/ArtifactApi.md +76 -2
  7. data/docs/AuditlogApi.md +3 -1
  8. data/docs/AuthproxySetting.md +12 -0
  9. data/docs/Body.md +8 -0
  10. data/docs/Body1.md +8 -0
  11. data/docs/BoolConfigItem.md +9 -0
  12. data/docs/ChartMetadata.md +18 -0
  13. data/docs/ChartVersion.md +23 -0
  14. data/docs/ComponentHealthStatus.md +10 -0
  15. data/docs/Configurations.md +62 -0
  16. data/docs/ConfigurationsResponse.md +60 -0
  17. data/docs/ConfigurationsResponseScanAllPolicy.md +9 -0
  18. data/docs/ConfigurationsResponseScanAllPolicyParameter.md +8 -0
  19. data/docs/ConfigureApi.md +175 -0
  20. data/docs/Endpoint.md +9 -0
  21. data/docs/EventType.md +7 -0
  22. data/docs/FilterStyle.md +10 -0
  23. data/docs/GCHistory.md +16 -0
  24. data/docs/GcApi.md +356 -0
  25. data/docs/GeneralInfo.md +20 -0
  26. data/docs/HealthApi.md +63 -0
  27. data/docs/ImmutableApi.md +261 -0
  28. data/docs/ImmutableRule.md +15 -0
  29. data/docs/ImmutableSelector.md +11 -0
  30. data/docs/IntegerConfigItem.md +9 -0
  31. data/docs/InternalConfigurationsResponse.md +7 -0
  32. data/docs/IsDefault.md +8 -0
  33. data/docs/LabelApi.md +309 -0
  34. data/docs/LdapApi.md +238 -0
  35. data/docs/LdapConf.md +16 -0
  36. data/docs/LdapFailedImportUser.md +9 -0
  37. data/docs/LdapImportUsers.md +8 -0
  38. data/docs/LdapPingResult.md +9 -0
  39. data/docs/LdapUser.md +10 -0
  40. data/docs/MemberApi.md +322 -0
  41. data/docs/NativeReportSummary.md +1 -0
  42. data/docs/NotifyType.md +7 -0
  43. data/docs/OIDCCliSecretReq.md +8 -0
  44. data/docs/OIDCUserInfo.md +13 -0
  45. data/docs/OidcApi.md +65 -0
  46. data/docs/OverallHealthStatus.md +9 -0
  47. data/docs/PasswordReq.md +9 -0
  48. data/docs/Permission.md +9 -0
  49. data/docs/PingApi.md +63 -0
  50. data/docs/PreheatApi.md +12 -4
  51. data/docs/ProjectApi.md +237 -27
  52. data/docs/ProjectMember.md +10 -0
  53. data/docs/ProjectMemberEntity.md +14 -0
  54. data/docs/ProjectMetadataApi.md +318 -0
  55. data/docs/ProjectScanner.md +8 -0
  56. data/docs/Quota.md +13 -0
  57. data/docs/QuotaApi.md +191 -0
  58. data/docs/QuotaRefObject.md +7 -0
  59. data/docs/QuotaUpdateReq.md +8 -0
  60. data/docs/Registry.md +2 -2
  61. data/docs/RegistryApi.md +530 -0
  62. data/docs/RegistryEndpoint.md +9 -0
  63. data/docs/RegistryInfo.md +11 -0
  64. data/docs/RegistryPing.md +14 -0
  65. data/docs/RegistryProviderCredentialPattern.md +11 -0
  66. data/docs/RegistryProviderEndpointPattern.md +9 -0
  67. data/docs/RegistryProviderInfo.md +9 -0
  68. data/docs/RegistryUpdate.md +14 -0
  69. data/docs/ReplicationApi.md +673 -0
  70. data/docs/ReplicationExecution.md +19 -0
  71. data/docs/ReplicationFilter.md +9 -0
  72. data/docs/ReplicationPolicy.md +22 -0
  73. data/docs/ReplicationTask.md +17 -0
  74. data/docs/ReplicationTrigger.md +9 -0
  75. data/docs/ReplicationTriggerSettings.md +8 -0
  76. data/docs/RepositoryApi.md +66 -1
  77. data/docs/RetentionApi.md +609 -0
  78. data/docs/RetentionExecution.md +14 -0
  79. data/docs/RetentionExecutionTask.md +18 -0
  80. data/docs/RetentionMetadata.md +10 -0
  81. data/docs/RetentionPolicy.md +12 -0
  82. data/docs/RetentionPolicyScope.md +9 -0
  83. data/docs/RetentionRule.md +15 -0
  84. data/docs/RetentionRuleMetadata.md +11 -0
  85. data/docs/RetentionRuleParamMetadata.md +10 -0
  86. data/docs/RetentionRuleTrigger.md +10 -0
  87. data/docs/RetentionSelector.md +11 -0
  88. data/docs/RetentionSelectorMetadata.md +10 -0
  89. data/docs/Robot.md +19 -0
  90. data/docs/RobotApi.md +365 -0
  91. data/docs/RobotCreate.md +14 -0
  92. data/docs/RobotCreateV1.md +11 -0
  93. data/docs/RobotCreated.md +12 -0
  94. data/docs/RobotPermission.md +10 -0
  95. data/docs/RobotSec.md +8 -0
  96. data/docs/Robotv1Api.md +329 -0
  97. data/docs/RoleRequest.md +8 -0
  98. data/docs/ScanAllApi.md +287 -0
  99. data/docs/Scanner.md +10 -0
  100. data/docs/ScannerAdapterMetadata.md +10 -0
  101. data/docs/ScannerApi.md +479 -0
  102. data/docs/ScannerCapability.md +9 -0
  103. data/docs/ScannerRegistration.md +23 -0
  104. data/docs/ScannerRegistrationReq.md +15 -0
  105. data/docs/ScannerRegistrationSettings.md +11 -0
  106. data/docs/Schedule.md +13 -0
  107. data/docs/ScheduleObj.md +9 -0
  108. data/docs/Search.md +10 -0
  109. data/docs/SearchApi.md +66 -0
  110. data/docs/SearchRepository.md +13 -0
  111. data/docs/SearchResult.md +10 -0
  112. data/docs/StartReplicationExecution.md +8 -0
  113. data/docs/Statistic.md +14 -0
  114. data/docs/StatisticApi.md +63 -0
  115. data/docs/Stats.md +12 -0
  116. data/docs/Storage.md +9 -0
  117. data/docs/StringConfigItem.md +9 -0
  118. data/docs/SupportedWebhookEventTypes.md +9 -0
  119. data/docs/SystemCVEAllowlistApi.md +119 -0
  120. data/docs/SystemInfo.md +8 -0
  121. data/docs/SysteminfoApi.md +173 -0
  122. data/docs/UserApi.md +647 -0
  123. data/docs/UserCreationReq.md +12 -0
  124. data/docs/UserEntity.md +9 -0
  125. data/docs/UserGroup.md +11 -0
  126. data/docs/UserProfile.md +10 -0
  127. data/docs/UserResp.md +17 -0
  128. data/docs/UserSearch.md +9 -0
  129. data/docs/UserSearchRespItem.md +9 -0
  130. data/docs/UserSysAdminFlag.md +8 -0
  131. data/docs/UsergroupApi.md +293 -0
  132. data/docs/WebhookApi.md +448 -0
  133. data/docs/WebhookJob.md +15 -0
  134. data/docs/WebhookLastTrigger.md +12 -0
  135. data/docs/WebhookPolicy.md +17 -0
  136. data/docs/WebhookTargetObject.md +11 -0
  137. data/docs/WebhookjobApi.md +81 -0
  138. data/git_push.sh +3 -3
  139. data/harbor2_client.gemspec +7 -7
  140. data/lib/harbor2_client/api/artifact_api.rb +91 -3
  141. data/lib/harbor2_client/api/auditlog_api.rb +4 -1
  142. data/lib/harbor2_client/api/configure_api.rb +193 -0
  143. data/lib/harbor2_client/api/gc_api.rb +391 -0
  144. data/lib/harbor2_client/api/health_api.rb +78 -0
  145. data/lib/harbor2_client/api/icon_api.rb +1 -1
  146. data/lib/harbor2_client/api/immutable_api.rb +312 -0
  147. data/lib/harbor2_client/api/label_api.rb +350 -0
  148. data/lib/harbor2_client/api/ldap_api.rb +259 -0
  149. data/lib/harbor2_client/api/member_api.rb +373 -0
  150. data/lib/harbor2_client/api/oidc_api.rb +83 -0
  151. data/lib/harbor2_client/api/ping_api.rb +78 -0
  152. data/lib/harbor2_client/api/preheat_api.rb +13 -1
  153. data/lib/harbor2_client/api/project_api.rb +289 -46
  154. data/lib/harbor2_client/api/project_metadata_api.rb +362 -0
  155. data/lib/harbor2_client/api/quota_api.rb +224 -0
  156. data/lib/harbor2_client/api/registry_api.rb +575 -0
  157. data/lib/harbor2_client/api/replication_api.rb +749 -0
  158. data/lib/harbor2_client/api/repository_api.rb +75 -1
  159. data/lib/harbor2_client/api/retention_api.rb +676 -0
  160. data/lib/harbor2_client/api/robot_api.rb +409 -0
  161. data/lib/harbor2_client/api/robotv1_api.rb +387 -0
  162. data/lib/harbor2_client/api/scan_all_api.rb +308 -0
  163. data/lib/harbor2_client/api/scan_api.rb +1 -1
  164. data/lib/harbor2_client/api/scanner_api.rb +529 -0
  165. data/lib/harbor2_client/api/search_api.rb +85 -0
  166. data/lib/harbor2_client/api/statistic_api.rb +78 -0
  167. data/lib/harbor2_client/api/system_cve_allowlist_api.rb +134 -0
  168. data/lib/harbor2_client/api/systeminfo_api.rb +188 -0
  169. data/lib/harbor2_client/api/user_api.rb +715 -0
  170. data/lib/harbor2_client/api/usergroup_api.rb +317 -0
  171. data/lib/harbor2_client/api/webhook_api.rb +514 -0
  172. data/lib/harbor2_client/api/webhookjob_api.rb +113 -0
  173. data/lib/harbor2_client/api_client.rb +2 -2
  174. data/lib/harbor2_client/api_error.rb +1 -1
  175. data/lib/harbor2_client/configuration.rb +1 -1
  176. data/lib/harbor2_client/models/access.rb +205 -0
  177. data/lib/harbor2_client/models/addition_link.rb +1 -1
  178. data/lib/harbor2_client/models/addition_links.rb +1 -1
  179. data/lib/harbor2_client/models/annotations.rb +1 -1
  180. data/lib/harbor2_client/models/artifact.rb +1 -1
  181. data/lib/harbor2_client/models/audit_log.rb +1 -1
  182. data/lib/harbor2_client/models/authproxy_setting.rb +225 -0
  183. data/lib/harbor2_client/models/body.rb +184 -0
  184. data/lib/harbor2_client/models/body_1.rb +184 -0
  185. data/lib/harbor2_client/models/bool_config_item.rb +195 -0
  186. data/lib/harbor2_client/models/chart_metadata.rb +320 -0
  187. data/lib/harbor2_client/models/chart_version.rb +374 -0
  188. data/lib/harbor2_client/models/component_health_status.rb +206 -0
  189. data/lib/harbor2_client/models/configurations.rb +725 -0
  190. data/lib/harbor2_client/models/configurations_response.rb +704 -0
  191. data/lib/harbor2_client/models/configurations_response_scan_all_policy.rb +194 -0
  192. data/lib/harbor2_client/models/configurations_response_scan_all_policy_parameter.rb +186 -0
  193. data/lib/harbor2_client/models/cve_allowlist.rb +1 -1
  194. data/lib/harbor2_client/models/cve_allowlist_item.rb +1 -1
  195. data/lib/harbor2_client/models/endpoint.rb +195 -0
  196. data/lib/harbor2_client/models/error.rb +1 -1
  197. data/lib/harbor2_client/models/errors.rb +1 -1
  198. data/lib/harbor2_client/models/event_type.rb +176 -0
  199. data/lib/harbor2_client/models/execution.rb +1 -1
  200. data/lib/harbor2_client/models/extra_attrs.rb +1 -1
  201. data/lib/harbor2_client/models/filter_style.rb +208 -0
  202. data/lib/harbor2_client/models/gc_history.rb +264 -0
  203. data/lib/harbor2_client/models/general_info.rb +305 -0
  204. data/lib/harbor2_client/models/icon.rb +1 -1
  205. data/lib/harbor2_client/models/immutable_rule.rb +253 -0
  206. data/lib/harbor2_client/models/immutable_selector.rb +211 -0
  207. data/lib/harbor2_client/models/instance.rb +1 -1
  208. data/lib/harbor2_client/models/integer_config_item.rb +195 -0
  209. data/lib/harbor2_client/models/internal_configurations_response.rb +175 -0
  210. data/lib/harbor2_client/models/is_default.rb +185 -0
  211. data/lib/harbor2_client/models/label.rb +1 -1
  212. data/lib/harbor2_client/models/ldap_conf.rb +266 -0
  213. data/lib/harbor2_client/models/ldap_failed_import_user.rb +195 -0
  214. data/lib/harbor2_client/models/ldap_import_users.rb +187 -0
  215. data/lib/harbor2_client/models/ldap_ping_result.rb +196 -0
  216. data/lib/harbor2_client/models/ldap_user.rb +205 -0
  217. data/lib/harbor2_client/models/metadata.rb +1 -1
  218. data/lib/harbor2_client/models/metrics.rb +1 -1
  219. data/lib/harbor2_client/models/native_report_summary.rb +14 -5
  220. data/lib/harbor2_client/models/notify_type.rb +176 -0
  221. data/lib/harbor2_client/models/oidc_cli_secret_req.rb +185 -0
  222. data/lib/harbor2_client/models/oidc_user_info.rb +235 -0
  223. data/lib/harbor2_client/models/overall_health_status.rb +197 -0
  224. data/lib/harbor2_client/models/password_req.rb +195 -0
  225. data/lib/harbor2_client/models/permission.rb +195 -0
  226. data/lib/harbor2_client/models/platform.rb +7 -7
  227. data/lib/harbor2_client/models/preheat_policy.rb +1 -1
  228. data/lib/harbor2_client/models/project.rb +1 -1
  229. data/lib/harbor2_client/models/project_deletable.rb +1 -1
  230. data/lib/harbor2_client/models/project_member.rb +203 -0
  231. data/lib/harbor2_client/models/project_member_entity.rb +245 -0
  232. data/lib/harbor2_client/models/project_metadata.rb +1 -1
  233. data/lib/harbor2_client/models/project_req.rb +16 -1
  234. data/lib/harbor2_client/models/project_scanner.rb +190 -0
  235. data/lib/harbor2_client/models/project_summary.rb +1 -1
  236. data/lib/harbor2_client/models/project_summary_quota.rb +1 -1
  237. data/lib/harbor2_client/models/provider_under_project.rb +1 -1
  238. data/lib/harbor2_client/models/quota.rb +236 -0
  239. data/lib/harbor2_client/models/quota_ref_object.rb +175 -0
  240. data/lib/harbor2_client/models/quota_update_req.rb +185 -0
  241. data/lib/harbor2_client/models/reference.rb +1 -1
  242. data/lib/harbor2_client/models/registry.rb +3 -3
  243. data/lib/harbor2_client/models/registry_credential.rb +1 -1
  244. data/lib/harbor2_client/models/registry_endpoint.rb +196 -0
  245. data/lib/harbor2_client/models/registry_info.rb +220 -0
  246. data/lib/harbor2_client/models/registry_ping.rb +245 -0
  247. data/lib/harbor2_client/models/registry_provider_credential_pattern.rb +216 -0
  248. data/lib/harbor2_client/models/registry_provider_endpoint_pattern.rb +198 -0
  249. data/lib/harbor2_client/models/registry_provider_info.rb +196 -0
  250. data/lib/harbor2_client/models/registry_update.rb +245 -0
  251. data/lib/harbor2_client/models/replication_execution.rb +296 -0
  252. data/lib/harbor2_client/models/replication_filter.rb +195 -0
  253. data/lib/harbor2_client/models/replication_policy.rb +326 -0
  254. data/lib/harbor2_client/models/replication_task.rb +276 -0
  255. data/lib/harbor2_client/models/replication_trigger.rb +194 -0
  256. data/lib/harbor2_client/models/replication_trigger_settings.rb +185 -0
  257. data/lib/harbor2_client/models/repository.rb +1 -1
  258. data/lib/harbor2_client/models/resource_list.rb +1 -1
  259. data/lib/harbor2_client/models/retention_execution.rb +238 -0
  260. data/lib/harbor2_client/models/retention_execution_task.rb +274 -0
  261. data/lib/harbor2_client/models/retention_metadata.rb +212 -0
  262. data/lib/harbor2_client/models/retention_policy.rb +223 -0
  263. data/lib/harbor2_client/models/retention_policy_scope.rb +193 -0
  264. data/lib/harbor2_client/models/retention_rule.rb +253 -0
  265. data/lib/harbor2_client/models/retention_rule_metadata.rb +218 -0
  266. data/lib/harbor2_client/models/retention_rule_param_metadata.rb +203 -0
  267. data/lib/harbor2_client/models/retention_rule_trigger.rb +202 -0
  268. data/lib/harbor2_client/models/retention_selector.rb +211 -0
  269. data/lib/harbor2_client/models/retention_selector_metadata.rb +205 -0
  270. data/lib/harbor2_client/models/robot.rb +296 -0
  271. data/lib/harbor2_client/models/robot_create.rb +247 -0
  272. data/lib/harbor2_client/models/robot_create_v1.rb +217 -0
  273. data/lib/harbor2_client/models/robot_created.rb +226 -0
  274. data/lib/harbor2_client/models/robot_permission.rb +206 -0
  275. data/lib/harbor2_client/models/robot_sec.rb +186 -0
  276. data/lib/harbor2_client/models/role_request.rb +185 -0
  277. data/lib/harbor2_client/models/scan_overview.rb +1 -1
  278. data/lib/harbor2_client/models/scanner.rb +205 -0
  279. data/lib/harbor2_client/models/scanner_adapter_metadata.rb +207 -0
  280. data/lib/harbor2_client/models/scanner_capability.rb +197 -0
  281. data/lib/harbor2_client/models/scanner_registration.rb +348 -0
  282. data/lib/harbor2_client/models/scanner_registration_req.rb +271 -0
  283. data/lib/harbor2_client/models/scanner_registration_settings.rb +227 -0
  284. data/lib/harbor2_client/models/schedule.rb +236 -0
  285. data/lib/harbor2_client/models/schedule_obj.rb +229 -0
  286. data/lib/harbor2_client/models/search.rb +211 -0
  287. data/lib/harbor2_client/models/search_repository.rb +235 -0
  288. data/lib/harbor2_client/models/search_result.rb +205 -0
  289. data/lib/harbor2_client/models/start_replication_execution.rb +185 -0
  290. data/lib/harbor2_client/models/statistic.rb +245 -0
  291. data/lib/harbor2_client/models/stats.rb +262 -0
  292. data/lib/harbor2_client/models/storage.rb +195 -0
  293. data/lib/harbor2_client/models/string_config_item.rb +195 -0
  294. data/lib/harbor2_client/models/supported_webhook_event_types.rb +198 -0
  295. data/lib/harbor2_client/models/system_info.rb +187 -0
  296. data/lib/harbor2_client/models/tag.rb +1 -1
  297. data/lib/harbor2_client/models/task.rb +1 -1
  298. data/lib/harbor2_client/models/user_creation_req.rb +250 -0
  299. data/lib/harbor2_client/models/user_entity.rb +195 -0
  300. data/lib/harbor2_client/models/user_group.rb +215 -0
  301. data/lib/harbor2_client/models/user_profile.rb +202 -0
  302. data/lib/harbor2_client/models/user_resp.rb +268 -0
  303. data/lib/harbor2_client/models/user_search.rb +194 -0
  304. data/lib/harbor2_client/models/user_search_resp_item.rb +194 -0
  305. data/lib/harbor2_client/models/user_sys_admin_flag.rb +185 -0
  306. data/lib/harbor2_client/models/vulnerability_summary.rb +1 -1
  307. data/lib/harbor2_client/models/webhook_job.rb +256 -0
  308. data/lib/harbor2_client/models/webhook_last_trigger.rb +226 -0
  309. data/lib/harbor2_client/models/webhook_policy.rb +278 -0
  310. data/lib/harbor2_client/models/webhook_target_object.rb +216 -0
  311. data/lib/harbor2_client/version.rb +2 -2
  312. data/lib/harbor2_client.rb +127 -1
  313. data/spec/api/artifact_api_spec.rb +21 -1
  314. data/spec/api/auditlog_api_spec.rb +2 -1
  315. data/spec/api/configure_api_spec.rb +72 -0
  316. data/spec/api/gc_api_spec.rb +115 -0
  317. data/spec/api/health_api_spec.rb +47 -0
  318. data/spec/api/icon_api_spec.rb +1 -1
  319. data/spec/api/immutable_api_spec.rb +97 -0
  320. data/spec/api/label_api_spec.rb +107 -0
  321. data/spec/api/ldap_api_spec.rb +88 -0
  322. data/spec/api/member_api_spec.rb +112 -0
  323. data/spec/api/oidc_api_spec.rb +48 -0
  324. data/spec/api/ping_api_spec.rb +47 -0
  325. data/spec/api/preheat_api_spec.rb +5 -1
  326. data/spec/api/project_api_spec.rb +63 -6
  327. data/spec/api/project_metadata_api_spec.rb +110 -0
  328. data/spec/api/quota_api_spec.rb +79 -0
  329. data/spec/api/registry_api_spec.rb +155 -0
  330. data/spec/api/replication_api_spec.rb +194 -0
  331. data/spec/api/repository_api_spec.rb +18 -1
  332. data/spec/api/retention_api_spec.rb +175 -0
  333. data/spec/api/robot_api_spec.rb +118 -0
  334. data/spec/api/robotv1_api_spec.rb +114 -0
  335. data/spec/api/scan_all_api_spec.rb +97 -0
  336. data/spec/api/scan_api_spec.rb +1 -1
  337. data/spec/api/scanner_api_spec.rb +144 -0
  338. data/spec/api/search_api_spec.rb +48 -0
  339. data/spec/api/statistic_api_spec.rb +47 -0
  340. data/spec/api/system_cve_allowlist_api_spec.rb +60 -0
  341. data/spec/api/systeminfo_api_spec.rb +71 -0
  342. data/spec/api/user_api_spec.rb +181 -0
  343. data/spec/api/usergroup_api_spec.rb +100 -0
  344. data/spec/api/webhook_api_spec.rb +142 -0
  345. data/spec/api/webhookjob_api_spec.rb +55 -0
  346. data/spec/api_client_spec.rb +1 -1
  347. data/spec/configuration_spec.rb +1 -1
  348. data/spec/models/access_spec.rb +53 -0
  349. data/spec/models/addition_link_spec.rb +1 -1
  350. data/spec/models/addition_links_spec.rb +1 -1
  351. data/spec/models/annotations_spec.rb +1 -1
  352. data/spec/models/artifact_spec.rb +1 -1
  353. data/spec/models/audit_log_spec.rb +1 -1
  354. data/spec/models/authproxy_setting_spec.rb +65 -0
  355. data/spec/models/body_1_spec.rb +41 -0
  356. data/spec/models/body_spec.rb +41 -0
  357. data/spec/models/bool_config_item_spec.rb +47 -0
  358. data/spec/models/chart_metadata_spec.rb +101 -0
  359. data/spec/models/chart_version_spec.rb +131 -0
  360. data/spec/models/component_health_status_spec.rb +53 -0
  361. data/spec/models/configurations_response_scan_all_policy_parameter_spec.rb +41 -0
  362. data/spec/models/configurations_response_scan_all_policy_spec.rb +47 -0
  363. data/spec/models/configurations_response_spec.rb +353 -0
  364. data/spec/models/configurations_spec.rb +365 -0
  365. data/spec/models/cve_allowlist_item_spec.rb +1 -1
  366. data/spec/models/cve_allowlist_spec.rb +1 -1
  367. data/spec/models/endpoint_spec.rb +47 -0
  368. data/spec/models/error_spec.rb +1 -1
  369. data/spec/models/errors_spec.rb +1 -1
  370. data/spec/models/event_type_spec.rb +35 -0
  371. data/spec/models/execution_spec.rb +1 -1
  372. data/spec/models/extra_attrs_spec.rb +1 -1
  373. data/spec/models/filter_style_spec.rb +53 -0
  374. data/spec/models/gc_history_spec.rb +89 -0
  375. data/spec/models/general_info_spec.rb +113 -0
  376. data/spec/models/icon_spec.rb +1 -1
  377. data/spec/models/immutable_rule_spec.rb +83 -0
  378. data/spec/models/immutable_selector_spec.rb +59 -0
  379. data/spec/models/instance_spec.rb +1 -1
  380. data/spec/models/integer_config_item_spec.rb +47 -0
  381. data/spec/models/internal_configurations_response_spec.rb +35 -0
  382. data/spec/models/is_default_spec.rb +41 -0
  383. data/spec/models/label_spec.rb +1 -1
  384. data/spec/models/ldap_conf_spec.rb +89 -0
  385. data/spec/models/ldap_failed_import_user_spec.rb +47 -0
  386. data/spec/models/ldap_import_users_spec.rb +41 -0
  387. data/spec/models/ldap_ping_result_spec.rb +47 -0
  388. data/spec/models/ldap_user_spec.rb +53 -0
  389. data/spec/models/metadata_spec.rb +1 -1
  390. data/spec/models/metrics_spec.rb +1 -1
  391. data/spec/models/native_report_summary_spec.rb +7 -1
  392. data/spec/models/notify_type_spec.rb +35 -0
  393. data/spec/models/oidc_cli_secret_req_spec.rb +41 -0
  394. data/spec/models/oidc_user_info_spec.rb +71 -0
  395. data/spec/models/overall_health_status_spec.rb +47 -0
  396. data/spec/models/password_req_spec.rb +47 -0
  397. data/spec/models/permission_spec.rb +47 -0
  398. data/spec/models/platform_spec.rb +1 -1
  399. data/spec/models/preheat_policy_spec.rb +1 -1
  400. data/spec/models/project_deletable_spec.rb +1 -1
  401. data/spec/models/project_member_entity_spec.rb +77 -0
  402. data/spec/models/project_member_spec.rb +53 -0
  403. data/spec/models/project_metadata_spec.rb +1 -1
  404. data/spec/models/project_req_spec.rb +1 -1
  405. data/spec/models/project_scanner_spec.rb +41 -0
  406. data/spec/models/project_spec.rb +1 -1
  407. data/spec/models/project_summary_quota_spec.rb +1 -1
  408. data/spec/models/project_summary_spec.rb +1 -1
  409. data/spec/models/provider_under_project_spec.rb +1 -1
  410. data/spec/models/quota_ref_object_spec.rb +35 -0
  411. data/spec/models/quota_spec.rb +71 -0
  412. data/spec/models/quota_update_req_spec.rb +41 -0
  413. data/spec/models/reference_spec.rb +1 -1
  414. data/spec/models/registry_credential_spec.rb +1 -1
  415. data/spec/models/registry_endpoint_spec.rb +47 -0
  416. data/spec/models/registry_info_spec.rb +59 -0
  417. data/spec/models/registry_ping_spec.rb +77 -0
  418. data/spec/models/registry_provider_credential_pattern_spec.rb +59 -0
  419. data/spec/models/registry_provider_endpoint_pattern_spec.rb +47 -0
  420. data/spec/models/registry_provider_info_spec.rb +47 -0
  421. data/spec/models/registry_spec.rb +1 -1
  422. data/spec/models/registry_update_spec.rb +77 -0
  423. data/spec/models/replication_execution_spec.rb +107 -0
  424. data/spec/models/replication_filter_spec.rb +47 -0
  425. data/spec/models/replication_policy_spec.rb +125 -0
  426. data/spec/models/replication_task_spec.rb +95 -0
  427. data/spec/models/replication_trigger_settings_spec.rb +41 -0
  428. data/spec/models/replication_trigger_spec.rb +47 -0
  429. data/spec/models/repository_spec.rb +1 -1
  430. data/spec/models/resource_list_spec.rb +1 -1
  431. data/spec/models/retention_execution_spec.rb +77 -0
  432. data/spec/models/retention_execution_task_spec.rb +101 -0
  433. data/spec/models/retention_metadata_spec.rb +53 -0
  434. data/spec/models/retention_policy_scope_spec.rb +47 -0
  435. data/spec/models/retention_policy_spec.rb +65 -0
  436. data/spec/models/retention_rule_metadata_spec.rb +59 -0
  437. data/spec/models/retention_rule_param_metadata_spec.rb +53 -0
  438. data/spec/models/retention_rule_spec.rb +83 -0
  439. data/spec/models/retention_rule_trigger_spec.rb +53 -0
  440. data/spec/models/retention_selector_metadata_spec.rb +53 -0
  441. data/spec/models/retention_selector_spec.rb +59 -0
  442. data/spec/models/robot_create_spec.rb +77 -0
  443. data/spec/models/robot_create_v1_spec.rb +59 -0
  444. data/spec/models/robot_created_spec.rb +65 -0
  445. data/spec/models/robot_permission_spec.rb +53 -0
  446. data/spec/models/robot_sec_spec.rb +41 -0
  447. data/spec/models/robot_spec.rb +107 -0
  448. data/spec/models/role_request_spec.rb +41 -0
  449. data/spec/models/scan_overview_spec.rb +1 -1
  450. data/spec/models/scanner_adapter_metadata_spec.rb +53 -0
  451. data/spec/models/scanner_capability_spec.rb +47 -0
  452. data/spec/models/scanner_registration_req_spec.rb +83 -0
  453. data/spec/models/scanner_registration_settings_spec.rb +59 -0
  454. data/spec/models/scanner_registration_spec.rb +131 -0
  455. data/spec/models/scanner_spec.rb +53 -0
  456. data/spec/models/schedule_obj_spec.rb +51 -0
  457. data/spec/models/schedule_spec.rb +71 -0
  458. data/spec/models/search_repository_spec.rb +71 -0
  459. data/spec/models/search_result_spec.rb +53 -0
  460. data/spec/models/search_spec.rb +53 -0
  461. data/spec/models/start_replication_execution_spec.rb +41 -0
  462. data/spec/models/statistic_spec.rb +77 -0
  463. data/spec/models/stats_spec.rb +69 -0
  464. data/spec/models/storage_spec.rb +47 -0
  465. data/spec/models/string_config_item_spec.rb +47 -0
  466. data/spec/models/supported_webhook_event_types_spec.rb +47 -0
  467. data/spec/models/system_info_spec.rb +41 -0
  468. data/spec/models/tag_spec.rb +1 -1
  469. data/spec/models/task_spec.rb +1 -1
  470. data/spec/models/user_creation_req_spec.rb +65 -0
  471. data/spec/models/user_entity_spec.rb +47 -0
  472. data/spec/models/user_group_spec.rb +59 -0
  473. data/spec/models/user_profile_spec.rb +53 -0
  474. data/spec/models/user_resp_spec.rb +95 -0
  475. data/spec/models/user_search_resp_item_spec.rb +47 -0
  476. data/spec/models/user_search_spec.rb +47 -0
  477. data/spec/models/user_sys_admin_flag_spec.rb +41 -0
  478. data/spec/models/vulnerability_summary_spec.rb +1 -1
  479. data/spec/models/webhook_job_spec.rb +83 -0
  480. data/spec/models/webhook_last_trigger_spec.rb +65 -0
  481. data/spec/models/webhook_policy_spec.rb +95 -0
  482. data/spec/models/webhook_target_object_spec.rb +59 -0
  483. data/spec/spec_helper.rb +1 -1
  484. metadata +512 -7
data/docs/UserApi.md ADDED
@@ -0,0 +1,647 @@
1
+ # Harbor2Client::UserApi
2
+
3
+ All URIs are relative to *http://localhost/api/v2.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_user**](UserApi.md#create_user) | **POST** /users | Create a local user.
8
+ [**delete_user**](UserApi.md#delete_user) | **DELETE** /users/{user_id} | Mark a registered user as be removed.
9
+ [**get_current_user_info**](UserApi.md#get_current_user_info) | **GET** /users/current | Get current user info.
10
+ [**get_current_user_permissions**](UserApi.md#get_current_user_permissions) | **GET** /users/current/permissions | Get current user permissions.
11
+ [**get_user**](UserApi.md#get_user) | **GET** /users/{user_id} | Get a user's profile.
12
+ [**list_users**](UserApi.md#list_users) | **GET** /users | List users
13
+ [**search_users**](UserApi.md#search_users) | **GET** /users/search | Search users by username
14
+ [**set_cli_secret**](UserApi.md#set_cli_secret) | **PUT** /users/{user_id}/cli_secret | Set CLI secret for a user.
15
+ [**set_user_sys_admin**](UserApi.md#set_user_sys_admin) | **PUT** /users/{user_id}/sysadmin | Update a registered user to change to be an administrator of Harbor.
16
+ [**update_user_password**](UserApi.md#update_user_password) | **PUT** /users/{user_id}/password | Change the password on a user that already exists.
17
+ [**update_user_profile**](UserApi.md#update_user_profile) | **PUT** /users/{user_id} | Update user's profile.
18
+
19
+
20
+ # **create_user**
21
+ > create_user(user_req, opts)
22
+
23
+ Create a local user.
24
+
25
+ This API can be used only when the authentication mode is for local DB. When self registration is disabled.
26
+
27
+ ### Example
28
+ ```ruby
29
+ # load the gem
30
+ require 'harbor2_client'
31
+ # setup authorization
32
+ Harbor2Client.configure do |config|
33
+ # Configure HTTP basic authorization: basic
34
+ config.username = 'YOUR USERNAME'
35
+ config.password = 'YOUR PASSWORD'
36
+ end
37
+
38
+ api_instance = Harbor2Client::UserApi.new
39
+
40
+ user_req = Harbor2Client::UserCreationReq.new # UserCreationReq | The new user
41
+
42
+ opts = {
43
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
44
+ }
45
+
46
+ begin
47
+ #Create a local user.
48
+ api_instance.create_user(user_req, opts)
49
+ rescue Harbor2Client::ApiError => e
50
+ puts "Exception when calling UserApi->create_user: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **user_req** | [**UserCreationReq**](UserCreationReq.md)| The new user |
59
+ **x_request_id** | **String**| An unique ID for the request | [optional]
60
+
61
+ ### Return type
62
+
63
+ nil (empty response body)
64
+
65
+ ### Authorization
66
+
67
+ [basic](../README.md#basic)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: application/json
72
+ - **Accept**: application/json
73
+
74
+
75
+
76
+ # **delete_user**
77
+ > delete_user(user_id, opts)
78
+
79
+ Mark a registered user as be removed.
80
+
81
+ This endpoint let administrator of Harbor mark a registered user as removed.It actually won't be deleted from DB.
82
+
83
+ ### Example
84
+ ```ruby
85
+ # load the gem
86
+ require 'harbor2_client'
87
+ # setup authorization
88
+ Harbor2Client.configure do |config|
89
+ # Configure HTTP basic authorization: basic
90
+ config.username = 'YOUR USERNAME'
91
+ config.password = 'YOUR PASSWORD'
92
+ end
93
+
94
+ api_instance = Harbor2Client::UserApi.new
95
+
96
+ user_id = 56 # Integer | User ID for marking as to be removed.
97
+
98
+ opts = {
99
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
100
+ }
101
+
102
+ begin
103
+ #Mark a registered user as be removed.
104
+ api_instance.delete_user(user_id, opts)
105
+ rescue Harbor2Client::ApiError => e
106
+ puts "Exception when calling UserApi->delete_user: #{e}"
107
+ end
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ Name | Type | Description | Notes
113
+ ------------- | ------------- | ------------- | -------------
114
+ **user_id** | **Integer**| User ID for marking as to be removed. |
115
+ **x_request_id** | **String**| An unique ID for the request | [optional]
116
+
117
+ ### Return type
118
+
119
+ nil (empty response body)
120
+
121
+ ### Authorization
122
+
123
+ [basic](../README.md#basic)
124
+
125
+ ### HTTP request headers
126
+
127
+ - **Content-Type**: application/json
128
+ - **Accept**: application/json
129
+
130
+
131
+
132
+ # **get_current_user_info**
133
+ > UserResp get_current_user_info(opts)
134
+
135
+ Get current user info.
136
+
137
+ ### Example
138
+ ```ruby
139
+ # load the gem
140
+ require 'harbor2_client'
141
+ # setup authorization
142
+ Harbor2Client.configure do |config|
143
+ # Configure HTTP basic authorization: basic
144
+ config.username = 'YOUR USERNAME'
145
+ config.password = 'YOUR PASSWORD'
146
+ end
147
+
148
+ api_instance = Harbor2Client::UserApi.new
149
+
150
+ opts = {
151
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
152
+ }
153
+
154
+ begin
155
+ #Get current user info.
156
+ result = api_instance.get_current_user_info(opts)
157
+ p result
158
+ rescue Harbor2Client::ApiError => e
159
+ puts "Exception when calling UserApi->get_current_user_info: #{e}"
160
+ end
161
+ ```
162
+
163
+ ### Parameters
164
+
165
+ Name | Type | Description | Notes
166
+ ------------- | ------------- | ------------- | -------------
167
+ **x_request_id** | **String**| An unique ID for the request | [optional]
168
+
169
+ ### Return type
170
+
171
+ [**UserResp**](UserResp.md)
172
+
173
+ ### Authorization
174
+
175
+ [basic](../README.md#basic)
176
+
177
+ ### HTTP request headers
178
+
179
+ - **Content-Type**: application/json
180
+ - **Accept**: application/json
181
+
182
+
183
+
184
+ # **get_current_user_permissions**
185
+ > Array<Permission> get_current_user_permissions(opts)
186
+
187
+ Get current user permissions.
188
+
189
+ ### Example
190
+ ```ruby
191
+ # load the gem
192
+ require 'harbor2_client'
193
+ # setup authorization
194
+ Harbor2Client.configure do |config|
195
+ # Configure HTTP basic authorization: basic
196
+ config.username = 'YOUR USERNAME'
197
+ config.password = 'YOUR PASSWORD'
198
+ end
199
+
200
+ api_instance = Harbor2Client::UserApi.new
201
+
202
+ opts = {
203
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
204
+ scope: 'scope_example', # String | The scope for the permission
205
+ relative: true # BOOLEAN | If true, the resources in the response are relative to the scope, eg for resource '/project/1/repository' if relative is 'true' then the resource in response will be 'repository'.
206
+ }
207
+
208
+ begin
209
+ #Get current user permissions.
210
+ result = api_instance.get_current_user_permissions(opts)
211
+ p result
212
+ rescue Harbor2Client::ApiError => e
213
+ puts "Exception when calling UserApi->get_current_user_permissions: #{e}"
214
+ end
215
+ ```
216
+
217
+ ### Parameters
218
+
219
+ Name | Type | Description | Notes
220
+ ------------- | ------------- | ------------- | -------------
221
+ **x_request_id** | **String**| An unique ID for the request | [optional]
222
+ **scope** | **String**| The scope for the permission | [optional]
223
+ **relative** | **BOOLEAN**| If true, the resources in the response are relative to the scope, eg for resource '/project/1/repository' if relative is 'true' then the resource in response will be 'repository'. | [optional]
224
+
225
+ ### Return type
226
+
227
+ [**Array<Permission>**](Permission.md)
228
+
229
+ ### Authorization
230
+
231
+ [basic](../README.md#basic)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: application/json
236
+ - **Accept**: application/json
237
+
238
+
239
+
240
+ # **get_user**
241
+ > UserResp get_user(user_id, opts)
242
+
243
+ Get a user's profile.
244
+
245
+ ### Example
246
+ ```ruby
247
+ # load the gem
248
+ require 'harbor2_client'
249
+ # setup authorization
250
+ Harbor2Client.configure do |config|
251
+ # Configure HTTP basic authorization: basic
252
+ config.username = 'YOUR USERNAME'
253
+ config.password = 'YOUR PASSWORD'
254
+ end
255
+
256
+ api_instance = Harbor2Client::UserApi.new
257
+
258
+ user_id = 56 # Integer |
259
+
260
+ opts = {
261
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
262
+ }
263
+
264
+ begin
265
+ #Get a user's profile.
266
+ result = api_instance.get_user(user_id, opts)
267
+ p result
268
+ rescue Harbor2Client::ApiError => e
269
+ puts "Exception when calling UserApi->get_user: #{e}"
270
+ end
271
+ ```
272
+
273
+ ### Parameters
274
+
275
+ Name | Type | Description | Notes
276
+ ------------- | ------------- | ------------- | -------------
277
+ **user_id** | **Integer**| |
278
+ **x_request_id** | **String**| An unique ID for the request | [optional]
279
+
280
+ ### Return type
281
+
282
+ [**UserResp**](UserResp.md)
283
+
284
+ ### Authorization
285
+
286
+ [basic](../README.md#basic)
287
+
288
+ ### HTTP request headers
289
+
290
+ - **Content-Type**: application/json
291
+ - **Accept**: application/json
292
+
293
+
294
+
295
+ # **list_users**
296
+ > Array<UserResp> list_users(opts)
297
+
298
+ List users
299
+
300
+ ### Example
301
+ ```ruby
302
+ # load the gem
303
+ require 'harbor2_client'
304
+ # setup authorization
305
+ Harbor2Client.configure do |config|
306
+ # Configure HTTP basic authorization: basic
307
+ config.username = 'YOUR USERNAME'
308
+ config.password = 'YOUR PASSWORD'
309
+ end
310
+
311
+ api_instance = Harbor2Client::UserApi.new
312
+
313
+ opts = {
314
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
315
+ q: 'q_example', # String | Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max]
316
+ sort: 'sort_example', # String | Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\"
317
+ page: 1, # Integer | The page number
318
+ page_size: 10, # Integer | The size of per page
319
+ }
320
+
321
+ begin
322
+ #List users
323
+ result = api_instance.list_users(opts)
324
+ p result
325
+ rescue Harbor2Client::ApiError => e
326
+ puts "Exception when calling UserApi->list_users: #{e}"
327
+ end
328
+ ```
329
+
330
+ ### Parameters
331
+
332
+ Name | Type | Description | Notes
333
+ ------------- | ------------- | ------------- | -------------
334
+ **x_request_id** | **String**| An unique ID for the request | [optional]
335
+ **q** | **String**| Query string to query resources. Supported query patterns are \"exact match(k=v)\", \"fuzzy match(k=~v)\", \"range(k=[min~max])\", \"list with union releationship(k={v1 v2 v3})\" and \"list with intersetion relationship(k=(v1 v2 v3))\". The value of range and list can be string(enclosed by \" or '), integer or time(in format \"2020-04-09 02:36:00\"). All of these query patterns should be put in the query string \"q=xxx\" and splitted by \",\". e.g. q=k1=v1,k2=~v2,k3=[min~max] | [optional]
336
+ **sort** | **String**| Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with \"sort=field1,-field2\" | [optional]
337
+ **page** | **Integer**| The page number | [optional] [default to 1]
338
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
339
+
340
+ ### Return type
341
+
342
+ [**Array<UserResp>**](UserResp.md)
343
+
344
+ ### Authorization
345
+
346
+ [basic](../README.md#basic)
347
+
348
+ ### HTTP request headers
349
+
350
+ - **Content-Type**: application/json
351
+ - **Accept**: application/json
352
+
353
+
354
+
355
+ # **search_users**
356
+ > Array<UserSearchRespItem> search_users(username, opts)
357
+
358
+ Search users by username
359
+
360
+ This endpoint is to search the users by username. It's open for all authenticated requests.
361
+
362
+ ### Example
363
+ ```ruby
364
+ # load the gem
365
+ require 'harbor2_client'
366
+ # setup authorization
367
+ Harbor2Client.configure do |config|
368
+ # Configure HTTP basic authorization: basic
369
+ config.username = 'YOUR USERNAME'
370
+ config.password = 'YOUR PASSWORD'
371
+ end
372
+
373
+ api_instance = Harbor2Client::UserApi.new
374
+
375
+ username = 'username_example' # String | Username for filtering results.
376
+
377
+ opts = {
378
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
379
+ page: 1, # Integer | The page number
380
+ page_size: 10, # Integer | The size of per page
381
+ }
382
+
383
+ begin
384
+ #Search users by username
385
+ result = api_instance.search_users(username, opts)
386
+ p result
387
+ rescue Harbor2Client::ApiError => e
388
+ puts "Exception when calling UserApi->search_users: #{e}"
389
+ end
390
+ ```
391
+
392
+ ### Parameters
393
+
394
+ Name | Type | Description | Notes
395
+ ------------- | ------------- | ------------- | -------------
396
+ **username** | **String**| Username for filtering results. |
397
+ **x_request_id** | **String**| An unique ID for the request | [optional]
398
+ **page** | **Integer**| The page number | [optional] [default to 1]
399
+ **page_size** | **Integer**| The size of per page | [optional] [default to 10]
400
+
401
+ ### Return type
402
+
403
+ [**Array<UserSearchRespItem>**](UserSearchRespItem.md)
404
+
405
+ ### Authorization
406
+
407
+ [basic](../README.md#basic)
408
+
409
+ ### HTTP request headers
410
+
411
+ - **Content-Type**: application/json
412
+ - **Accept**: application/json
413
+
414
+
415
+
416
+ # **set_cli_secret**
417
+ > set_cli_secret(user_id, secret, opts)
418
+
419
+ Set CLI secret for a user.
420
+
421
+ This endpoint let user generate a new CLI secret for himself. This API only works when auth mode is set to 'OIDC'. Once this API returns with successful status, the old secret will be invalid, as there will be only one CLI secret for a user.
422
+
423
+ ### Example
424
+ ```ruby
425
+ # load the gem
426
+ require 'harbor2_client'
427
+ # setup authorization
428
+ Harbor2Client.configure do |config|
429
+ # Configure HTTP basic authorization: basic
430
+ config.username = 'YOUR USERNAME'
431
+ config.password = 'YOUR PASSWORD'
432
+ end
433
+
434
+ api_instance = Harbor2Client::UserApi.new
435
+
436
+ user_id = 56 # Integer | User ID
437
+
438
+ secret = Harbor2Client::OIDCCliSecretReq.new # OIDCCliSecretReq |
439
+
440
+ opts = {
441
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
442
+ }
443
+
444
+ begin
445
+ #Set CLI secret for a user.
446
+ api_instance.set_cli_secret(user_id, secret, opts)
447
+ rescue Harbor2Client::ApiError => e
448
+ puts "Exception when calling UserApi->set_cli_secret: #{e}"
449
+ end
450
+ ```
451
+
452
+ ### Parameters
453
+
454
+ Name | Type | Description | Notes
455
+ ------------- | ------------- | ------------- | -------------
456
+ **user_id** | **Integer**| User ID |
457
+ **secret** | [**OIDCCliSecretReq**](OIDCCliSecretReq.md)| |
458
+ **x_request_id** | **String**| An unique ID for the request | [optional]
459
+
460
+ ### Return type
461
+
462
+ nil (empty response body)
463
+
464
+ ### Authorization
465
+
466
+ [basic](../README.md#basic)
467
+
468
+ ### HTTP request headers
469
+
470
+ - **Content-Type**: application/json
471
+ - **Accept**: application/json
472
+
473
+
474
+
475
+ # **set_user_sys_admin**
476
+ > set_user_sys_admin(user_id, sysadmin_flag, opts)
477
+
478
+ Update a registered user to change to be an administrator of Harbor.
479
+
480
+ ### Example
481
+ ```ruby
482
+ # load the gem
483
+ require 'harbor2_client'
484
+ # setup authorization
485
+ Harbor2Client.configure do |config|
486
+ # Configure HTTP basic authorization: basic
487
+ config.username = 'YOUR USERNAME'
488
+ config.password = 'YOUR PASSWORD'
489
+ end
490
+
491
+ api_instance = Harbor2Client::UserApi.new
492
+
493
+ user_id = 56 # Integer |
494
+
495
+ sysadmin_flag = Harbor2Client::UserSysAdminFlag.new # UserSysAdminFlag | Toggle a user to admin or not.
496
+
497
+ opts = {
498
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
499
+ }
500
+
501
+ begin
502
+ #Update a registered user to change to be an administrator of Harbor.
503
+ api_instance.set_user_sys_admin(user_id, sysadmin_flag, opts)
504
+ rescue Harbor2Client::ApiError => e
505
+ puts "Exception when calling UserApi->set_user_sys_admin: #{e}"
506
+ end
507
+ ```
508
+
509
+ ### Parameters
510
+
511
+ Name | Type | Description | Notes
512
+ ------------- | ------------- | ------------- | -------------
513
+ **user_id** | **Integer**| |
514
+ **sysadmin_flag** | [**UserSysAdminFlag**](UserSysAdminFlag.md)| Toggle a user to admin or not. |
515
+ **x_request_id** | **String**| An unique ID for the request | [optional]
516
+
517
+ ### Return type
518
+
519
+ nil (empty response body)
520
+
521
+ ### Authorization
522
+
523
+ [basic](../README.md#basic)
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: application/json
528
+ - **Accept**: application/json
529
+
530
+
531
+
532
+ # **update_user_password**
533
+ > update_user_password(user_id, password, opts)
534
+
535
+ Change the password on a user that already exists.
536
+
537
+ This endpoint is for user to update password. Users with the admin role can change any user's password. Regular users can change only their own password.
538
+
539
+ ### Example
540
+ ```ruby
541
+ # load the gem
542
+ require 'harbor2_client'
543
+ # setup authorization
544
+ Harbor2Client.configure do |config|
545
+ # Configure HTTP basic authorization: basic
546
+ config.username = 'YOUR USERNAME'
547
+ config.password = 'YOUR PASSWORD'
548
+ end
549
+
550
+ api_instance = Harbor2Client::UserApi.new
551
+
552
+ user_id = 56 # Integer |
553
+
554
+ password = Harbor2Client::PasswordReq.new # PasswordReq | Password to be updated, the attribute 'old_password' is optional when the API is called by the system administrator.
555
+
556
+ opts = {
557
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
558
+ }
559
+
560
+ begin
561
+ #Change the password on a user that already exists.
562
+ api_instance.update_user_password(user_id, password, opts)
563
+ rescue Harbor2Client::ApiError => e
564
+ puts "Exception when calling UserApi->update_user_password: #{e}"
565
+ end
566
+ ```
567
+
568
+ ### Parameters
569
+
570
+ Name | Type | Description | Notes
571
+ ------------- | ------------- | ------------- | -------------
572
+ **user_id** | **Integer**| |
573
+ **password** | [**PasswordReq**](PasswordReq.md)| Password to be updated, the attribute 'old_password' is optional when the API is called by the system administrator. |
574
+ **x_request_id** | **String**| An unique ID for the request | [optional]
575
+
576
+ ### Return type
577
+
578
+ nil (empty response body)
579
+
580
+ ### Authorization
581
+
582
+ [basic](../README.md#basic)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: application/json
587
+ - **Accept**: application/json
588
+
589
+
590
+
591
+ # **update_user_profile**
592
+ > update_user_profile(user_id, profile, opts)
593
+
594
+ Update user's profile.
595
+
596
+ ### Example
597
+ ```ruby
598
+ # load the gem
599
+ require 'harbor2_client'
600
+ # setup authorization
601
+ Harbor2Client.configure do |config|
602
+ # Configure HTTP basic authorization: basic
603
+ config.username = 'YOUR USERNAME'
604
+ config.password = 'YOUR PASSWORD'
605
+ end
606
+
607
+ api_instance = Harbor2Client::UserApi.new
608
+
609
+ user_id = 56 # Integer | Registered user ID
610
+
611
+ profile = Harbor2Client::UserProfile.new # UserProfile | Only email, realname and comment can be modified.
612
+
613
+ opts = {
614
+ x_request_id: 'x_request_id_example' # String | An unique ID for the request
615
+ }
616
+
617
+ begin
618
+ #Update user's profile.
619
+ api_instance.update_user_profile(user_id, profile, opts)
620
+ rescue Harbor2Client::ApiError => e
621
+ puts "Exception when calling UserApi->update_user_profile: #{e}"
622
+ end
623
+ ```
624
+
625
+ ### Parameters
626
+
627
+ Name | Type | Description | Notes
628
+ ------------- | ------------- | ------------- | -------------
629
+ **user_id** | **Integer**| Registered user ID |
630
+ **profile** | [**UserProfile**](UserProfile.md)| Only email, realname and comment can be modified. |
631
+ **x_request_id** | **String**| An unique ID for the request | [optional]
632
+
633
+ ### Return type
634
+
635
+ nil (empty response body)
636
+
637
+ ### Authorization
638
+
639
+ [basic](../README.md#basic)
640
+
641
+ ### HTTP request headers
642
+
643
+ - **Content-Type**: application/json
644
+ - **Accept**: application/json
645
+
646
+
647
+
@@ -0,0 +1,12 @@
1
+ # Harbor2Client::UserCreationReq
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | | [optional]
7
+ **realname** | **String** | | [optional]
8
+ **comment** | **String** | | [optional]
9
+ **password** | **String** | | [optional]
10
+ **username** | **String** | | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # Harbor2Client::UserEntity
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **user_id** | **Integer** | The ID of the user. | [optional]
7
+ **username** | **String** | The name of the user. | [optional]
8
+
9
+
data/docs/UserGroup.md ADDED
@@ -0,0 +1,11 @@
1
+ # Harbor2Client::UserGroup
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | The ID of the user group | [optional]
7
+ **group_name** | **String** | The name of the user group | [optional]
8
+ **group_type** | **Integer** | The group type, 1 for LDAP group, 2 for HTTP group. | [optional]
9
+ **ldap_group_dn** | **String** | The DN of the LDAP group if group type is 1 (LDAP group). | [optional]
10
+
11
+
@@ -0,0 +1,10 @@
1
+ # Harbor2Client::UserProfile
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | | [optional]
7
+ **realname** | **String** | | [optional]
8
+ **comment** | **String** | | [optional]
9
+
10
+
data/docs/UserResp.md ADDED
@@ -0,0 +1,17 @@
1
+ # Harbor2Client::UserResp
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **email** | **String** | | [optional]
7
+ **realname** | **String** | | [optional]
8
+ **comment** | **String** | | [optional]
9
+ **user_id** | **Integer** | | [optional]
10
+ **username** | **String** | | [optional]
11
+ **sysadmin_flag** | **BOOLEAN** | | [optional]
12
+ **admin_role_in_auth** | **BOOLEAN** | indicate the admin privilege is grant by authenticator (LDAP), is always false unless it is the current login user | [optional]
13
+ **oidc_user_meta** | [**OIDCUserInfo**](OIDCUserInfo.md) | | [optional]
14
+ **creation_time** | **DateTime** | The creation time of the user. | [optional]
15
+ **update_time** | **DateTime** | The update time of the user. | [optional]
16
+
17
+