ionoscloud 5.0.0 → 5.1.2

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 (463) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +68 -0
  3. data/LICENSE +190 -0
  4. data/README.md +14 -4
  5. data/docs/README.md +111 -0
  6. data/docs/api/BackupUnitApi.md +595 -0
  7. data/docs/api/ContractApi.md +89 -0
  8. data/docs/api/DataCenterApi.md +517 -0
  9. data/docs/api/DefaultApi.md +89 -0
  10. data/docs/api/IPBlocksApi.md +517 -0
  11. data/docs/api/ImageApi.md +429 -0
  12. data/docs/api/KubernetesApi.md +1513 -0
  13. data/docs/api/LabelApi.md +2355 -0
  14. data/docs/api/LanApi.md +795 -0
  15. data/docs/api/LoadBalancerApi.md +883 -0
  16. data/docs/api/LocationApi.md +259 -0
  17. data/docs/api/NicApi.md +1087 -0
  18. data/docs/api/PrivateCrossConnectApi.md +427 -0
  19. data/docs/api/RequestApi.md +283 -0
  20. data/docs/api/ServerApi.md +1573 -0
  21. data/docs/api/SnapshotApi.md +429 -0
  22. data/docs/api/UserManagementApi.md +2551 -0
  23. data/docs/api/VolumeApi.md +711 -0
  24. data/docs/models/AttachedVolumes.md +30 -0
  25. data/docs/models/BackupUnit.md +26 -0
  26. data/docs/models/BackupUnitProperties.md +22 -0
  27. data/docs/models/BackupUnitSSO.md +18 -0
  28. data/docs/models/BackupUnits.md +24 -0
  29. data/docs/models/BalancedNics.md +30 -0
  30. data/docs/models/Cdroms.md +30 -0
  31. data/docs/models/ConnectableDatacenter.md +22 -0
  32. data/docs/models/Contract.md +20 -0
  33. data/docs/models/ContractProperties.md +26 -0
  34. data/docs/models/DataCenterEntities.md +24 -0
  35. data/docs/models/Datacenter.md +28 -0
  36. data/docs/models/DatacenterElementMetadata.md +32 -0
  37. data/docs/models/DatacenterProperties.md +28 -0
  38. data/docs/models/Datacenters.md +30 -0
  39. data/docs/models/Error.md +20 -0
  40. data/docs/models/ErrorMessage.md +20 -0
  41. data/docs/models/FirewallRule.md +26 -0
  42. data/docs/models/FirewallRules.md +30 -0
  43. data/docs/models/FirewallruleProperties.md +34 -0
  44. data/docs/models/Group.md +26 -0
  45. data/docs/models/GroupEntities.md +20 -0
  46. data/docs/models/GroupMembers.md +24 -0
  47. data/docs/models/GroupProperties.md +36 -0
  48. data/docs/models/GroupShare.md +24 -0
  49. data/docs/models/GroupShareProperties.md +20 -0
  50. data/docs/models/GroupShares.md +24 -0
  51. data/docs/models/GroupUsers.md +24 -0
  52. data/docs/models/Groups.md +24 -0
  53. data/docs/models/IPFailover.md +20 -0
  54. data/docs/models/Image.md +26 -0
  55. data/docs/models/ImageProperties.md +54 -0
  56. data/docs/models/Images.md +24 -0
  57. data/docs/models/Info.md +22 -0
  58. data/docs/models/IpBlock.md +26 -0
  59. data/docs/models/IpBlockProperties.md +26 -0
  60. data/docs/models/IpBlocks.md +30 -0
  61. data/docs/models/IpConsumer.md +34 -0
  62. data/docs/models/KubernetesAutoScaling.md +20 -0
  63. data/docs/models/KubernetesCluster.md +28 -0
  64. data/docs/models/KubernetesClusterEntities.md +18 -0
  65. data/docs/models/KubernetesClusterForPost.md +28 -0
  66. data/docs/models/KubernetesClusterForPut.md +28 -0
  67. data/docs/models/KubernetesClusterProperties.md +30 -0
  68. data/docs/models/KubernetesClusterPropertiesForPost.md +26 -0
  69. data/docs/models/KubernetesClusterPropertiesForPut.md +26 -0
  70. data/docs/models/KubernetesClusters.md +24 -0
  71. data/docs/models/KubernetesConfig.md +24 -0
  72. data/docs/models/KubernetesConfigProperties.md +18 -0
  73. data/docs/models/KubernetesMaintenanceWindow.md +20 -0
  74. data/docs/models/KubernetesNode.md +26 -0
  75. data/docs/models/KubernetesNodeMetadata.md +26 -0
  76. data/docs/models/KubernetesNodePool.md +26 -0
  77. data/docs/models/KubernetesNodePoolForPost.md +26 -0
  78. data/docs/models/KubernetesNodePoolForPut.md +26 -0
  79. data/docs/models/KubernetesNodePoolLan.md +18 -0
  80. data/docs/models/KubernetesNodePoolProperties.md +49 -0
  81. data/docs/models/KubernetesNodePoolPropertiesForPost.md +47 -0
  82. data/docs/models/KubernetesNodePoolPropertiesForPut.md +34 -0
  83. data/docs/models/KubernetesNodePools.md +24 -0
  84. data/docs/models/KubernetesNodeProperties.md +24 -0
  85. data/docs/models/KubernetesNodes.md +24 -0
  86. data/docs/models/Label.md +26 -0
  87. data/docs/models/LabelProperties.md +26 -0
  88. data/docs/models/LabelResource.md +26 -0
  89. data/docs/models/LabelResourceProperties.md +20 -0
  90. data/docs/models/LabelResources.md +30 -0
  91. data/docs/models/Labels.md +24 -0
  92. data/docs/models/Lan.md +28 -0
  93. data/docs/models/LanEntities.md +18 -0
  94. data/docs/models/LanNics.md +30 -0
  95. data/docs/models/LanPost.md +28 -0
  96. data/docs/models/LanProperties.md +24 -0
  97. data/docs/models/LanPropertiesPost.md +24 -0
  98. data/docs/models/Lans.md +30 -0
  99. data/docs/models/Loadbalancer.md +28 -0
  100. data/docs/models/LoadbalancerEntities.md +18 -0
  101. data/docs/models/LoadbalancerProperties.md +22 -0
  102. data/docs/models/Loadbalancers.md +30 -0
  103. data/docs/models/Location.md +26 -0
  104. data/docs/models/LocationProperties.md +22 -0
  105. data/docs/models/Locations.md +24 -0
  106. data/docs/models/Nic.md +28 -0
  107. data/docs/models/NicEntities.md +18 -0
  108. data/docs/models/NicProperties.md +30 -0
  109. data/docs/models/Nics.md +30 -0
  110. data/docs/models/NoStateMetaData.md +30 -0
  111. data/docs/models/PaginationLinks.md +22 -0
  112. data/docs/models/Peer.md +26 -0
  113. data/docs/models/PrivateCrossConnect.md +26 -0
  114. data/docs/models/PrivateCrossConnectProperties.md +24 -0
  115. data/docs/models/PrivateCrossConnects.md +24 -0
  116. data/docs/models/Request.md +26 -0
  117. data/docs/models/RequestMetadata.md +24 -0
  118. data/docs/models/RequestProperties.md +24 -0
  119. data/docs/models/RequestStatus.md +24 -0
  120. data/docs/models/RequestStatusMetadata.md +24 -0
  121. data/docs/models/RequestTarget.md +20 -0
  122. data/docs/models/Requests.md +30 -0
  123. data/docs/models/Resource.md +28 -0
  124. data/docs/models/ResourceEntities.md +18 -0
  125. data/docs/models/ResourceGroups.md +24 -0
  126. data/docs/models/ResourceLimits.md +50 -0
  127. data/docs/models/ResourceProperties.md +20 -0
  128. data/docs/models/ResourceReference.md +22 -0
  129. data/docs/models/Resources.md +24 -0
  130. data/docs/models/ResourcesUsers.md +24 -0
  131. data/docs/models/S3Bucket.md +18 -0
  132. data/docs/models/S3Key.md +26 -0
  133. data/docs/models/S3KeyMetadata.md +20 -0
  134. data/docs/models/S3KeyProperties.md +20 -0
  135. data/docs/models/S3Keys.md +24 -0
  136. data/docs/models/S3ObjectStorageSSO.md +18 -0
  137. data/docs/models/Server.md +28 -0
  138. data/docs/models/ServerEntities.md +22 -0
  139. data/docs/models/ServerProperties.md +32 -0
  140. data/docs/models/Servers.md +30 -0
  141. data/docs/models/Snapshot.md +26 -0
  142. data/docs/models/SnapshotProperties.md +48 -0
  143. data/docs/models/Snapshots.md +24 -0
  144. data/docs/models/Type.md +15 -0
  145. data/docs/models/User.md +28 -0
  146. data/docs/models/UserMetadata.md +22 -0
  147. data/docs/models/UserPost.md +18 -0
  148. data/docs/models/UserProperties.md +32 -0
  149. data/docs/models/UserPropertiesPost.md +32 -0
  150. data/docs/models/UserPropertiesPut.md +30 -0
  151. data/docs/models/UserPut.md +20 -0
  152. data/docs/models/Users.md +30 -0
  153. data/docs/models/UsersEntities.md +20 -0
  154. data/docs/models/Volume.md +26 -0
  155. data/docs/models/VolumeProperties.md +54 -0
  156. data/docs/models/Volumes.md +30 -0
  157. data/docs/summary.md +168 -0
  158. data/gitbook.yaml +4 -0
  159. data/ionoscloud.gemspec +1 -1
  160. data/lib/ionoscloud/api/_api.rb +2 -2
  161. data/lib/ionoscloud/api/backup_unit_api.rb +1 -1
  162. data/lib/ionoscloud/api/contract_api.rb +1 -1
  163. data/lib/ionoscloud/api/data_center_api.rb +3 -3
  164. data/lib/ionoscloud/api/image_api.rb +1 -1
  165. data/lib/ionoscloud/api/ip_blocks_api.rb +19 -1
  166. data/lib/ionoscloud/api/kubernetes_api.rb +12 -12
  167. data/lib/ionoscloud/api/label_api.rb +1 -1
  168. data/lib/ionoscloud/api/lan_api.rb +1 -1
  169. data/lib/ionoscloud/api/load_balancer_api.rb +1 -1
  170. data/lib/ionoscloud/api/location_api.rb +1 -1
  171. data/lib/ionoscloud/api/nic_api.rb +1 -1
  172. data/lib/ionoscloud/api/private_cross_connect_api.rb +1 -1
  173. data/lib/ionoscloud/api/request_api.rb +31 -7
  174. data/lib/ionoscloud/api/server_api.rb +1 -1
  175. data/lib/ionoscloud/api/snapshot_api.rb +1 -1
  176. data/lib/ionoscloud/api/user_management_api.rb +27 -9
  177. data/lib/ionoscloud/api/volume_api.rb +1 -1
  178. data/lib/ionoscloud/api_client.rb +18 -21
  179. data/lib/ionoscloud/api_error.rb +1 -1
  180. data/lib/ionoscloud/configuration.rb +3 -3
  181. data/lib/ionoscloud/models/attached_volumes.rb +68 -12
  182. data/lib/ionoscloud/models/backup_unit.rb +48 -6
  183. data/lib/ionoscloud/models/backup_unit_properties.rb +30 -4
  184. data/lib/ionoscloud/models/backup_unit_sso.rb +12 -2
  185. data/lib/ionoscloud/models/backup_units.rb +43 -11
  186. data/lib/ionoscloud/models/balanced_nics.rb +68 -12
  187. data/lib/ionoscloud/models/cdroms.rb +68 -12
  188. data/lib/ionoscloud/models/connectable_datacenter.rb +30 -4
  189. data/lib/ionoscloud/models/contract.rb +21 -3
  190. data/lib/ionoscloud/models/contract_properties.rb +48 -6
  191. data/lib/ionoscloud/models/data_center_entities.rb +39 -5
  192. data/lib/ionoscloud/models/datacenter.rb +57 -7
  193. data/lib/ionoscloud/models/datacenter_element_metadata.rb +77 -11
  194. data/lib/ionoscloud/models/datacenter_properties.rb +59 -33
  195. data/lib/ionoscloud/models/datacenters.rb +68 -12
  196. data/lib/ionoscloud/models/error.rb +23 -7
  197. data/lib/ionoscloud/models/error_message.rb +21 -3
  198. data/lib/ionoscloud/models/firewall_rule.rb +48 -6
  199. data/lib/ionoscloud/models/firewall_rules.rb +68 -12
  200. data/lib/ionoscloud/models/firewallrule_properties.rb +120 -31
  201. data/lib/ionoscloud/models/group.rb +48 -6
  202. data/lib/ionoscloud/models/group_entities.rb +21 -3
  203. data/lib/ionoscloud/models/group_members.rb +41 -9
  204. data/lib/ionoscloud/models/group_properties.rb +93 -11
  205. data/lib/ionoscloud/models/group_share.rb +39 -5
  206. data/lib/ionoscloud/models/group_share_properties.rb +21 -3
  207. data/lib/ionoscloud/models/group_shares.rb +41 -9
  208. data/lib/ionoscloud/models/group_users.rb +41 -9
  209. data/lib/ionoscloud/models/groups.rb +41 -9
  210. data/lib/ionoscloud/models/image.rb +48 -6
  211. data/lib/ionoscloud/models/image_properties.rb +209 -23
  212. data/lib/ionoscloud/models/images.rb +41 -9
  213. data/lib/ionoscloud/models/info.rb +30 -4
  214. data/lib/ionoscloud/models/ip_block.rb +48 -6
  215. data/lib/ionoscloud/models/ip_block_properties.rb +52 -14
  216. data/lib/ionoscloud/models/ip_blocks.rb +97 -12
  217. data/lib/ionoscloud/models/ip_consumer.rb +103 -11
  218. data/lib/ionoscloud/models/ip_failover.rb +21 -3
  219. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +21 -3
  220. data/lib/ionoscloud/models/kubernetes_cluster.rb +57 -7
  221. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +12 -2
  222. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +353 -0
  223. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +353 -0
  224. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +91 -17
  225. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +303 -0
  226. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +303 -0
  227. data/lib/ionoscloud/models/kubernetes_clusters.rb +41 -9
  228. data/lib/ionoscloud/models/kubernetes_config.rb +39 -5
  229. data/lib/ionoscloud/models/kubernetes_config_properties.rb +12 -2
  230. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +21 -3
  231. data/lib/ionoscloud/models/kubernetes_node.rb +50 -8
  232. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +50 -8
  233. data/lib/ionoscloud/models/kubernetes_node_pool.rb +48 -6
  234. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +336 -0
  235. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +48 -6
  236. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +17 -2
  237. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +170 -42
  238. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +159 -37
  239. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +80 -165
  240. data/lib/ionoscloud/models/kubernetes_node_pools.rb +41 -9
  241. data/lib/ionoscloud/models/kubernetes_node_properties.rb +48 -9
  242. data/lib/ionoscloud/models/kubernetes_nodes.rb +43 -11
  243. data/lib/ionoscloud/models/label.rb +48 -6
  244. data/lib/ionoscloud/models/label_properties.rb +48 -6
  245. data/lib/ionoscloud/models/label_resource.rb +48 -6
  246. data/lib/ionoscloud/models/label_resource_properties.rb +21 -3
  247. data/lib/ionoscloud/models/label_resources.rb +70 -14
  248. data/lib/ionoscloud/models/labels.rb +43 -11
  249. data/lib/ionoscloud/models/lan.rb +57 -7
  250. data/lib/ionoscloud/models/lan_entities.rb +12 -2
  251. data/lib/ionoscloud/models/lan_nics.rb +68 -12
  252. data/lib/ionoscloud/models/lan_post.rb +57 -7
  253. data/lib/ionoscloud/models/lan_properties.rb +41 -9
  254. data/lib/ionoscloud/models/lan_properties_post.rb +41 -9
  255. data/lib/ionoscloud/models/lans.rb +68 -12
  256. data/lib/ionoscloud/models/loadbalancer.rb +57 -7
  257. data/lib/ionoscloud/models/loadbalancer_entities.rb +12 -2
  258. data/lib/ionoscloud/models/loadbalancer_properties.rb +42 -33
  259. data/lib/ionoscloud/models/loadbalancers.rb +68 -12
  260. data/lib/ionoscloud/models/location.rb +48 -6
  261. data/lib/ionoscloud/models/location_properties.rb +34 -34
  262. data/lib/ionoscloud/models/locations.rb +41 -9
  263. data/lib/ionoscloud/models/nic.rb +57 -7
  264. data/lib/ionoscloud/models/nic_entities.rb +12 -2
  265. data/lib/ionoscloud/models/nic_properties.rb +68 -12
  266. data/lib/ionoscloud/models/nics.rb +68 -12
  267. data/lib/ionoscloud/models/no_state_meta_data.rb +66 -8
  268. data/lib/ionoscloud/models/pagination_links.rb +30 -4
  269. data/lib/ionoscloud/models/peer.rb +48 -6
  270. data/lib/ionoscloud/models/private_cross_connect.rb +48 -6
  271. data/lib/ionoscloud/models/private_cross_connect_properties.rb +43 -13
  272. data/lib/ionoscloud/models/private_cross_connects.rb +41 -9
  273. data/lib/ionoscloud/models/request.rb +48 -6
  274. data/lib/ionoscloud/models/request_metadata.rb +39 -5
  275. data/lib/ionoscloud/models/request_properties.rb +41 -9
  276. data/lib/ionoscloud/models/request_status.rb +39 -5
  277. data/lib/ionoscloud/models/request_status_metadata.rb +41 -9
  278. data/lib/ionoscloud/models/request_target.rb +21 -3
  279. data/lib/ionoscloud/models/requests.rb +69 -13
  280. data/lib/ionoscloud/models/resource.rb +57 -7
  281. data/lib/ionoscloud/models/resource_entities.rb +12 -2
  282. data/lib/ionoscloud/models/resource_groups.rb +41 -9
  283. data/lib/ionoscloud/models/resource_limits.rb +156 -18
  284. data/lib/ionoscloud/models/resource_properties.rb +21 -3
  285. data/lib/ionoscloud/models/resource_reference.rb +30 -4
  286. data/lib/ionoscloud/models/resources.rb +41 -9
  287. data/lib/ionoscloud/models/resources_users.rb +41 -9
  288. data/lib/ionoscloud/models/{kubernetes_cluster_properties_for_post_and_put.rb → s3_bucket.rb} +19 -28
  289. data/lib/ionoscloud/models/s3_key.rb +48 -6
  290. data/lib/ionoscloud/models/s3_key_metadata.rb +21 -3
  291. data/lib/ionoscloud/models/s3_key_properties.rb +23 -5
  292. data/lib/ionoscloud/models/s3_keys.rb +41 -9
  293. data/lib/ionoscloud/models/s3_object_storage_sso.rb +12 -2
  294. data/lib/ionoscloud/models/server.rb +57 -7
  295. data/lib/ionoscloud/models/server_entities.rb +30 -4
  296. data/lib/ionoscloud/models/server_properties.rb +77 -11
  297. data/lib/ionoscloud/models/servers.rb +68 -12
  298. data/lib/ionoscloud/models/snapshot.rb +48 -6
  299. data/lib/ionoscloud/models/snapshot_properties.rb +147 -17
  300. data/lib/ionoscloud/models/snapshots.rb +41 -9
  301. data/lib/ionoscloud/models/type.rb +2 -1
  302. data/lib/ionoscloud/models/user.rb +57 -7
  303. data/lib/ionoscloud/models/user_metadata.rb +30 -4
  304. data/lib/ionoscloud/models/user_post.rb +231 -0
  305. data/lib/ionoscloud/models/user_properties.rb +74 -18
  306. data/lib/ionoscloud/models/user_properties_post.rb +353 -0
  307. data/lib/ionoscloud/models/user_properties_put.rb +335 -0
  308. data/lib/ionoscloud/models/user_put.rb +249 -0
  309. data/lib/ionoscloud/models/users.rb +97 -12
  310. data/lib/ionoscloud/models/users_entities.rb +21 -3
  311. data/lib/ionoscloud/models/volume.rb +48 -6
  312. data/lib/ionoscloud/models/volume_properties.rb +193 -31
  313. data/lib/ionoscloud/models/volumes.rb +68 -12
  314. data/lib/ionoscloud/version.rb +2 -2
  315. data/lib/ionoscloud.rb +11 -2
  316. data/lib/test_driver.rb +104 -0
  317. data/spec/api_client_spec.rb +1 -1
  318. data/spec/configuration_spec.rb +1 -1
  319. data/spec/spec_helper.rb +1 -1
  320. metadata +172 -291
  321. data/DOCS.md +0 -14618
  322. data/spec/api/_api_spec.rb +0 -49
  323. data/spec/api/backup_unit_api_spec.rb +0 -140
  324. data/spec/api/contract_api_spec.rb +0 -49
  325. data/spec/api/data_center_api_spec.rb +0 -128
  326. data/spec/api/image_api_spec.rb +0 -111
  327. data/spec/api/ip_blocks_api_spec.rb +0 -126
  328. data/spec/api/kubernetes_api_spec.rb +0 -306
  329. data/spec/api/label_api_spec.rb +0 -480
  330. data/spec/api/lan_api_spec.rb +0 -186
  331. data/spec/api/load_balancer_api_spec.rb +0 -203
  332. data/spec/api/location_api_spec.rb +0 -80
  333. data/spec/api/nic_api_spec.rb +0 -251
  334. data/spec/api/private_cross_connect_api_spec.rb +0 -110
  335. data/spec/api/request_api_spec.rb +0 -84
  336. data/spec/api/server_api_spec.rb +0 -337
  337. data/spec/api/snapshot_api_spec.rb +0 -111
  338. data/spec/api/user_management_api_spec.rb +0 -495
  339. data/spec/api/volume_api_spec.rb +0 -171
  340. data/spec/models/attached_volumes_spec.rb +0 -70
  341. data/spec/models/backup_unit_properties_spec.rb +0 -46
  342. data/spec/models/backup_unit_spec.rb +0 -62
  343. data/spec/models/backup_unit_sso_spec.rb +0 -34
  344. data/spec/models/backup_units_spec.rb +0 -56
  345. data/spec/models/balanced_nics_spec.rb +0 -70
  346. data/spec/models/cdroms_spec.rb +0 -70
  347. data/spec/models/connectable_datacenter_spec.rb +0 -46
  348. data/spec/models/contract_properties_spec.rb +0 -58
  349. data/spec/models/contract_spec.rb +0 -40
  350. data/spec/models/data_center_entities_spec.rb +0 -52
  351. data/spec/models/datacenter_element_metadata_spec.rb +0 -80
  352. data/spec/models/datacenter_properties_spec.rb +0 -68
  353. data/spec/models/datacenter_spec.rb +0 -64
  354. data/spec/models/datacenters_spec.rb +0 -70
  355. data/spec/models/error_message_spec.rb +0 -40
  356. data/spec/models/error_spec.rb +0 -40
  357. data/spec/models/firewall_rule_spec.rb +0 -58
  358. data/spec/models/firewall_rules_spec.rb +0 -70
  359. data/spec/models/firewallrule_properties_spec.rb +0 -98
  360. data/spec/models/group_entities_spec.rb +0 -40
  361. data/spec/models/group_members_spec.rb +0 -52
  362. data/spec/models/group_properties_spec.rb +0 -88
  363. data/spec/models/group_share_properties_spec.rb +0 -40
  364. data/spec/models/group_share_spec.rb +0 -52
  365. data/spec/models/group_shares_spec.rb +0 -52
  366. data/spec/models/group_spec.rb +0 -58
  367. data/spec/models/group_users_spec.rb +0 -52
  368. data/spec/models/groups_spec.rb +0 -52
  369. data/spec/models/image_properties_spec.rb +0 -138
  370. data/spec/models/image_spec.rb +0 -58
  371. data/spec/models/images_spec.rb +0 -52
  372. data/spec/models/info_spec.rb +0 -46
  373. data/spec/models/ip_block_properties_spec.rb +0 -58
  374. data/spec/models/ip_block_spec.rb +0 -58
  375. data/spec/models/ip_blocks_spec.rb +0 -52
  376. data/spec/models/ip_consumer_spec.rb +0 -70
  377. data/spec/models/ip_failover_spec.rb +0 -40
  378. data/spec/models/kubernetes_auto_scaling_spec.rb +0 -40
  379. data/spec/models/kubernetes_cluster_entities_spec.rb +0 -34
  380. data/spec/models/kubernetes_cluster_properties_for_post_and_put_spec.rb +0 -46
  381. data/spec/models/kubernetes_cluster_properties_spec.rb +0 -58
  382. data/spec/models/kubernetes_cluster_spec.rb +0 -68
  383. data/spec/models/kubernetes_clusters_spec.rb +0 -56
  384. data/spec/models/kubernetes_config_properties_spec.rb +0 -34
  385. data/spec/models/kubernetes_config_spec.rb +0 -56
  386. data/spec/models/kubernetes_maintenance_window_spec.rb +0 -44
  387. data/spec/models/kubernetes_node_metadata_spec.rb +0 -62
  388. data/spec/models/kubernetes_node_pool_for_put_spec.rb +0 -62
  389. data/spec/models/kubernetes_node_pool_lan_spec.rb +0 -34
  390. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +0 -132
  391. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +0 -132
  392. data/spec/models/kubernetes_node_pool_properties_spec.rb +0 -138
  393. data/spec/models/kubernetes_node_pool_spec.rb +0 -62
  394. data/spec/models/kubernetes_node_pools_spec.rb +0 -56
  395. data/spec/models/kubernetes_node_properties_spec.rb +0 -46
  396. data/spec/models/kubernetes_node_spec.rb +0 -62
  397. data/spec/models/kubernetes_nodes_spec.rb +0 -56
  398. data/spec/models/label_properties_spec.rb +0 -58
  399. data/spec/models/label_resource_properties_spec.rb +0 -40
  400. data/spec/models/label_resource_spec.rb +0 -62
  401. data/spec/models/label_resources_spec.rb +0 -74
  402. data/spec/models/label_spec.rb +0 -62
  403. data/spec/models/labels_spec.rb +0 -56
  404. data/spec/models/lan_entities_spec.rb +0 -34
  405. data/spec/models/lan_nics_spec.rb +0 -70
  406. data/spec/models/lan_post_spec.rb +0 -64
  407. data/spec/models/lan_properties_post_spec.rb +0 -52
  408. data/spec/models/lan_properties_spec.rb +0 -52
  409. data/spec/models/lan_spec.rb +0 -64
  410. data/spec/models/lans_spec.rb +0 -70
  411. data/spec/models/loadbalancer_entities_spec.rb +0 -34
  412. data/spec/models/loadbalancer_properties_spec.rb +0 -50
  413. data/spec/models/loadbalancer_spec.rb +0 -64
  414. data/spec/models/loadbalancers_spec.rb +0 -70
  415. data/spec/models/location_properties_spec.rb +0 -50
  416. data/spec/models/location_spec.rb +0 -58
  417. data/spec/models/locations_spec.rb +0 -52
  418. data/spec/models/nic_entities_spec.rb +0 -34
  419. data/spec/models/nic_properties_spec.rb +0 -70
  420. data/spec/models/nic_spec.rb +0 -64
  421. data/spec/models/nics_spec.rb +0 -70
  422. data/spec/models/no_state_meta_data_spec.rb +0 -70
  423. data/spec/models/pagination_links_spec.rb +0 -46
  424. data/spec/models/peer_spec.rb +0 -58
  425. data/spec/models/private_cross_connect_properties_spec.rb +0 -52
  426. data/spec/models/private_cross_connect_spec.rb +0 -58
  427. data/spec/models/private_cross_connects_spec.rb +0 -52
  428. data/spec/models/request_metadata_spec.rb +0 -52
  429. data/spec/models/request_properties_spec.rb +0 -52
  430. data/spec/models/request_spec.rb +0 -58
  431. data/spec/models/request_status_metadata_spec.rb +0 -56
  432. data/spec/models/request_status_spec.rb +0 -52
  433. data/spec/models/request_target_spec.rb +0 -44
  434. data/spec/models/requests_spec.rb +0 -70
  435. data/spec/models/resource_entities_spec.rb +0 -34
  436. data/spec/models/resource_groups_spec.rb +0 -52
  437. data/spec/models/resource_limits_spec.rb +0 -130
  438. data/spec/models/resource_properties_spec.rb +0 -40
  439. data/spec/models/resource_reference_spec.rb +0 -46
  440. data/spec/models/resource_spec.rb +0 -64
  441. data/spec/models/resources_spec.rb +0 -52
  442. data/spec/models/resources_users_spec.rb +0 -52
  443. data/spec/models/s3_key_metadata_spec.rb +0 -40
  444. data/spec/models/s3_key_properties_spec.rb +0 -40
  445. data/spec/models/s3_key_spec.rb +0 -58
  446. data/spec/models/s3_keys_spec.rb +0 -52
  447. data/spec/models/s3_object_storage_sso_spec.rb +0 -34
  448. data/spec/models/server_entities_spec.rb +0 -46
  449. data/spec/models/server_properties_spec.rb +0 -84
  450. data/spec/models/server_spec.rb +0 -64
  451. data/spec/models/servers_spec.rb +0 -70
  452. data/spec/models/snapshot_properties_spec.rb +0 -128
  453. data/spec/models/snapshot_spec.rb +0 -58
  454. data/spec/models/snapshots_spec.rb +0 -52
  455. data/spec/models/type_spec.rb +0 -28
  456. data/spec/models/user_metadata_spec.rb +0 -46
  457. data/spec/models/user_properties_spec.rb +0 -82
  458. data/spec/models/user_spec.rb +0 -64
  459. data/spec/models/users_entities_spec.rb +0 -40
  460. data/spec/models/users_spec.rb +0 -52
  461. data/spec/models/volume_properties_spec.rb +0 -152
  462. data/spec/models/volume_spec.rb +0 -58
  463. data/spec/models/volumes_spec.rb +0 -70
@@ -0,0 +1,2551 @@
1
+ # UserManagementApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v5*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**um_groups_delete**](UserManagementApi.md#um_groups_delete) | **DELETE** /um/groups/{groupId} | Delete a Group |
8
+ | [**um_groups_find_by_id**](UserManagementApi.md#um_groups_find_by_id) | **GET** /um/groups/{groupId} | Retrieve a Group |
9
+ | [**um_groups_get**](UserManagementApi.md#um_groups_get) | **GET** /um/groups | List All Groups. |
10
+ | [**um_groups_post**](UserManagementApi.md#um_groups_post) | **POST** /um/groups | Create a Group |
11
+ | [**um_groups_put**](UserManagementApi.md#um_groups_put) | **PUT** /um/groups/{groupId} | Modify a group |
12
+ | [**um_groups_resources_get**](UserManagementApi.md#um_groups_resources_get) | **GET** /um/groups/{groupId}/resources | Retrieve resources assigned to a group |
13
+ | [**um_groups_shares_delete**](UserManagementApi.md#um_groups_shares_delete) | **DELETE** /um/groups/{groupId}/shares/{resourceId} | Remove a resource from a group |
14
+ | [**um_groups_shares_find_by_resource_id**](UserManagementApi.md#um_groups_shares_find_by_resource_id) | **GET** /um/groups/{groupId}/shares/{resourceId} | Retrieve a group share |
15
+ | [**um_groups_shares_get**](UserManagementApi.md#um_groups_shares_get) | **GET** /um/groups/{groupId}/shares | List Group Shares |
16
+ | [**um_groups_shares_post**](UserManagementApi.md#um_groups_shares_post) | **POST** /um/groups/{groupId}/shares/{resourceId} | Add a resource to a group |
17
+ | [**um_groups_shares_put**](UserManagementApi.md#um_groups_shares_put) | **PUT** /um/groups/{groupId}/shares/{resourceId} | Modify resource permissions of a group |
18
+ | [**um_groups_users_delete**](UserManagementApi.md#um_groups_users_delete) | **DELETE** /um/groups/{groupId}/users/{userId} | Remove a user from a group |
19
+ | [**um_groups_users_get**](UserManagementApi.md#um_groups_users_get) | **GET** /um/groups/{groupId}/users | List Group Members |
20
+ | [**um_groups_users_post**](UserManagementApi.md#um_groups_users_post) | **POST** /um/groups/{groupId}/users | Add a user to a group |
21
+ | [**um_resources_find_by_type**](UserManagementApi.md#um_resources_find_by_type) | **GET** /um/resources/{resourceType} | Retrieve a list of Resources by type. |
22
+ | [**um_resources_find_by_type_and_id**](UserManagementApi.md#um_resources_find_by_type_and_id) | **GET** /um/resources/{resourceType}/{resourceId} | Retrieve a Resource by type. |
23
+ | [**um_resources_get**](UserManagementApi.md#um_resources_get) | **GET** /um/resources | List All Resources. |
24
+ | [**um_users_delete**](UserManagementApi.md#um_users_delete) | **DELETE** /um/users/{userId} | Delete a User |
25
+ | [**um_users_find_by_id**](UserManagementApi.md#um_users_find_by_id) | **GET** /um/users/{userId} | Retrieve a User |
26
+ | [**um_users_get**](UserManagementApi.md#um_users_get) | **GET** /um/users | List all Users |
27
+ | [**um_users_groups_get**](UserManagementApi.md#um_users_groups_get) | **GET** /um/users/{userId}/groups | Retrieve a User's group resources |
28
+ | [**um_users_owns_get**](UserManagementApi.md#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve a User's own resources |
29
+ | [**um_users_post**](UserManagementApi.md#um_users_post) | **POST** /um/users | Create a user |
30
+ | [**um_users_put**](UserManagementApi.md#um_users_put) | **PUT** /um/users/{userId} | Modify a user |
31
+ | [**um_users_s3keys_delete**](UserManagementApi.md#um_users_s3keys_delete) | **DELETE** /um/users/{userId}/s3keys/{keyId} | Delete a S3 key |
32
+ | [**um_users_s3keys_find_by_key_id**](UserManagementApi.md#um_users_s3keys_find_by_key_id) | **GET** /um/users/{userId}/s3keys/{keyId} | Retrieve given S3 key belonging to the given User |
33
+ | [**um_users_s3keys_get**](UserManagementApi.md#um_users_s3keys_get) | **GET** /um/users/{userId}/s3keys | Retrieve a User's S3 keys |
34
+ | [**um_users_s3keys_post**](UserManagementApi.md#um_users_s3keys_post) | **POST** /um/users/{userId}/s3keys | Create a S3 key for the given user |
35
+ | [**um_users_s3keys_put**](UserManagementApi.md#um_users_s3keys_put) | **PUT** /um/users/{userId}/s3keys/{keyId} | Modify a S3 key having the given key id |
36
+ | [**um_users_s3ssourl_get**](UserManagementApi.md#um_users_s3ssourl_get) | **GET** /um/users/{userId}/s3ssourl | Retrieve S3 object storage single signon URL for the given user |
37
+
38
+
39
+ ## um_groups_delete
40
+
41
+ > Object um_groups_delete(group_id, opts)
42
+
43
+ Delete a Group
44
+
45
+ Delete a group
46
+
47
+ ### Examples
48
+
49
+ ```ruby
50
+ require 'time'
51
+ require 'ionoscloud'
52
+ # setup authorization
53
+ Ionoscloud.configure do |config|
54
+ # Configure HTTP basic authorization: Basic Authentication
55
+ config.username = 'YOUR USERNAME'
56
+ config.password = 'YOUR PASSWORD'
57
+
58
+ # Configure API key authorization: Token Authentication
59
+ config.api_key['Authorization'] = 'YOUR API KEY'
60
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
61
+ # config.api_key_prefix['Authorization'] = 'Bearer'
62
+ end
63
+
64
+ api_instance = Ionoscloud::UserManagementApi.new
65
+ group_id = 'group_id_example' # String | The unique ID of the group
66
+ opts = {
67
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
68
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
69
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
70
+ }
71
+
72
+ begin
73
+ # Delete a Group
74
+ result = api_instance.um_groups_delete(group_id, opts)
75
+ p result
76
+ rescue Ionoscloud::ApiError => e
77
+ puts "Error when calling UserManagementApi->um_groups_delete: #{e}"
78
+ end
79
+ ```
80
+
81
+ #### Using the um_groups_delete_with_http_info variant
82
+
83
+ This returns an Array which contains the response data, status code and headers.
84
+
85
+ > <Array(Object, Integer, Hash)> um_groups_delete_with_http_info(group_id, opts)
86
+
87
+ ```ruby
88
+ begin
89
+ # Delete a Group
90
+ data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts)
91
+ p status_code # => 2xx
92
+ p headers # => { ... }
93
+ p data # => Object
94
+ rescue Ionoscloud::ApiError => e
95
+ puts "Error when calling UserManagementApi->um_groups_delete_with_http_info: #{e}"
96
+ end
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ | Name | Type | Description | Notes |
102
+ | ---- | ---- | ----------- | ----- |
103
+ | **group_id** | **String** | The unique ID of the group | |
104
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
105
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
106
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
107
+
108
+ ### Return type
109
+
110
+ **Object**
111
+
112
+ ### Authorization
113
+
114
+ Basic Authentication, Token Authentication
115
+
116
+ ### HTTP request headers
117
+
118
+ - **Content-Type**: Not defined
119
+ - **Accept**: application/json
120
+
121
+
122
+ ## um_groups_find_by_id
123
+
124
+ > <Group> um_groups_find_by_id(group_id, opts)
125
+
126
+ Retrieve a Group
127
+
128
+ You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
129
+
130
+ ### Examples
131
+
132
+ ```ruby
133
+ require 'time'
134
+ require 'ionoscloud'
135
+ # setup authorization
136
+ Ionoscloud.configure do |config|
137
+ # Configure HTTP basic authorization: Basic Authentication
138
+ config.username = 'YOUR USERNAME'
139
+ config.password = 'YOUR PASSWORD'
140
+
141
+ # Configure API key authorization: Token Authentication
142
+ config.api_key['Authorization'] = 'YOUR API KEY'
143
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
144
+ # config.api_key_prefix['Authorization'] = 'Bearer'
145
+ end
146
+
147
+ api_instance = Ionoscloud::UserManagementApi.new
148
+ group_id = 'group_id_example' # String | The unique ID of the group
149
+ opts = {
150
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
151
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
152
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
153
+ }
154
+
155
+ begin
156
+ # Retrieve a Group
157
+ result = api_instance.um_groups_find_by_id(group_id, opts)
158
+ p result
159
+ rescue Ionoscloud::ApiError => e
160
+ puts "Error when calling UserManagementApi->um_groups_find_by_id: #{e}"
161
+ end
162
+ ```
163
+
164
+ #### Using the um_groups_find_by_id_with_http_info variant
165
+
166
+ This returns an Array which contains the response data, status code and headers.
167
+
168
+ > <Array(<Group>, Integer, Hash)> um_groups_find_by_id_with_http_info(group_id, opts)
169
+
170
+ ```ruby
171
+ begin
172
+ # Retrieve a Group
173
+ data, status_code, headers = api_instance.um_groups_find_by_id_with_http_info(group_id, opts)
174
+ p status_code # => 2xx
175
+ p headers # => { ... }
176
+ p data # => <Group>
177
+ rescue Ionoscloud::ApiError => e
178
+ puts "Error when calling UserManagementApi->um_groups_find_by_id_with_http_info: #{e}"
179
+ end
180
+ ```
181
+
182
+ ### Parameters
183
+
184
+ | Name | Type | Description | Notes |
185
+ | ---- | ---- | ----------- | ----- |
186
+ | **group_id** | **String** | The unique ID of the group | |
187
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
188
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
189
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
190
+
191
+ ### Return type
192
+
193
+ [**Group**](Group.md)
194
+
195
+ ### Authorization
196
+
197
+ Basic Authentication, Token Authentication
198
+
199
+ ### HTTP request headers
200
+
201
+ - **Content-Type**: Not defined
202
+ - **Accept**: application/json
203
+
204
+
205
+ ## um_groups_get
206
+
207
+ > <Groups> um_groups_get(opts)
208
+
209
+ List All Groups.
210
+
211
+ You can retrieve a complete list of all groups that you have access to
212
+
213
+ ### Examples
214
+
215
+ ```ruby
216
+ require 'time'
217
+ require 'ionoscloud'
218
+ # setup authorization
219
+ Ionoscloud.configure do |config|
220
+ # Configure HTTP basic authorization: Basic Authentication
221
+ config.username = 'YOUR USERNAME'
222
+ config.password = 'YOUR PASSWORD'
223
+
224
+ # Configure API key authorization: Token Authentication
225
+ config.api_key['Authorization'] = 'YOUR API KEY'
226
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
227
+ # config.api_key_prefix['Authorization'] = 'Bearer'
228
+ end
229
+
230
+ api_instance = Ionoscloud::UserManagementApi.new
231
+ opts = {
232
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
233
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
234
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
235
+ }
236
+
237
+ begin
238
+ # List All Groups.
239
+ result = api_instance.um_groups_get(opts)
240
+ p result
241
+ rescue Ionoscloud::ApiError => e
242
+ puts "Error when calling UserManagementApi->um_groups_get: #{e}"
243
+ end
244
+ ```
245
+
246
+ #### Using the um_groups_get_with_http_info variant
247
+
248
+ This returns an Array which contains the response data, status code and headers.
249
+
250
+ > <Array(<Groups>, Integer, Hash)> um_groups_get_with_http_info(opts)
251
+
252
+ ```ruby
253
+ begin
254
+ # List All Groups.
255
+ data, status_code, headers = api_instance.um_groups_get_with_http_info(opts)
256
+ p status_code # => 2xx
257
+ p headers # => { ... }
258
+ p data # => <Groups>
259
+ rescue Ionoscloud::ApiError => e
260
+ puts "Error when calling UserManagementApi->um_groups_get_with_http_info: #{e}"
261
+ end
262
+ ```
263
+
264
+ ### Parameters
265
+
266
+ | Name | Type | Description | Notes |
267
+ | ---- | ---- | ----------- | ----- |
268
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
269
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
270
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
271
+
272
+ ### Return type
273
+
274
+ [**Groups**](Groups.md)
275
+
276
+ ### Authorization
277
+
278
+ Basic Authentication, Token Authentication
279
+
280
+ ### HTTP request headers
281
+
282
+ - **Content-Type**: Not defined
283
+ - **Accept**: application/json
284
+
285
+
286
+ ## um_groups_post
287
+
288
+ > <Group> um_groups_post(group, opts)
289
+
290
+ Create a Group
291
+
292
+ You can use this POST method to create a group
293
+
294
+ ### Examples
295
+
296
+ ```ruby
297
+ require 'time'
298
+ require 'ionoscloud'
299
+ # setup authorization
300
+ Ionoscloud.configure do |config|
301
+ # Configure HTTP basic authorization: Basic Authentication
302
+ config.username = 'YOUR USERNAME'
303
+ config.password = 'YOUR PASSWORD'
304
+
305
+ # Configure API key authorization: Token Authentication
306
+ config.api_key['Authorization'] = 'YOUR API KEY'
307
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
308
+ # config.api_key_prefix['Authorization'] = 'Bearer'
309
+ end
310
+
311
+ api_instance = Ionoscloud::UserManagementApi.new
312
+ group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | Group to be created
313
+ opts = {
314
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
315
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
316
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
317
+ }
318
+
319
+ begin
320
+ # Create a Group
321
+ result = api_instance.um_groups_post(group, opts)
322
+ p result
323
+ rescue Ionoscloud::ApiError => e
324
+ puts "Error when calling UserManagementApi->um_groups_post: #{e}"
325
+ end
326
+ ```
327
+
328
+ #### Using the um_groups_post_with_http_info variant
329
+
330
+ This returns an Array which contains the response data, status code and headers.
331
+
332
+ > <Array(<Group>, Integer, Hash)> um_groups_post_with_http_info(group, opts)
333
+
334
+ ```ruby
335
+ begin
336
+ # Create a Group
337
+ data, status_code, headers = api_instance.um_groups_post_with_http_info(group, opts)
338
+ p status_code # => 2xx
339
+ p headers # => { ... }
340
+ p data # => <Group>
341
+ rescue Ionoscloud::ApiError => e
342
+ puts "Error when calling UserManagementApi->um_groups_post_with_http_info: #{e}"
343
+ end
344
+ ```
345
+
346
+ ### Parameters
347
+
348
+ | Name | Type | Description | Notes |
349
+ | ---- | ---- | ----------- | ----- |
350
+ | **group** | [**Group**](Group.md) | Group to be created | |
351
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
352
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
353
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
354
+
355
+ ### Return type
356
+
357
+ [**Group**](Group.md)
358
+
359
+ ### Authorization
360
+
361
+ Basic Authentication, Token Authentication
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: application/json
366
+ - **Accept**: application/json
367
+
368
+
369
+ ## um_groups_put
370
+
371
+ > <Group> um_groups_put(group_id, group, opts)
372
+
373
+ Modify a group
374
+
375
+ You can use this method to update properties of the group.
376
+
377
+ ### Examples
378
+
379
+ ```ruby
380
+ require 'time'
381
+ require 'ionoscloud'
382
+ # setup authorization
383
+ Ionoscloud.configure do |config|
384
+ # Configure HTTP basic authorization: Basic Authentication
385
+ config.username = 'YOUR USERNAME'
386
+ config.password = 'YOUR PASSWORD'
387
+
388
+ # Configure API key authorization: Token Authentication
389
+ config.api_key['Authorization'] = 'YOUR API KEY'
390
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
391
+ # config.api_key_prefix['Authorization'] = 'Bearer'
392
+ end
393
+
394
+ api_instance = Ionoscloud::UserManagementApi.new
395
+ group_id = 'group_id_example' # String | The unique ID of the group
396
+ group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | Modified properties of the Group
397
+ opts = {
398
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
399
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
400
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
401
+ }
402
+
403
+ begin
404
+ # Modify a group
405
+ result = api_instance.um_groups_put(group_id, group, opts)
406
+ p result
407
+ rescue Ionoscloud::ApiError => e
408
+ puts "Error when calling UserManagementApi->um_groups_put: #{e}"
409
+ end
410
+ ```
411
+
412
+ #### Using the um_groups_put_with_http_info variant
413
+
414
+ This returns an Array which contains the response data, status code and headers.
415
+
416
+ > <Array(<Group>, Integer, Hash)> um_groups_put_with_http_info(group_id, group, opts)
417
+
418
+ ```ruby
419
+ begin
420
+ # Modify a group
421
+ data, status_code, headers = api_instance.um_groups_put_with_http_info(group_id, group, opts)
422
+ p status_code # => 2xx
423
+ p headers # => { ... }
424
+ p data # => <Group>
425
+ rescue Ionoscloud::ApiError => e
426
+ puts "Error when calling UserManagementApi->um_groups_put_with_http_info: #{e}"
427
+ end
428
+ ```
429
+
430
+ ### Parameters
431
+
432
+ | Name | Type | Description | Notes |
433
+ | ---- | ---- | ----------- | ----- |
434
+ | **group_id** | **String** | The unique ID of the group | |
435
+ | **group** | [**Group**](Group.md) | Modified properties of the Group | |
436
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
437
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
438
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
439
+
440
+ ### Return type
441
+
442
+ [**Group**](Group.md)
443
+
444
+ ### Authorization
445
+
446
+ Basic Authentication, Token Authentication
447
+
448
+ ### HTTP request headers
449
+
450
+ - **Content-Type**: application/json
451
+ - **Accept**: application/json
452
+
453
+
454
+ ## um_groups_resources_get
455
+
456
+ > <ResourceGroups> um_groups_resources_get(group_id, opts)
457
+
458
+ Retrieve resources assigned to a group
459
+
460
+ ### Examples
461
+
462
+ ```ruby
463
+ require 'time'
464
+ require 'ionoscloud'
465
+ # setup authorization
466
+ Ionoscloud.configure do |config|
467
+ # Configure HTTP basic authorization: Basic Authentication
468
+ config.username = 'YOUR USERNAME'
469
+ config.password = 'YOUR PASSWORD'
470
+
471
+ # Configure API key authorization: Token Authentication
472
+ config.api_key['Authorization'] = 'YOUR API KEY'
473
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
474
+ # config.api_key_prefix['Authorization'] = 'Bearer'
475
+ end
476
+
477
+ api_instance = Ionoscloud::UserManagementApi.new
478
+ group_id = 'group_id_example' # String | The unique ID of the group
479
+ opts = {
480
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
481
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
482
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
483
+ }
484
+
485
+ begin
486
+ # Retrieve resources assigned to a group
487
+ result = api_instance.um_groups_resources_get(group_id, opts)
488
+ p result
489
+ rescue Ionoscloud::ApiError => e
490
+ puts "Error when calling UserManagementApi->um_groups_resources_get: #{e}"
491
+ end
492
+ ```
493
+
494
+ #### Using the um_groups_resources_get_with_http_info variant
495
+
496
+ This returns an Array which contains the response data, status code and headers.
497
+
498
+ > <Array(<ResourceGroups>, Integer, Hash)> um_groups_resources_get_with_http_info(group_id, opts)
499
+
500
+ ```ruby
501
+ begin
502
+ # Retrieve resources assigned to a group
503
+ data, status_code, headers = api_instance.um_groups_resources_get_with_http_info(group_id, opts)
504
+ p status_code # => 2xx
505
+ p headers # => { ... }
506
+ p data # => <ResourceGroups>
507
+ rescue Ionoscloud::ApiError => e
508
+ puts "Error when calling UserManagementApi->um_groups_resources_get_with_http_info: #{e}"
509
+ end
510
+ ```
511
+
512
+ ### Parameters
513
+
514
+ | Name | Type | Description | Notes |
515
+ | ---- | ---- | ----------- | ----- |
516
+ | **group_id** | **String** | The unique ID of the group | |
517
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
518
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
519
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
520
+
521
+ ### Return type
522
+
523
+ [**ResourceGroups**](ResourceGroups.md)
524
+
525
+ ### Authorization
526
+
527
+ Basic Authentication, Token Authentication
528
+
529
+ ### HTTP request headers
530
+
531
+ - **Content-Type**: Not defined
532
+ - **Accept**: application/json
533
+
534
+
535
+ ## um_groups_shares_delete
536
+
537
+ > Object um_groups_shares_delete(group_id, resource_id, opts)
538
+
539
+ Remove a resource from a group
540
+
541
+ This will remove a resource from a group
542
+
543
+ ### Examples
544
+
545
+ ```ruby
546
+ require 'time'
547
+ require 'ionoscloud'
548
+ # setup authorization
549
+ Ionoscloud.configure do |config|
550
+ # Configure HTTP basic authorization: Basic Authentication
551
+ config.username = 'YOUR USERNAME'
552
+ config.password = 'YOUR PASSWORD'
553
+
554
+ # Configure API key authorization: Token Authentication
555
+ config.api_key['Authorization'] = 'YOUR API KEY'
556
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
557
+ # config.api_key_prefix['Authorization'] = 'Bearer'
558
+ end
559
+
560
+ api_instance = Ionoscloud::UserManagementApi.new
561
+ group_id = 'group_id_example' # String |
562
+ resource_id = 'resource_id_example' # String |
563
+ opts = {
564
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
565
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
566
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
567
+ }
568
+
569
+ begin
570
+ # Remove a resource from a group
571
+ result = api_instance.um_groups_shares_delete(group_id, resource_id, opts)
572
+ p result
573
+ rescue Ionoscloud::ApiError => e
574
+ puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}"
575
+ end
576
+ ```
577
+
578
+ #### Using the um_groups_shares_delete_with_http_info variant
579
+
580
+ This returns an Array which contains the response data, status code and headers.
581
+
582
+ > <Array(Object, Integer, Hash)> um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
583
+
584
+ ```ruby
585
+ begin
586
+ # Remove a resource from a group
587
+ data, status_code, headers = api_instance.um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
588
+ p status_code # => 2xx
589
+ p headers # => { ... }
590
+ p data # => Object
591
+ rescue Ionoscloud::ApiError => e
592
+ puts "Error when calling UserManagementApi->um_groups_shares_delete_with_http_info: #{e}"
593
+ end
594
+ ```
595
+
596
+ ### Parameters
597
+
598
+ | Name | Type | Description | Notes |
599
+ | ---- | ---- | ----------- | ----- |
600
+ | **group_id** | **String** | | |
601
+ | **resource_id** | **String** | | |
602
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
603
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
604
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
605
+
606
+ ### Return type
607
+
608
+ **Object**
609
+
610
+ ### Authorization
611
+
612
+ Basic Authentication, Token Authentication
613
+
614
+ ### HTTP request headers
615
+
616
+ - **Content-Type**: Not defined
617
+ - **Accept**: application/json
618
+
619
+
620
+ ## um_groups_shares_find_by_resource_id
621
+
622
+ > <GroupShare> um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
623
+
624
+ Retrieve a group share
625
+
626
+ This will retrieve the properties of a group share.
627
+
628
+ ### Examples
629
+
630
+ ```ruby
631
+ require 'time'
632
+ require 'ionoscloud'
633
+ # setup authorization
634
+ Ionoscloud.configure do |config|
635
+ # Configure HTTP basic authorization: Basic Authentication
636
+ config.username = 'YOUR USERNAME'
637
+ config.password = 'YOUR PASSWORD'
638
+
639
+ # Configure API key authorization: Token Authentication
640
+ config.api_key['Authorization'] = 'YOUR API KEY'
641
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
642
+ # config.api_key_prefix['Authorization'] = 'Bearer'
643
+ end
644
+
645
+ api_instance = Ionoscloud::UserManagementApi.new
646
+ group_id = 'group_id_example' # String |
647
+ resource_id = 'resource_id_example' # String |
648
+ opts = {
649
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
650
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
651
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
652
+ }
653
+
654
+ begin
655
+ # Retrieve a group share
656
+ result = api_instance.um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
657
+ p result
658
+ rescue Ionoscloud::ApiError => e
659
+ puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id: #{e}"
660
+ end
661
+ ```
662
+
663
+ #### Using the um_groups_shares_find_by_resource_id_with_http_info variant
664
+
665
+ This returns an Array which contains the response data, status code and headers.
666
+
667
+ > <Array(<GroupShare>, Integer, Hash)> um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
668
+
669
+ ```ruby
670
+ begin
671
+ # Retrieve a group share
672
+ data, status_code, headers = api_instance.um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
673
+ p status_code # => 2xx
674
+ p headers # => { ... }
675
+ p data # => <GroupShare>
676
+ rescue Ionoscloud::ApiError => e
677
+ puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id_with_http_info: #{e}"
678
+ end
679
+ ```
680
+
681
+ ### Parameters
682
+
683
+ | Name | Type | Description | Notes |
684
+ | ---- | ---- | ----------- | ----- |
685
+ | **group_id** | **String** | | |
686
+ | **resource_id** | **String** | | |
687
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
688
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
689
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
690
+
691
+ ### Return type
692
+
693
+ [**GroupShare**](GroupShare.md)
694
+
695
+ ### Authorization
696
+
697
+ Basic Authentication, Token Authentication
698
+
699
+ ### HTTP request headers
700
+
701
+ - **Content-Type**: Not defined
702
+ - **Accept**: application/json
703
+
704
+
705
+ ## um_groups_shares_get
706
+
707
+ > <GroupShares> um_groups_shares_get(group_id, opts)
708
+
709
+ List Group Shares
710
+
711
+ You can retrieve a list of all resources along with their permissions of the group
712
+
713
+ ### Examples
714
+
715
+ ```ruby
716
+ require 'time'
717
+ require 'ionoscloud'
718
+ # setup authorization
719
+ Ionoscloud.configure do |config|
720
+ # Configure HTTP basic authorization: Basic Authentication
721
+ config.username = 'YOUR USERNAME'
722
+ config.password = 'YOUR PASSWORD'
723
+
724
+ # Configure API key authorization: Token Authentication
725
+ config.api_key['Authorization'] = 'YOUR API KEY'
726
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
727
+ # config.api_key_prefix['Authorization'] = 'Bearer'
728
+ end
729
+
730
+ api_instance = Ionoscloud::UserManagementApi.new
731
+ group_id = 'group_id_example' # String |
732
+ opts = {
733
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
734
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
735
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
736
+ }
737
+
738
+ begin
739
+ # List Group Shares
740
+ result = api_instance.um_groups_shares_get(group_id, opts)
741
+ p result
742
+ rescue Ionoscloud::ApiError => e
743
+ puts "Error when calling UserManagementApi->um_groups_shares_get: #{e}"
744
+ end
745
+ ```
746
+
747
+ #### Using the um_groups_shares_get_with_http_info variant
748
+
749
+ This returns an Array which contains the response data, status code and headers.
750
+
751
+ > <Array(<GroupShares>, Integer, Hash)> um_groups_shares_get_with_http_info(group_id, opts)
752
+
753
+ ```ruby
754
+ begin
755
+ # List Group Shares
756
+ data, status_code, headers = api_instance.um_groups_shares_get_with_http_info(group_id, opts)
757
+ p status_code # => 2xx
758
+ p headers # => { ... }
759
+ p data # => <GroupShares>
760
+ rescue Ionoscloud::ApiError => e
761
+ puts "Error when calling UserManagementApi->um_groups_shares_get_with_http_info: #{e}"
762
+ end
763
+ ```
764
+
765
+ ### Parameters
766
+
767
+ | Name | Type | Description | Notes |
768
+ | ---- | ---- | ----------- | ----- |
769
+ | **group_id** | **String** | | |
770
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
771
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
772
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
773
+
774
+ ### Return type
775
+
776
+ [**GroupShares**](GroupShares.md)
777
+
778
+ ### Authorization
779
+
780
+ Basic Authentication, Token Authentication
781
+
782
+ ### HTTP request headers
783
+
784
+ - **Content-Type**: Not defined
785
+ - **Accept**: application/json
786
+
787
+
788
+ ## um_groups_shares_post
789
+
790
+ > <GroupShare> um_groups_shares_post(group_id, resource_id, resource, opts)
791
+
792
+ Add a resource to a group
793
+
794
+ This will add a resource to the group.
795
+
796
+ ### Examples
797
+
798
+ ```ruby
799
+ require 'time'
800
+ require 'ionoscloud'
801
+ # setup authorization
802
+ Ionoscloud.configure do |config|
803
+ # Configure HTTP basic authorization: Basic Authentication
804
+ config.username = 'YOUR USERNAME'
805
+ config.password = 'YOUR PASSWORD'
806
+
807
+ # Configure API key authorization: Token Authentication
808
+ config.api_key['Authorization'] = 'YOUR API KEY'
809
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
810
+ # config.api_key_prefix['Authorization'] = 'Bearer'
811
+ end
812
+
813
+ api_instance = Ionoscloud::UserManagementApi.new
814
+ group_id = 'group_id_example' # String |
815
+ resource_id = 'resource_id_example' # String |
816
+ resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Resource to be added
817
+ opts = {
818
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
819
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
820
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
821
+ }
822
+
823
+ begin
824
+ # Add a resource to a group
825
+ result = api_instance.um_groups_shares_post(group_id, resource_id, resource, opts)
826
+ p result
827
+ rescue Ionoscloud::ApiError => e
828
+ puts "Error when calling UserManagementApi->um_groups_shares_post: #{e}"
829
+ end
830
+ ```
831
+
832
+ #### Using the um_groups_shares_post_with_http_info variant
833
+
834
+ This returns an Array which contains the response data, status code and headers.
835
+
836
+ > <Array(<GroupShare>, Integer, Hash)> um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
837
+
838
+ ```ruby
839
+ begin
840
+ # Add a resource to a group
841
+ data, status_code, headers = api_instance.um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
842
+ p status_code # => 2xx
843
+ p headers # => { ... }
844
+ p data # => <GroupShare>
845
+ rescue Ionoscloud::ApiError => e
846
+ puts "Error when calling UserManagementApi->um_groups_shares_post_with_http_info: #{e}"
847
+ end
848
+ ```
849
+
850
+ ### Parameters
851
+
852
+ | Name | Type | Description | Notes |
853
+ | ---- | ---- | ----------- | ----- |
854
+ | **group_id** | **String** | | |
855
+ | **resource_id** | **String** | | |
856
+ | **resource** | [**GroupShare**](GroupShare.md) | Resource to be added | |
857
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
858
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
859
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
860
+
861
+ ### Return type
862
+
863
+ [**GroupShare**](GroupShare.md)
864
+
865
+ ### Authorization
866
+
867
+ Basic Authentication, Token Authentication
868
+
869
+ ### HTTP request headers
870
+
871
+ - **Content-Type**: Not defined
872
+ - **Accept**: application/json
873
+
874
+
875
+ ## um_groups_shares_put
876
+
877
+ > <GroupShare> um_groups_shares_put(group_id, resource_id, resource, opts)
878
+
879
+ Modify resource permissions of a group
880
+
881
+ You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
882
+
883
+ ### Examples
884
+
885
+ ```ruby
886
+ require 'time'
887
+ require 'ionoscloud'
888
+ # setup authorization
889
+ Ionoscloud.configure do |config|
890
+ # Configure HTTP basic authorization: Basic Authentication
891
+ config.username = 'YOUR USERNAME'
892
+ config.password = 'YOUR PASSWORD'
893
+
894
+ # Configure API key authorization: Token Authentication
895
+ config.api_key['Authorization'] = 'YOUR API KEY'
896
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
897
+ # config.api_key_prefix['Authorization'] = 'Bearer'
898
+ end
899
+
900
+ api_instance = Ionoscloud::UserManagementApi.new
901
+ group_id = 'group_id_example' # String |
902
+ resource_id = 'resource_id_example' # String |
903
+ resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Modified Resource
904
+ opts = {
905
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
906
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
907
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
908
+ }
909
+
910
+ begin
911
+ # Modify resource permissions of a group
912
+ result = api_instance.um_groups_shares_put(group_id, resource_id, resource, opts)
913
+ p result
914
+ rescue Ionoscloud::ApiError => e
915
+ puts "Error when calling UserManagementApi->um_groups_shares_put: #{e}"
916
+ end
917
+ ```
918
+
919
+ #### Using the um_groups_shares_put_with_http_info variant
920
+
921
+ This returns an Array which contains the response data, status code and headers.
922
+
923
+ > <Array(<GroupShare>, Integer, Hash)> um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
924
+
925
+ ```ruby
926
+ begin
927
+ # Modify resource permissions of a group
928
+ data, status_code, headers = api_instance.um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
929
+ p status_code # => 2xx
930
+ p headers # => { ... }
931
+ p data # => <GroupShare>
932
+ rescue Ionoscloud::ApiError => e
933
+ puts "Error when calling UserManagementApi->um_groups_shares_put_with_http_info: #{e}"
934
+ end
935
+ ```
936
+
937
+ ### Parameters
938
+
939
+ | Name | Type | Description | Notes |
940
+ | ---- | ---- | ----------- | ----- |
941
+ | **group_id** | **String** | | |
942
+ | **resource_id** | **String** | | |
943
+ | **resource** | [**GroupShare**](GroupShare.md) | Modified Resource | |
944
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
945
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
946
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
947
+
948
+ ### Return type
949
+
950
+ [**GroupShare**](GroupShare.md)
951
+
952
+ ### Authorization
953
+
954
+ Basic Authentication, Token Authentication
955
+
956
+ ### HTTP request headers
957
+
958
+ - **Content-Type**: application/json
959
+ - **Accept**: application/json
960
+
961
+
962
+ ## um_groups_users_delete
963
+
964
+ > Object um_groups_users_delete(group_id, user_id, opts)
965
+
966
+ Remove a user from a group
967
+
968
+ This will remove a user from a group
969
+
970
+ ### Examples
971
+
972
+ ```ruby
973
+ require 'time'
974
+ require 'ionoscloud'
975
+ # setup authorization
976
+ Ionoscloud.configure do |config|
977
+ # Configure HTTP basic authorization: Basic Authentication
978
+ config.username = 'YOUR USERNAME'
979
+ config.password = 'YOUR PASSWORD'
980
+
981
+ # Configure API key authorization: Token Authentication
982
+ config.api_key['Authorization'] = 'YOUR API KEY'
983
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
984
+ # config.api_key_prefix['Authorization'] = 'Bearer'
985
+ end
986
+
987
+ api_instance = Ionoscloud::UserManagementApi.new
988
+ group_id = 'group_id_example' # String |
989
+ user_id = 'user_id_example' # String |
990
+ opts = {
991
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
992
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
993
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
994
+ }
995
+
996
+ begin
997
+ # Remove a user from a group
998
+ result = api_instance.um_groups_users_delete(group_id, user_id, opts)
999
+ p result
1000
+ rescue Ionoscloud::ApiError => e
1001
+ puts "Error when calling UserManagementApi->um_groups_users_delete: #{e}"
1002
+ end
1003
+ ```
1004
+
1005
+ #### Using the um_groups_users_delete_with_http_info variant
1006
+
1007
+ This returns an Array which contains the response data, status code and headers.
1008
+
1009
+ > <Array(Object, Integer, Hash)> um_groups_users_delete_with_http_info(group_id, user_id, opts)
1010
+
1011
+ ```ruby
1012
+ begin
1013
+ # Remove a user from a group
1014
+ data, status_code, headers = api_instance.um_groups_users_delete_with_http_info(group_id, user_id, opts)
1015
+ p status_code # => 2xx
1016
+ p headers # => { ... }
1017
+ p data # => Object
1018
+ rescue Ionoscloud::ApiError => e
1019
+ puts "Error when calling UserManagementApi->um_groups_users_delete_with_http_info: #{e}"
1020
+ end
1021
+ ```
1022
+
1023
+ ### Parameters
1024
+
1025
+ | Name | Type | Description | Notes |
1026
+ | ---- | ---- | ----------- | ----- |
1027
+ | **group_id** | **String** | | |
1028
+ | **user_id** | **String** | | |
1029
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1030
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1031
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1032
+
1033
+ ### Return type
1034
+
1035
+ **Object**
1036
+
1037
+ ### Authorization
1038
+
1039
+ Basic Authentication, Token Authentication
1040
+
1041
+ ### HTTP request headers
1042
+
1043
+ - **Content-Type**: Not defined
1044
+ - **Accept**: application/json
1045
+
1046
+
1047
+ ## um_groups_users_get
1048
+
1049
+ > <GroupMembers> um_groups_users_get(group_id, opts)
1050
+
1051
+ List Group Members
1052
+
1053
+ You can retrieve a list of users who are members of the group
1054
+
1055
+ ### Examples
1056
+
1057
+ ```ruby
1058
+ require 'time'
1059
+ require 'ionoscloud'
1060
+ # setup authorization
1061
+ Ionoscloud.configure do |config|
1062
+ # Configure HTTP basic authorization: Basic Authentication
1063
+ config.username = 'YOUR USERNAME'
1064
+ config.password = 'YOUR PASSWORD'
1065
+
1066
+ # Configure API key authorization: Token Authentication
1067
+ config.api_key['Authorization'] = 'YOUR API KEY'
1068
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1069
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1070
+ end
1071
+
1072
+ api_instance = Ionoscloud::UserManagementApi.new
1073
+ group_id = 'group_id_example' # String |
1074
+ opts = {
1075
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1076
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1077
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1078
+ }
1079
+
1080
+ begin
1081
+ # List Group Members
1082
+ result = api_instance.um_groups_users_get(group_id, opts)
1083
+ p result
1084
+ rescue Ionoscloud::ApiError => e
1085
+ puts "Error when calling UserManagementApi->um_groups_users_get: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ #### Using the um_groups_users_get_with_http_info variant
1090
+
1091
+ This returns an Array which contains the response data, status code and headers.
1092
+
1093
+ > <Array(<GroupMembers>, Integer, Hash)> um_groups_users_get_with_http_info(group_id, opts)
1094
+
1095
+ ```ruby
1096
+ begin
1097
+ # List Group Members
1098
+ data, status_code, headers = api_instance.um_groups_users_get_with_http_info(group_id, opts)
1099
+ p status_code # => 2xx
1100
+ p headers # => { ... }
1101
+ p data # => <GroupMembers>
1102
+ rescue Ionoscloud::ApiError => e
1103
+ puts "Error when calling UserManagementApi->um_groups_users_get_with_http_info: #{e}"
1104
+ end
1105
+ ```
1106
+
1107
+ ### Parameters
1108
+
1109
+ | Name | Type | Description | Notes |
1110
+ | ---- | ---- | ----------- | ----- |
1111
+ | **group_id** | **String** | | |
1112
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1113
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1114
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1115
+
1116
+ ### Return type
1117
+
1118
+ [**GroupMembers**](GroupMembers.md)
1119
+
1120
+ ### Authorization
1121
+
1122
+ Basic Authentication, Token Authentication
1123
+
1124
+ ### HTTP request headers
1125
+
1126
+ - **Content-Type**: Not defined
1127
+ - **Accept**: application/json
1128
+
1129
+
1130
+ ## um_groups_users_post
1131
+
1132
+ > <User> um_groups_users_post(group_id, user, opts)
1133
+
1134
+ Add a user to a group
1135
+
1136
+ This will attach a pre-existing user to a group.
1137
+
1138
+ ### Examples
1139
+
1140
+ ```ruby
1141
+ require 'time'
1142
+ require 'ionoscloud'
1143
+ # setup authorization
1144
+ Ionoscloud.configure do |config|
1145
+ # Configure HTTP basic authorization: Basic Authentication
1146
+ config.username = 'YOUR USERNAME'
1147
+ config.password = 'YOUR PASSWORD'
1148
+
1149
+ # Configure API key authorization: Token Authentication
1150
+ config.api_key['Authorization'] = 'YOUR API KEY'
1151
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1152
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1153
+ end
1154
+
1155
+ api_instance = Ionoscloud::UserManagementApi.new
1156
+ group_id = 'group_id_example' # String |
1157
+ user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | User to be added
1158
+ opts = {
1159
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1160
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1161
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1162
+ }
1163
+
1164
+ begin
1165
+ # Add a user to a group
1166
+ result = api_instance.um_groups_users_post(group_id, user, opts)
1167
+ p result
1168
+ rescue Ionoscloud::ApiError => e
1169
+ puts "Error when calling UserManagementApi->um_groups_users_post: #{e}"
1170
+ end
1171
+ ```
1172
+
1173
+ #### Using the um_groups_users_post_with_http_info variant
1174
+
1175
+ This returns an Array which contains the response data, status code and headers.
1176
+
1177
+ > <Array(<User>, Integer, Hash)> um_groups_users_post_with_http_info(group_id, user, opts)
1178
+
1179
+ ```ruby
1180
+ begin
1181
+ # Add a user to a group
1182
+ data, status_code, headers = api_instance.um_groups_users_post_with_http_info(group_id, user, opts)
1183
+ p status_code # => 2xx
1184
+ p headers # => { ... }
1185
+ p data # => <User>
1186
+ rescue Ionoscloud::ApiError => e
1187
+ puts "Error when calling UserManagementApi->um_groups_users_post_with_http_info: #{e}"
1188
+ end
1189
+ ```
1190
+
1191
+ ### Parameters
1192
+
1193
+ | Name | Type | Description | Notes |
1194
+ | ---- | ---- | ----------- | ----- |
1195
+ | **group_id** | **String** | | |
1196
+ | **user** | [**User**](User.md) | User to be added | |
1197
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1198
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1199
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1200
+
1201
+ ### Return type
1202
+
1203
+ [**User**](User.md)
1204
+
1205
+ ### Authorization
1206
+
1207
+ Basic Authentication, Token Authentication
1208
+
1209
+ ### HTTP request headers
1210
+
1211
+ - **Content-Type**: application/json
1212
+ - **Accept**: application/json
1213
+
1214
+
1215
+ ## um_resources_find_by_type
1216
+
1217
+ > <Resources> um_resources_find_by_type(resource_type, opts)
1218
+
1219
+ Retrieve a list of Resources by type.
1220
+
1221
+ You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. This value of resource type also be found in the response body when you GET a list of all resources.
1222
+
1223
+ ### Examples
1224
+
1225
+ ```ruby
1226
+ require 'time'
1227
+ require 'ionoscloud'
1228
+ # setup authorization
1229
+ Ionoscloud.configure do |config|
1230
+ # Configure HTTP basic authorization: Basic Authentication
1231
+ config.username = 'YOUR USERNAME'
1232
+ config.password = 'YOUR PASSWORD'
1233
+
1234
+ # Configure API key authorization: Token Authentication
1235
+ config.api_key['Authorization'] = 'YOUR API KEY'
1236
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1237
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1238
+ end
1239
+
1240
+ api_instance = Ionoscloud::UserManagementApi.new
1241
+ resource_type = 'resource_type_example' # String | The resource Type
1242
+ opts = {
1243
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1244
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1245
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1246
+ }
1247
+
1248
+ begin
1249
+ # Retrieve a list of Resources by type.
1250
+ result = api_instance.um_resources_find_by_type(resource_type, opts)
1251
+ p result
1252
+ rescue Ionoscloud::ApiError => e
1253
+ puts "Error when calling UserManagementApi->um_resources_find_by_type: #{e}"
1254
+ end
1255
+ ```
1256
+
1257
+ #### Using the um_resources_find_by_type_with_http_info variant
1258
+
1259
+ This returns an Array which contains the response data, status code and headers.
1260
+
1261
+ > <Array(<Resources>, Integer, Hash)> um_resources_find_by_type_with_http_info(resource_type, opts)
1262
+
1263
+ ```ruby
1264
+ begin
1265
+ # Retrieve a list of Resources by type.
1266
+ data, status_code, headers = api_instance.um_resources_find_by_type_with_http_info(resource_type, opts)
1267
+ p status_code # => 2xx
1268
+ p headers # => { ... }
1269
+ p data # => <Resources>
1270
+ rescue Ionoscloud::ApiError => e
1271
+ puts "Error when calling UserManagementApi->um_resources_find_by_type_with_http_info: #{e}"
1272
+ end
1273
+ ```
1274
+
1275
+ ### Parameters
1276
+
1277
+ | Name | Type | Description | Notes |
1278
+ | ---- | ---- | ----------- | ----- |
1279
+ | **resource_type** | **String** | The resource Type | |
1280
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1281
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1282
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1283
+
1284
+ ### Return type
1285
+
1286
+ [**Resources**](Resources.md)
1287
+
1288
+ ### Authorization
1289
+
1290
+ Basic Authentication, Token Authentication
1291
+
1292
+ ### HTTP request headers
1293
+
1294
+ - **Content-Type**: Not defined
1295
+ - **Accept**: application/json
1296
+
1297
+
1298
+ ## um_resources_find_by_type_and_id
1299
+
1300
+ > <Resource> um_resources_find_by_type_and_id(resource_type, resource_id, opts)
1301
+
1302
+ Retrieve a Resource by type.
1303
+
1304
+ You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. The value of resource type can also be found in the response body when you GET a list of all resources.
1305
+
1306
+ ### Examples
1307
+
1308
+ ```ruby
1309
+ require 'time'
1310
+ require 'ionoscloud'
1311
+ # setup authorization
1312
+ Ionoscloud.configure do |config|
1313
+ # Configure HTTP basic authorization: Basic Authentication
1314
+ config.username = 'YOUR USERNAME'
1315
+ config.password = 'YOUR PASSWORD'
1316
+
1317
+ # Configure API key authorization: Token Authentication
1318
+ config.api_key['Authorization'] = 'YOUR API KEY'
1319
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1320
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1321
+ end
1322
+
1323
+ api_instance = Ionoscloud::UserManagementApi.new
1324
+ resource_type = 'resource_type_example' # String | The resource Type
1325
+ resource_id = 'resource_id_example' # String | The resource Uuid
1326
+ opts = {
1327
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1328
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1329
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1330
+ }
1331
+
1332
+ begin
1333
+ # Retrieve a Resource by type.
1334
+ result = api_instance.um_resources_find_by_type_and_id(resource_type, resource_id, opts)
1335
+ p result
1336
+ rescue Ionoscloud::ApiError => e
1337
+ puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id: #{e}"
1338
+ end
1339
+ ```
1340
+
1341
+ #### Using the um_resources_find_by_type_and_id_with_http_info variant
1342
+
1343
+ This returns an Array which contains the response data, status code and headers.
1344
+
1345
+ > <Array(<Resource>, Integer, Hash)> um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
1346
+
1347
+ ```ruby
1348
+ begin
1349
+ # Retrieve a Resource by type.
1350
+ data, status_code, headers = api_instance.um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
1351
+ p status_code # => 2xx
1352
+ p headers # => { ... }
1353
+ p data # => <Resource>
1354
+ rescue Ionoscloud::ApiError => e
1355
+ puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id_with_http_info: #{e}"
1356
+ end
1357
+ ```
1358
+
1359
+ ### Parameters
1360
+
1361
+ | Name | Type | Description | Notes |
1362
+ | ---- | ---- | ----------- | ----- |
1363
+ | **resource_type** | **String** | The resource Type | |
1364
+ | **resource_id** | **String** | The resource Uuid | |
1365
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1366
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1367
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1368
+
1369
+ ### Return type
1370
+
1371
+ [**Resource**](Resource.md)
1372
+
1373
+ ### Authorization
1374
+
1375
+ Basic Authentication, Token Authentication
1376
+
1377
+ ### HTTP request headers
1378
+
1379
+ - **Content-Type**: Not defined
1380
+ - **Accept**: application/json
1381
+
1382
+
1383
+ ## um_resources_get
1384
+
1385
+ > <Resources> um_resources_get(opts)
1386
+
1387
+ List All Resources.
1388
+
1389
+ You can retrieve a complete list of all resources that you have access to
1390
+
1391
+ ### Examples
1392
+
1393
+ ```ruby
1394
+ require 'time'
1395
+ require 'ionoscloud'
1396
+ # setup authorization
1397
+ Ionoscloud.configure do |config|
1398
+ # Configure HTTP basic authorization: Basic Authentication
1399
+ config.username = 'YOUR USERNAME'
1400
+ config.password = 'YOUR PASSWORD'
1401
+
1402
+ # Configure API key authorization: Token Authentication
1403
+ config.api_key['Authorization'] = 'YOUR API KEY'
1404
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1405
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1406
+ end
1407
+
1408
+ api_instance = Ionoscloud::UserManagementApi.new
1409
+ opts = {
1410
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1411
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1412
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1413
+ }
1414
+
1415
+ begin
1416
+ # List All Resources.
1417
+ result = api_instance.um_resources_get(opts)
1418
+ p result
1419
+ rescue Ionoscloud::ApiError => e
1420
+ puts "Error when calling UserManagementApi->um_resources_get: #{e}"
1421
+ end
1422
+ ```
1423
+
1424
+ #### Using the um_resources_get_with_http_info variant
1425
+
1426
+ This returns an Array which contains the response data, status code and headers.
1427
+
1428
+ > <Array(<Resources>, Integer, Hash)> um_resources_get_with_http_info(opts)
1429
+
1430
+ ```ruby
1431
+ begin
1432
+ # List All Resources.
1433
+ data, status_code, headers = api_instance.um_resources_get_with_http_info(opts)
1434
+ p status_code # => 2xx
1435
+ p headers # => { ... }
1436
+ p data # => <Resources>
1437
+ rescue Ionoscloud::ApiError => e
1438
+ puts "Error when calling UserManagementApi->um_resources_get_with_http_info: #{e}"
1439
+ end
1440
+ ```
1441
+
1442
+ ### Parameters
1443
+
1444
+ | Name | Type | Description | Notes |
1445
+ | ---- | ---- | ----------- | ----- |
1446
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1447
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1448
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1449
+
1450
+ ### Return type
1451
+
1452
+ [**Resources**](Resources.md)
1453
+
1454
+ ### Authorization
1455
+
1456
+ Basic Authentication, Token Authentication
1457
+
1458
+ ### HTTP request headers
1459
+
1460
+ - **Content-Type**: Not defined
1461
+ - **Accept**: application/json
1462
+
1463
+
1464
+ ## um_users_delete
1465
+
1466
+ > Object um_users_delete(user_id, opts)
1467
+
1468
+ Delete a User
1469
+
1470
+ Delete a user
1471
+
1472
+ ### Examples
1473
+
1474
+ ```ruby
1475
+ require 'time'
1476
+ require 'ionoscloud'
1477
+ # setup authorization
1478
+ Ionoscloud.configure do |config|
1479
+ # Configure HTTP basic authorization: Basic Authentication
1480
+ config.username = 'YOUR USERNAME'
1481
+ config.password = 'YOUR PASSWORD'
1482
+
1483
+ # Configure API key authorization: Token Authentication
1484
+ config.api_key['Authorization'] = 'YOUR API KEY'
1485
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1486
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1487
+ end
1488
+
1489
+ api_instance = Ionoscloud::UserManagementApi.new
1490
+ user_id = 'user_id_example' # String | The unique ID of the user
1491
+ opts = {
1492
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1493
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1494
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1495
+ }
1496
+
1497
+ begin
1498
+ # Delete a User
1499
+ result = api_instance.um_users_delete(user_id, opts)
1500
+ p result
1501
+ rescue Ionoscloud::ApiError => e
1502
+ puts "Error when calling UserManagementApi->um_users_delete: #{e}"
1503
+ end
1504
+ ```
1505
+
1506
+ #### Using the um_users_delete_with_http_info variant
1507
+
1508
+ This returns an Array which contains the response data, status code and headers.
1509
+
1510
+ > <Array(Object, Integer, Hash)> um_users_delete_with_http_info(user_id, opts)
1511
+
1512
+ ```ruby
1513
+ begin
1514
+ # Delete a User
1515
+ data, status_code, headers = api_instance.um_users_delete_with_http_info(user_id, opts)
1516
+ p status_code # => 2xx
1517
+ p headers # => { ... }
1518
+ p data # => Object
1519
+ rescue Ionoscloud::ApiError => e
1520
+ puts "Error when calling UserManagementApi->um_users_delete_with_http_info: #{e}"
1521
+ end
1522
+ ```
1523
+
1524
+ ### Parameters
1525
+
1526
+ | Name | Type | Description | Notes |
1527
+ | ---- | ---- | ----------- | ----- |
1528
+ | **user_id** | **String** | The unique ID of the user | |
1529
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1530
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1531
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1532
+
1533
+ ### Return type
1534
+
1535
+ **Object**
1536
+
1537
+ ### Authorization
1538
+
1539
+ Basic Authentication, Token Authentication
1540
+
1541
+ ### HTTP request headers
1542
+
1543
+ - **Content-Type**: Not defined
1544
+ - **Accept**: application/json
1545
+
1546
+
1547
+ ## um_users_find_by_id
1548
+
1549
+ > <User> um_users_find_by_id(user_id, opts)
1550
+
1551
+ Retrieve a User
1552
+
1553
+ You can retrieve user details by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
1554
+
1555
+ ### Examples
1556
+
1557
+ ```ruby
1558
+ require 'time'
1559
+ require 'ionoscloud'
1560
+ # setup authorization
1561
+ Ionoscloud.configure do |config|
1562
+ # Configure HTTP basic authorization: Basic Authentication
1563
+ config.username = 'YOUR USERNAME'
1564
+ config.password = 'YOUR PASSWORD'
1565
+
1566
+ # Configure API key authorization: Token Authentication
1567
+ config.api_key['Authorization'] = 'YOUR API KEY'
1568
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1569
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1570
+ end
1571
+
1572
+ api_instance = Ionoscloud::UserManagementApi.new
1573
+ user_id = 'user_id_example' # String | The unique ID of the user
1574
+ opts = {
1575
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1576
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1577
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1578
+ }
1579
+
1580
+ begin
1581
+ # Retrieve a User
1582
+ result = api_instance.um_users_find_by_id(user_id, opts)
1583
+ p result
1584
+ rescue Ionoscloud::ApiError => e
1585
+ puts "Error when calling UserManagementApi->um_users_find_by_id: #{e}"
1586
+ end
1587
+ ```
1588
+
1589
+ #### Using the um_users_find_by_id_with_http_info variant
1590
+
1591
+ This returns an Array which contains the response data, status code and headers.
1592
+
1593
+ > <Array(<User>, Integer, Hash)> um_users_find_by_id_with_http_info(user_id, opts)
1594
+
1595
+ ```ruby
1596
+ begin
1597
+ # Retrieve a User
1598
+ data, status_code, headers = api_instance.um_users_find_by_id_with_http_info(user_id, opts)
1599
+ p status_code # => 2xx
1600
+ p headers # => { ... }
1601
+ p data # => <User>
1602
+ rescue Ionoscloud::ApiError => e
1603
+ puts "Error when calling UserManagementApi->um_users_find_by_id_with_http_info: #{e}"
1604
+ end
1605
+ ```
1606
+
1607
+ ### Parameters
1608
+
1609
+ | Name | Type | Description | Notes |
1610
+ | ---- | ---- | ----------- | ----- |
1611
+ | **user_id** | **String** | The unique ID of the user | |
1612
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1613
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1614
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1615
+
1616
+ ### Return type
1617
+
1618
+ [**User**](User.md)
1619
+
1620
+ ### Authorization
1621
+
1622
+ Basic Authentication, Token Authentication
1623
+
1624
+ ### HTTP request headers
1625
+
1626
+ - **Content-Type**: Not defined
1627
+ - **Accept**: application/json
1628
+
1629
+
1630
+ ## um_users_get
1631
+
1632
+ > <Users> um_users_get(opts)
1633
+
1634
+ List all Users
1635
+
1636
+ You can retrieve a complete list of users under your account
1637
+
1638
+ ### Examples
1639
+
1640
+ ```ruby
1641
+ require 'time'
1642
+ require 'ionoscloud'
1643
+ # setup authorization
1644
+ Ionoscloud.configure do |config|
1645
+ # Configure HTTP basic authorization: Basic Authentication
1646
+ config.username = 'YOUR USERNAME'
1647
+ config.password = 'YOUR PASSWORD'
1648
+
1649
+ # Configure API key authorization: Token Authentication
1650
+ config.api_key['Authorization'] = 'YOUR API KEY'
1651
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1652
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1653
+ end
1654
+
1655
+ api_instance = Ionoscloud::UserManagementApi.new
1656
+ opts = {
1657
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1658
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1659
+ x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1660
+ offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
1661
+ limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
1662
+ }
1663
+
1664
+ begin
1665
+ # List all Users
1666
+ result = api_instance.um_users_get(opts)
1667
+ p result
1668
+ rescue Ionoscloud::ApiError => e
1669
+ puts "Error when calling UserManagementApi->um_users_get: #{e}"
1670
+ end
1671
+ ```
1672
+
1673
+ #### Using the um_users_get_with_http_info variant
1674
+
1675
+ This returns an Array which contains the response data, status code and headers.
1676
+
1677
+ > <Array(<Users>, Integer, Hash)> um_users_get_with_http_info(opts)
1678
+
1679
+ ```ruby
1680
+ begin
1681
+ # List all Users
1682
+ data, status_code, headers = api_instance.um_users_get_with_http_info(opts)
1683
+ p status_code # => 2xx
1684
+ p headers # => { ... }
1685
+ p data # => <Users>
1686
+ rescue Ionoscloud::ApiError => e
1687
+ puts "Error when calling UserManagementApi->um_users_get_with_http_info: #{e}"
1688
+ end
1689
+ ```
1690
+
1691
+ ### Parameters
1692
+
1693
+ | Name | Type | Description | Notes |
1694
+ | ---- | ---- | ----------- | ----- |
1695
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1696
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1697
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1698
+ | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
1699
+ | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 100] |
1700
+
1701
+ ### Return type
1702
+
1703
+ [**Users**](Users.md)
1704
+
1705
+ ### Authorization
1706
+
1707
+ Basic Authentication, Token Authentication
1708
+
1709
+ ### HTTP request headers
1710
+
1711
+ - **Content-Type**: Not defined
1712
+ - **Accept**: application/json
1713
+
1714
+
1715
+ ## um_users_groups_get
1716
+
1717
+ > <ResourceGroups> um_users_groups_get(user_id, opts)
1718
+
1719
+ Retrieve a User's group resources
1720
+
1721
+ You can retrieve group resources of user by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
1722
+
1723
+ ### Examples
1724
+
1725
+ ```ruby
1726
+ require 'time'
1727
+ require 'ionoscloud'
1728
+ # setup authorization
1729
+ Ionoscloud.configure do |config|
1730
+ # Configure HTTP basic authorization: Basic Authentication
1731
+ config.username = 'YOUR USERNAME'
1732
+ config.password = 'YOUR PASSWORD'
1733
+
1734
+ # Configure API key authorization: Token Authentication
1735
+ config.api_key['Authorization'] = 'YOUR API KEY'
1736
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1737
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1738
+ end
1739
+
1740
+ api_instance = Ionoscloud::UserManagementApi.new
1741
+ user_id = 'user_id_example' # String | The unique ID of the user
1742
+ opts = {
1743
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1744
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1745
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1746
+ }
1747
+
1748
+ begin
1749
+ # Retrieve a User's group resources
1750
+ result = api_instance.um_users_groups_get(user_id, opts)
1751
+ p result
1752
+ rescue Ionoscloud::ApiError => e
1753
+ puts "Error when calling UserManagementApi->um_users_groups_get: #{e}"
1754
+ end
1755
+ ```
1756
+
1757
+ #### Using the um_users_groups_get_with_http_info variant
1758
+
1759
+ This returns an Array which contains the response data, status code and headers.
1760
+
1761
+ > <Array(<ResourceGroups>, Integer, Hash)> um_users_groups_get_with_http_info(user_id, opts)
1762
+
1763
+ ```ruby
1764
+ begin
1765
+ # Retrieve a User's group resources
1766
+ data, status_code, headers = api_instance.um_users_groups_get_with_http_info(user_id, opts)
1767
+ p status_code # => 2xx
1768
+ p headers # => { ... }
1769
+ p data # => <ResourceGroups>
1770
+ rescue Ionoscloud::ApiError => e
1771
+ puts "Error when calling UserManagementApi->um_users_groups_get_with_http_info: #{e}"
1772
+ end
1773
+ ```
1774
+
1775
+ ### Parameters
1776
+
1777
+ | Name | Type | Description | Notes |
1778
+ | ---- | ---- | ----------- | ----- |
1779
+ | **user_id** | **String** | The unique ID of the user | |
1780
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1781
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1782
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1783
+
1784
+ ### Return type
1785
+
1786
+ [**ResourceGroups**](ResourceGroups.md)
1787
+
1788
+ ### Authorization
1789
+
1790
+ Basic Authentication, Token Authentication
1791
+
1792
+ ### HTTP request headers
1793
+
1794
+ - **Content-Type**: Not defined
1795
+ - **Accept**: application/json
1796
+
1797
+
1798
+ ## um_users_owns_get
1799
+
1800
+ > <ResourcesUsers> um_users_owns_get(user_id, opts)
1801
+
1802
+ Retrieve a User's own resources
1803
+
1804
+ You can retrieve resources owned by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
1805
+
1806
+ ### Examples
1807
+
1808
+ ```ruby
1809
+ require 'time'
1810
+ require 'ionoscloud'
1811
+ # setup authorization
1812
+ Ionoscloud.configure do |config|
1813
+ # Configure HTTP basic authorization: Basic Authentication
1814
+ config.username = 'YOUR USERNAME'
1815
+ config.password = 'YOUR PASSWORD'
1816
+
1817
+ # Configure API key authorization: Token Authentication
1818
+ config.api_key['Authorization'] = 'YOUR API KEY'
1819
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1820
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1821
+ end
1822
+
1823
+ api_instance = Ionoscloud::UserManagementApi.new
1824
+ user_id = 'user_id_example' # String | The unique ID of the user
1825
+ opts = {
1826
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1827
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1828
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1829
+ }
1830
+
1831
+ begin
1832
+ # Retrieve a User's own resources
1833
+ result = api_instance.um_users_owns_get(user_id, opts)
1834
+ p result
1835
+ rescue Ionoscloud::ApiError => e
1836
+ puts "Error when calling UserManagementApi->um_users_owns_get: #{e}"
1837
+ end
1838
+ ```
1839
+
1840
+ #### Using the um_users_owns_get_with_http_info variant
1841
+
1842
+ This returns an Array which contains the response data, status code and headers.
1843
+
1844
+ > <Array(<ResourcesUsers>, Integer, Hash)> um_users_owns_get_with_http_info(user_id, opts)
1845
+
1846
+ ```ruby
1847
+ begin
1848
+ # Retrieve a User's own resources
1849
+ data, status_code, headers = api_instance.um_users_owns_get_with_http_info(user_id, opts)
1850
+ p status_code # => 2xx
1851
+ p headers # => { ... }
1852
+ p data # => <ResourcesUsers>
1853
+ rescue Ionoscloud::ApiError => e
1854
+ puts "Error when calling UserManagementApi->um_users_owns_get_with_http_info: #{e}"
1855
+ end
1856
+ ```
1857
+
1858
+ ### Parameters
1859
+
1860
+ | Name | Type | Description | Notes |
1861
+ | ---- | ---- | ----------- | ----- |
1862
+ | **user_id** | **String** | The unique ID of the user | |
1863
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1864
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1865
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1866
+
1867
+ ### Return type
1868
+
1869
+ [**ResourcesUsers**](ResourcesUsers.md)
1870
+
1871
+ ### Authorization
1872
+
1873
+ Basic Authentication, Token Authentication
1874
+
1875
+ ### HTTP request headers
1876
+
1877
+ - **Content-Type**: Not defined
1878
+ - **Accept**: application/json
1879
+
1880
+
1881
+ ## um_users_post
1882
+
1883
+ > <User> um_users_post(user, opts)
1884
+
1885
+ Create a user
1886
+
1887
+ You can use this POST method to create a user
1888
+
1889
+ ### Examples
1890
+
1891
+ ```ruby
1892
+ require 'time'
1893
+ require 'ionoscloud'
1894
+ # setup authorization
1895
+ Ionoscloud.configure do |config|
1896
+ # Configure HTTP basic authorization: Basic Authentication
1897
+ config.username = 'YOUR USERNAME'
1898
+ config.password = 'YOUR PASSWORD'
1899
+
1900
+ # Configure API key authorization: Token Authentication
1901
+ config.api_key['Authorization'] = 'YOUR API KEY'
1902
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1903
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1904
+ end
1905
+
1906
+ api_instance = Ionoscloud::UserManagementApi.new
1907
+ user = Ionoscloud::UserPost.new({properties: Ionoscloud::UserPropertiesPost.new}) # UserPost | User to be created
1908
+ opts = {
1909
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1910
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1911
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1912
+ }
1913
+
1914
+ begin
1915
+ # Create a user
1916
+ result = api_instance.um_users_post(user, opts)
1917
+ p result
1918
+ rescue Ionoscloud::ApiError => e
1919
+ puts "Error when calling UserManagementApi->um_users_post: #{e}"
1920
+ end
1921
+ ```
1922
+
1923
+ #### Using the um_users_post_with_http_info variant
1924
+
1925
+ This returns an Array which contains the response data, status code and headers.
1926
+
1927
+ > <Array(<User>, Integer, Hash)> um_users_post_with_http_info(user, opts)
1928
+
1929
+ ```ruby
1930
+ begin
1931
+ # Create a user
1932
+ data, status_code, headers = api_instance.um_users_post_with_http_info(user, opts)
1933
+ p status_code # => 2xx
1934
+ p headers # => { ... }
1935
+ p data # => <User>
1936
+ rescue Ionoscloud::ApiError => e
1937
+ puts "Error when calling UserManagementApi->um_users_post_with_http_info: #{e}"
1938
+ end
1939
+ ```
1940
+
1941
+ ### Parameters
1942
+
1943
+ | Name | Type | Description | Notes |
1944
+ | ---- | ---- | ----------- | ----- |
1945
+ | **user** | [**UserPost**](UserPost.md) | User to be created | |
1946
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1947
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1948
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1949
+
1950
+ ### Return type
1951
+
1952
+ [**User**](User.md)
1953
+
1954
+ ### Authorization
1955
+
1956
+ Basic Authentication, Token Authentication
1957
+
1958
+ ### HTTP request headers
1959
+
1960
+ - **Content-Type**: application/json
1961
+ - **Accept**: application/json
1962
+
1963
+
1964
+ ## um_users_put
1965
+
1966
+ > <User> um_users_put(user_id, user, opts)
1967
+
1968
+ Modify a user
1969
+
1970
+ You can use update attributes of a User
1971
+
1972
+ ### Examples
1973
+
1974
+ ```ruby
1975
+ require 'time'
1976
+ require 'ionoscloud'
1977
+ # setup authorization
1978
+ Ionoscloud.configure do |config|
1979
+ # Configure HTTP basic authorization: Basic Authentication
1980
+ config.username = 'YOUR USERNAME'
1981
+ config.password = 'YOUR PASSWORD'
1982
+
1983
+ # Configure API key authorization: Token Authentication
1984
+ config.api_key['Authorization'] = 'YOUR API KEY'
1985
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1986
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1987
+ end
1988
+
1989
+ api_instance = Ionoscloud::UserManagementApi.new
1990
+ user_id = 'user_id_example' # String |
1991
+ user = Ionoscloud::UserPut.new({properties: Ionoscloud::UserPropertiesPut.new}) # UserPut | Modified user
1992
+ opts = {
1993
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1994
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1995
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1996
+ }
1997
+
1998
+ begin
1999
+ # Modify a user
2000
+ result = api_instance.um_users_put(user_id, user, opts)
2001
+ p result
2002
+ rescue Ionoscloud::ApiError => e
2003
+ puts "Error when calling UserManagementApi->um_users_put: #{e}"
2004
+ end
2005
+ ```
2006
+
2007
+ #### Using the um_users_put_with_http_info variant
2008
+
2009
+ This returns an Array which contains the response data, status code and headers.
2010
+
2011
+ > <Array(<User>, Integer, Hash)> um_users_put_with_http_info(user_id, user, opts)
2012
+
2013
+ ```ruby
2014
+ begin
2015
+ # Modify a user
2016
+ data, status_code, headers = api_instance.um_users_put_with_http_info(user_id, user, opts)
2017
+ p status_code # => 2xx
2018
+ p headers # => { ... }
2019
+ p data # => <User>
2020
+ rescue Ionoscloud::ApiError => e
2021
+ puts "Error when calling UserManagementApi->um_users_put_with_http_info: #{e}"
2022
+ end
2023
+ ```
2024
+
2025
+ ### Parameters
2026
+
2027
+ | Name | Type | Description | Notes |
2028
+ | ---- | ---- | ----------- | ----- |
2029
+ | **user_id** | **String** | | |
2030
+ | **user** | [**UserPut**](UserPut.md) | Modified user | |
2031
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2032
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2033
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2034
+
2035
+ ### Return type
2036
+
2037
+ [**User**](User.md)
2038
+
2039
+ ### Authorization
2040
+
2041
+ Basic Authentication, Token Authentication
2042
+
2043
+ ### HTTP request headers
2044
+
2045
+ - **Content-Type**: application/json
2046
+ - **Accept**: application/json
2047
+
2048
+
2049
+ ## um_users_s3keys_delete
2050
+
2051
+ > Object um_users_s3keys_delete(user_id, key_id, opts)
2052
+
2053
+ Delete a S3 key
2054
+
2055
+ Delete a S3 key
2056
+
2057
+ ### Examples
2058
+
2059
+ ```ruby
2060
+ require 'time'
2061
+ require 'ionoscloud'
2062
+ # setup authorization
2063
+ Ionoscloud.configure do |config|
2064
+ # Configure HTTP basic authorization: Basic Authentication
2065
+ config.username = 'YOUR USERNAME'
2066
+ config.password = 'YOUR PASSWORD'
2067
+
2068
+ # Configure API key authorization: Token Authentication
2069
+ config.api_key['Authorization'] = 'YOUR API KEY'
2070
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2071
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2072
+ end
2073
+
2074
+ api_instance = Ionoscloud::UserManagementApi.new
2075
+ user_id = 'user_id_example' # String | The unique ID of the user
2076
+ key_id = 'key_id_example' # String | The unique access key ID of the S3 key
2077
+ opts = {
2078
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2079
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2080
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2081
+ }
2082
+
2083
+ begin
2084
+ # Delete a S3 key
2085
+ result = api_instance.um_users_s3keys_delete(user_id, key_id, opts)
2086
+ p result
2087
+ rescue Ionoscloud::ApiError => e
2088
+ puts "Error when calling UserManagementApi->um_users_s3keys_delete: #{e}"
2089
+ end
2090
+ ```
2091
+
2092
+ #### Using the um_users_s3keys_delete_with_http_info variant
2093
+
2094
+ This returns an Array which contains the response data, status code and headers.
2095
+
2096
+ > <Array(Object, Integer, Hash)> um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
2097
+
2098
+ ```ruby
2099
+ begin
2100
+ # Delete a S3 key
2101
+ data, status_code, headers = api_instance.um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
2102
+ p status_code # => 2xx
2103
+ p headers # => { ... }
2104
+ p data # => Object
2105
+ rescue Ionoscloud::ApiError => e
2106
+ puts "Error when calling UserManagementApi->um_users_s3keys_delete_with_http_info: #{e}"
2107
+ end
2108
+ ```
2109
+
2110
+ ### Parameters
2111
+
2112
+ | Name | Type | Description | Notes |
2113
+ | ---- | ---- | ----------- | ----- |
2114
+ | **user_id** | **String** | The unique ID of the user | |
2115
+ | **key_id** | **String** | The unique access key ID of the S3 key | |
2116
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2117
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2118
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2119
+
2120
+ ### Return type
2121
+
2122
+ **Object**
2123
+
2124
+ ### Authorization
2125
+
2126
+ Basic Authentication, Token Authentication
2127
+
2128
+ ### HTTP request headers
2129
+
2130
+ - **Content-Type**: Not defined
2131
+ - **Accept**: application/json
2132
+
2133
+
2134
+ ## um_users_s3keys_find_by_key_id
2135
+
2136
+ > <S3Key> um_users_s3keys_find_by_key_id(user_id, key_id, opts)
2137
+
2138
+ Retrieve given S3 key belonging to the given User
2139
+
2140
+ You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user
2141
+
2142
+ ### Examples
2143
+
2144
+ ```ruby
2145
+ require 'time'
2146
+ require 'ionoscloud'
2147
+ # setup authorization
2148
+ Ionoscloud.configure do |config|
2149
+ # Configure HTTP basic authorization: Basic Authentication
2150
+ config.username = 'YOUR USERNAME'
2151
+ config.password = 'YOUR PASSWORD'
2152
+
2153
+ # Configure API key authorization: Token Authentication
2154
+ config.api_key['Authorization'] = 'YOUR API KEY'
2155
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2156
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2157
+ end
2158
+
2159
+ api_instance = Ionoscloud::UserManagementApi.new
2160
+ user_id = 'user_id_example' # String | The unique ID of the user
2161
+ key_id = 'key_id_example' # String | The unique access key ID of the S3 key
2162
+ opts = {
2163
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2164
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2165
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2166
+ }
2167
+
2168
+ begin
2169
+ # Retrieve given S3 key belonging to the given User
2170
+ result = api_instance.um_users_s3keys_find_by_key_id(user_id, key_id, opts)
2171
+ p result
2172
+ rescue Ionoscloud::ApiError => e
2173
+ puts "Error when calling UserManagementApi->um_users_s3keys_find_by_key_id: #{e}"
2174
+ end
2175
+ ```
2176
+
2177
+ #### Using the um_users_s3keys_find_by_key_id_with_http_info variant
2178
+
2179
+ This returns an Array which contains the response data, status code and headers.
2180
+
2181
+ > <Array(<S3Key>, Integer, Hash)> um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
2182
+
2183
+ ```ruby
2184
+ begin
2185
+ # Retrieve given S3 key belonging to the given User
2186
+ data, status_code, headers = api_instance.um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
2187
+ p status_code # => 2xx
2188
+ p headers # => { ... }
2189
+ p data # => <S3Key>
2190
+ rescue Ionoscloud::ApiError => e
2191
+ puts "Error when calling UserManagementApi->um_users_s3keys_find_by_key_id_with_http_info: #{e}"
2192
+ end
2193
+ ```
2194
+
2195
+ ### Parameters
2196
+
2197
+ | Name | Type | Description | Notes |
2198
+ | ---- | ---- | ----------- | ----- |
2199
+ | **user_id** | **String** | The unique ID of the user | |
2200
+ | **key_id** | **String** | The unique access key ID of the S3 key | |
2201
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2202
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2203
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2204
+
2205
+ ### Return type
2206
+
2207
+ [**S3Key**](S3Key.md)
2208
+
2209
+ ### Authorization
2210
+
2211
+ Basic Authentication, Token Authentication
2212
+
2213
+ ### HTTP request headers
2214
+
2215
+ - **Content-Type**: Not defined
2216
+ - **Accept**: application/json
2217
+
2218
+
2219
+ ## um_users_s3keys_get
2220
+
2221
+ > <S3Keys> um_users_s3keys_get(user_id, opts)
2222
+
2223
+ Retrieve a User's S3 keys
2224
+
2225
+ You can retrieve S3 keys owned by a user by using the users ID. This user Id can be found in the response body when a user is created or when you GET a list of users.
2226
+
2227
+ ### Examples
2228
+
2229
+ ```ruby
2230
+ require 'time'
2231
+ require 'ionoscloud'
2232
+ # setup authorization
2233
+ Ionoscloud.configure do |config|
2234
+ # Configure HTTP basic authorization: Basic Authentication
2235
+ config.username = 'YOUR USERNAME'
2236
+ config.password = 'YOUR PASSWORD'
2237
+
2238
+ # Configure API key authorization: Token Authentication
2239
+ config.api_key['Authorization'] = 'YOUR API KEY'
2240
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2241
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2242
+ end
2243
+
2244
+ api_instance = Ionoscloud::UserManagementApi.new
2245
+ user_id = 'user_id_example' # String | The unique ID of the user
2246
+ opts = {
2247
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2248
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2249
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2250
+ }
2251
+
2252
+ begin
2253
+ # Retrieve a User's S3 keys
2254
+ result = api_instance.um_users_s3keys_get(user_id, opts)
2255
+ p result
2256
+ rescue Ionoscloud::ApiError => e
2257
+ puts "Error when calling UserManagementApi->um_users_s3keys_get: #{e}"
2258
+ end
2259
+ ```
2260
+
2261
+ #### Using the um_users_s3keys_get_with_http_info variant
2262
+
2263
+ This returns an Array which contains the response data, status code and headers.
2264
+
2265
+ > <Array(<S3Keys>, Integer, Hash)> um_users_s3keys_get_with_http_info(user_id, opts)
2266
+
2267
+ ```ruby
2268
+ begin
2269
+ # Retrieve a User's S3 keys
2270
+ data, status_code, headers = api_instance.um_users_s3keys_get_with_http_info(user_id, opts)
2271
+ p status_code # => 2xx
2272
+ p headers # => { ... }
2273
+ p data # => <S3Keys>
2274
+ rescue Ionoscloud::ApiError => e
2275
+ puts "Error when calling UserManagementApi->um_users_s3keys_get_with_http_info: #{e}"
2276
+ end
2277
+ ```
2278
+
2279
+ ### Parameters
2280
+
2281
+ | Name | Type | Description | Notes |
2282
+ | ---- | ---- | ----------- | ----- |
2283
+ | **user_id** | **String** | The unique ID of the user | |
2284
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2285
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2286
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2287
+
2288
+ ### Return type
2289
+
2290
+ [**S3Keys**](S3Keys.md)
2291
+
2292
+ ### Authorization
2293
+
2294
+ Basic Authentication, Token Authentication
2295
+
2296
+ ### HTTP request headers
2297
+
2298
+ - **Content-Type**: Not defined
2299
+ - **Accept**: application/json
2300
+
2301
+
2302
+ ## um_users_s3keys_post
2303
+
2304
+ > <S3Key> um_users_s3keys_post(user_id, opts)
2305
+
2306
+ Create a S3 key for the given user
2307
+
2308
+ Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user
2309
+
2310
+ ### Examples
2311
+
2312
+ ```ruby
2313
+ require 'time'
2314
+ require 'ionoscloud'
2315
+ # setup authorization
2316
+ Ionoscloud.configure do |config|
2317
+ # Configure HTTP basic authorization: Basic Authentication
2318
+ config.username = 'YOUR USERNAME'
2319
+ config.password = 'YOUR PASSWORD'
2320
+
2321
+ # Configure API key authorization: Token Authentication
2322
+ config.api_key['Authorization'] = 'YOUR API KEY'
2323
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2324
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2325
+ end
2326
+
2327
+ api_instance = Ionoscloud::UserManagementApi.new
2328
+ user_id = 'user_id_example' # String | The unique ID of the user
2329
+ opts = {
2330
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2331
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2332
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2333
+ }
2334
+
2335
+ begin
2336
+ # Create a S3 key for the given user
2337
+ result = api_instance.um_users_s3keys_post(user_id, opts)
2338
+ p result
2339
+ rescue Ionoscloud::ApiError => e
2340
+ puts "Error when calling UserManagementApi->um_users_s3keys_post: #{e}"
2341
+ end
2342
+ ```
2343
+
2344
+ #### Using the um_users_s3keys_post_with_http_info variant
2345
+
2346
+ This returns an Array which contains the response data, status code and headers.
2347
+
2348
+ > <Array(<S3Key>, Integer, Hash)> um_users_s3keys_post_with_http_info(user_id, opts)
2349
+
2350
+ ```ruby
2351
+ begin
2352
+ # Create a S3 key for the given user
2353
+ data, status_code, headers = api_instance.um_users_s3keys_post_with_http_info(user_id, opts)
2354
+ p status_code # => 2xx
2355
+ p headers # => { ... }
2356
+ p data # => <S3Key>
2357
+ rescue Ionoscloud::ApiError => e
2358
+ puts "Error when calling UserManagementApi->um_users_s3keys_post_with_http_info: #{e}"
2359
+ end
2360
+ ```
2361
+
2362
+ ### Parameters
2363
+
2364
+ | Name | Type | Description | Notes |
2365
+ | ---- | ---- | ----------- | ----- |
2366
+ | **user_id** | **String** | The unique ID of the user | |
2367
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2368
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2369
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2370
+
2371
+ ### Return type
2372
+
2373
+ [**S3Key**](S3Key.md)
2374
+
2375
+ ### Authorization
2376
+
2377
+ Basic Authentication, Token Authentication
2378
+
2379
+ ### HTTP request headers
2380
+
2381
+ - **Content-Type**: Not defined
2382
+ - **Accept**: application/json
2383
+
2384
+
2385
+ ## um_users_s3keys_put
2386
+
2387
+ > <S3Key> um_users_s3keys_put(user_id, key_id, s3_key, opts)
2388
+
2389
+ Modify a S3 key having the given key id
2390
+
2391
+ You can enable or disable a given S3 key.
2392
+
2393
+ ### Examples
2394
+
2395
+ ```ruby
2396
+ require 'time'
2397
+ require 'ionoscloud'
2398
+ # setup authorization
2399
+ Ionoscloud.configure do |config|
2400
+ # Configure HTTP basic authorization: Basic Authentication
2401
+ config.username = 'YOUR USERNAME'
2402
+ config.password = 'YOUR PASSWORD'
2403
+
2404
+ # Configure API key authorization: Token Authentication
2405
+ config.api_key['Authorization'] = 'YOUR API KEY'
2406
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2407
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2408
+ end
2409
+
2410
+ api_instance = Ionoscloud::UserManagementApi.new
2411
+ user_id = 'user_id_example' # String |
2412
+ key_id = 'key_id_example' # String | The unique access key ID of the S3 key
2413
+ s3_key = Ionoscloud::S3Key.new({properties: Ionoscloud::S3KeyProperties.new}) # S3Key | Modified S3 key
2414
+ opts = {
2415
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2416
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2417
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2418
+ }
2419
+
2420
+ begin
2421
+ # Modify a S3 key having the given key id
2422
+ result = api_instance.um_users_s3keys_put(user_id, key_id, s3_key, opts)
2423
+ p result
2424
+ rescue Ionoscloud::ApiError => e
2425
+ puts "Error when calling UserManagementApi->um_users_s3keys_put: #{e}"
2426
+ end
2427
+ ```
2428
+
2429
+ #### Using the um_users_s3keys_put_with_http_info variant
2430
+
2431
+ This returns an Array which contains the response data, status code and headers.
2432
+
2433
+ > <Array(<S3Key>, Integer, Hash)> um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
2434
+
2435
+ ```ruby
2436
+ begin
2437
+ # Modify a S3 key having the given key id
2438
+ data, status_code, headers = api_instance.um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
2439
+ p status_code # => 2xx
2440
+ p headers # => { ... }
2441
+ p data # => <S3Key>
2442
+ rescue Ionoscloud::ApiError => e
2443
+ puts "Error when calling UserManagementApi->um_users_s3keys_put_with_http_info: #{e}"
2444
+ end
2445
+ ```
2446
+
2447
+ ### Parameters
2448
+
2449
+ | Name | Type | Description | Notes |
2450
+ | ---- | ---- | ----------- | ----- |
2451
+ | **user_id** | **String** | | |
2452
+ | **key_id** | **String** | The unique access key ID of the S3 key | |
2453
+ | **s3_key** | [**S3Key**](S3Key.md) | Modified S3 key | |
2454
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2455
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2456
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2457
+
2458
+ ### Return type
2459
+
2460
+ [**S3Key**](S3Key.md)
2461
+
2462
+ ### Authorization
2463
+
2464
+ Basic Authentication, Token Authentication
2465
+
2466
+ ### HTTP request headers
2467
+
2468
+ - **Content-Type**: application/json
2469
+ - **Accept**: application/json
2470
+
2471
+
2472
+ ## um_users_s3ssourl_get
2473
+
2474
+ > <S3ObjectStorageSSO> um_users_s3ssourl_get(user_id, opts)
2475
+
2476
+ Retrieve S3 object storage single signon URL for the given user
2477
+
2478
+ You can retrieve S3 object storage single signon URL for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users.
2479
+
2480
+ ### Examples
2481
+
2482
+ ```ruby
2483
+ require 'time'
2484
+ require 'ionoscloud'
2485
+ # setup authorization
2486
+ Ionoscloud.configure do |config|
2487
+ # Configure HTTP basic authorization: Basic Authentication
2488
+ config.username = 'YOUR USERNAME'
2489
+ config.password = 'YOUR PASSWORD'
2490
+
2491
+ # Configure API key authorization: Token Authentication
2492
+ config.api_key['Authorization'] = 'YOUR API KEY'
2493
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2494
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2495
+ end
2496
+
2497
+ api_instance = Ionoscloud::UserManagementApi.new
2498
+ user_id = 'user_id_example' # String | The unique ID of the user
2499
+ opts = {
2500
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2501
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2502
+ }
2503
+
2504
+ begin
2505
+ # Retrieve S3 object storage single signon URL for the given user
2506
+ result = api_instance.um_users_s3ssourl_get(user_id, opts)
2507
+ p result
2508
+ rescue Ionoscloud::ApiError => e
2509
+ puts "Error when calling UserManagementApi->um_users_s3ssourl_get: #{e}"
2510
+ end
2511
+ ```
2512
+
2513
+ #### Using the um_users_s3ssourl_get_with_http_info variant
2514
+
2515
+ This returns an Array which contains the response data, status code and headers.
2516
+
2517
+ > <Array(<S3ObjectStorageSSO>, Integer, Hash)> um_users_s3ssourl_get_with_http_info(user_id, opts)
2518
+
2519
+ ```ruby
2520
+ begin
2521
+ # Retrieve S3 object storage single signon URL for the given user
2522
+ data, status_code, headers = api_instance.um_users_s3ssourl_get_with_http_info(user_id, opts)
2523
+ p status_code # => 2xx
2524
+ p headers # => { ... }
2525
+ p data # => <S3ObjectStorageSSO>
2526
+ rescue Ionoscloud::ApiError => e
2527
+ puts "Error when calling UserManagementApi->um_users_s3ssourl_get_with_http_info: #{e}"
2528
+ end
2529
+ ```
2530
+
2531
+ ### Parameters
2532
+
2533
+ | Name | Type | Description | Notes |
2534
+ | ---- | ---- | ----------- | ----- |
2535
+ | **user_id** | **String** | The unique ID of the user | |
2536
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2537
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2538
+
2539
+ ### Return type
2540
+
2541
+ [**S3ObjectStorageSSO**](S3ObjectStorageSSO.md)
2542
+
2543
+ ### Authorization
2544
+
2545
+ Basic Authentication, Token Authentication
2546
+
2547
+ ### HTTP request headers
2548
+
2549
+ - **Content-Type**: Not defined
2550
+ - **Accept**: application/json
2551
+