ionoscloud 6.0.0.beta.1 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (624) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +190 -0
  3. data/README.md +57 -0
  4. data/docs/README.md +64 -0
  5. data/docs/api/BackupUnitsApi.md +594 -0
  6. data/docs/{ContractResourcesApi.md → api/ContractResourcesApi.md} +12 -12
  7. data/docs/api/DataCentersApi.md +516 -0
  8. data/docs/api/DefaultApi.md +78 -0
  9. data/docs/{FirewallRulesApi.md → api/FirewallRulesApi.md} +131 -132
  10. data/docs/{FlowLogsApi.md → api/FlowLogsApi.md} +115 -116
  11. data/docs/api/IPBlocksApi.md +516 -0
  12. data/docs/api/ImagesApi.md +428 -0
  13. data/docs/{KubernetesApi.md → api/KubernetesApi.md} +266 -270
  14. data/docs/api/LANsApi.md +794 -0
  15. data/docs/api/LabelsApi.md +2338 -0
  16. data/docs/{LoadBalancersApi.md → api/LoadBalancersApi.md} +178 -188
  17. data/docs/api/LocationsApi.md +259 -0
  18. data/docs/{NATGatewaysApi.md → api/NATGatewaysApi.md} +317 -324
  19. data/docs/api/NetworkInterfacesApi.md +540 -0
  20. data/docs/{NetworkLoadBalancersApi.md → api/NetworkLoadBalancersApi.md} +333 -340
  21. data/docs/api/PrivateCrossConnectsApi.md +426 -0
  22. data/docs/api/RequestsApi.md +283 -0
  23. data/docs/api/ServersApi.md +1908 -0
  24. data/docs/api/SnapshotsApi.md +428 -0
  25. data/docs/{TemplatesApi.md → api/TemplatesApi.md} +18 -18
  26. data/docs/api/UserManagementApi.md +2039 -0
  27. data/docs/api/UserS3KeysApi.md +516 -0
  28. data/docs/api/VolumesApi.md +709 -0
  29. data/docs/{AttachedVolumes.md → models/AttachedVolumes.md} +6 -6
  30. data/docs/{BackupUnit.md → models/BackupUnit.md} +3 -3
  31. data/docs/{BackupUnitProperties.md → models/BackupUnitProperties.md} +2 -2
  32. data/docs/{BackupUnitSSO.md → models/BackupUnitSSO.md} +0 -0
  33. data/docs/{BackupUnits.md → models/BackupUnits.md} +4 -4
  34. data/docs/{BalancedNics.md → models/BalancedNics.md} +6 -6
  35. data/docs/{Cdroms.md → models/Cdroms.md} +6 -6
  36. data/docs/{ConnectableDatacenter.md → models/ConnectableDatacenter.md} +0 -0
  37. data/docs/{Contract.md → models/Contract.md} +1 -1
  38. data/docs/{ContractProperties.md → models/ContractProperties.md} +4 -4
  39. data/docs/{Contracts.md → models/Contracts.md} +3 -3
  40. data/docs/{CpuArchitectureProperties.md → models/CpuArchitectureProperties.md} +1 -1
  41. data/docs/{DataCenterEntities.md → models/DataCenterEntities.md} +0 -0
  42. data/docs/{Datacenter.md → models/Datacenter.md} +3 -3
  43. data/docs/{DatacenterElementMetadata.md → models/DatacenterElementMetadata.md} +6 -6
  44. data/docs/{DatacenterProperties.md → models/DatacenterProperties.md} +6 -6
  45. data/docs/{Datacenters.md → models/Datacenters.md} +6 -6
  46. data/docs/{Error.md → models/Error.md} +1 -1
  47. data/docs/{ErrorMessage.md → models/ErrorMessage.md} +3 -3
  48. data/docs/{FirewallRule.md → models/FirewallRule.md} +3 -3
  49. data/docs/{FirewallRules.md → models/FirewallRules.md} +6 -6
  50. data/docs/{FirewallruleProperties.md → models/FirewallruleProperties.md} +10 -10
  51. data/docs/{FlowLog.md → models/FlowLog.md} +3 -3
  52. data/docs/{FlowLogProperties.md → models/FlowLogProperties.md} +1 -1
  53. data/docs/{FlowLogPut.md → models/FlowLogPut.md} +3 -3
  54. data/docs/{FlowLogs.md → models/FlowLogs.md} +6 -6
  55. data/docs/{Group.md → models/Group.md} +3 -3
  56. data/docs/{GroupEntities.md → models/GroupEntities.md} +0 -0
  57. data/docs/{GroupMembers.md → models/GroupMembers.md} +4 -4
  58. data/docs/models/GroupProperties.md +42 -0
  59. data/docs/{GroupShare.md → models/GroupShare.md} +2 -2
  60. data/docs/{GroupShareProperties.md → models/GroupShareProperties.md} +0 -0
  61. data/docs/{GroupShares.md → models/GroupShares.md} +3 -3
  62. data/docs/{GroupUsers.md → models/GroupUsers.md} +4 -4
  63. data/docs/{Groups.md → models/Groups.md} +4 -4
  64. data/docs/{IPFailover.md → models/IPFailover.md} +0 -0
  65. data/docs/{Image.md → models/Image.md} +3 -3
  66. data/docs/models/ImageProperties.md +54 -0
  67. data/docs/{Images.md → models/Images.md} +4 -4
  68. data/docs/{Info.md → models/Info.md} +0 -0
  69. data/docs/{IpBlock.md → models/IpBlock.md} +3 -3
  70. data/docs/models/IpBlockProperties.md +26 -0
  71. data/docs/models/IpBlocks.md +30 -0
  72. data/docs/{IpConsumer.md → models/IpConsumer.md} +5 -1
  73. data/docs/{KubernetesAutoScaling.md → models/KubernetesAutoScaling.md} +0 -0
  74. data/docs/{KubernetesCluster.md → models/KubernetesCluster.md} +2 -2
  75. data/docs/{KubernetesClusterEntities.md → models/KubernetesClusterEntities.md} +0 -0
  76. data/docs/{KubernetesClusterForPost.md → models/KubernetesClusterForPost.md} +2 -2
  77. data/docs/{KubernetesClusterForPut.md → models/KubernetesClusterForPut.md} +2 -2
  78. data/docs/models/KubernetesClusterProperties.md +30 -0
  79. data/docs/models/KubernetesClusterPropertiesForPost.md +26 -0
  80. data/docs/models/KubernetesClusterPropertiesForPut.md +26 -0
  81. data/docs/{KubernetesClusters.md → models/KubernetesClusters.md} +4 -4
  82. data/docs/{KubernetesMaintenanceWindow.md → models/KubernetesMaintenanceWindow.md} +0 -0
  83. data/docs/{KubernetesNode.md → models/KubernetesNode.md} +2 -2
  84. data/docs/{KubernetesNodeMetadata.md → models/KubernetesNodeMetadata.md} +4 -4
  85. data/docs/{KubernetesNodePool.md → models/KubernetesNodePool.md} +2 -2
  86. data/docs/{KubernetesNodePoolForPost.md → models/KubernetesNodePoolForPost.md} +2 -2
  87. data/docs/{KubernetesNodePoolForPut.md → models/KubernetesNodePoolForPut.md} +2 -2
  88. data/docs/{KubernetesNodePoolLan.md → models/KubernetesNodePoolLan.md} +2 -2
  89. data/docs/{KubernetesNodePoolLanRoutes.md → models/KubernetesNodePoolLanRoutes.md} +0 -0
  90. data/docs/{KubernetesNodePoolProperties.md → models/KubernetesNodePoolProperties.md} +13 -14
  91. data/docs/{KubernetesNodePoolPropertiesForPost.md → models/KubernetesNodePoolPropertiesForPost.md} +12 -13
  92. data/docs/{KubernetesNodePoolPropertiesForPut.md → models/KubernetesNodePoolPropertiesForPut.md} +5 -5
  93. data/docs/{KubernetesNodePools.md → models/KubernetesNodePools.md} +4 -4
  94. data/docs/{KubernetesNodeProperties.md → models/KubernetesNodeProperties.md} +2 -2
  95. data/docs/{KubernetesNodes.md → models/KubernetesNodes.md} +4 -4
  96. data/docs/{Label.md → models/Label.md} +2 -2
  97. data/docs/{LabelProperties.md → models/LabelProperties.md} +3 -3
  98. data/docs/{LabelResource.md → models/LabelResource.md} +2 -2
  99. data/docs/{LabelResourceProperties.md → models/LabelResourceProperties.md} +2 -2
  100. data/docs/{LabelResources.md → models/LabelResources.md} +6 -6
  101. data/docs/{Labels.md → models/Labels.md} +4 -4
  102. data/docs/{Lan.md → models/Lan.md} +3 -3
  103. data/docs/{LanEntities.md → models/LanEntities.md} +0 -0
  104. data/docs/{LanNics.md → models/LanNics.md} +6 -6
  105. data/docs/{LanPost.md → models/LanPost.md} +3 -3
  106. data/docs/{LanProperties.md → models/LanProperties.md} +3 -3
  107. data/docs/{LanPropertiesPost.md → models/LanPropertiesPost.md} +3 -3
  108. data/docs/{Lans.md → models/Lans.md} +6 -6
  109. data/docs/{Loadbalancer.md → models/Loadbalancer.md} +3 -3
  110. data/docs/{LoadbalancerEntities.md → models/LoadbalancerEntities.md} +0 -0
  111. data/docs/{LoadbalancerProperties.md → models/LoadbalancerProperties.md} +3 -3
  112. data/docs/{Loadbalancers.md → models/Loadbalancers.md} +6 -6
  113. data/docs/{Location.md → models/Location.md} +3 -3
  114. data/docs/{LocationProperties.md → models/LocationProperties.md} +1 -1
  115. data/docs/{Locations.md → models/Locations.md} +4 -4
  116. data/docs/{NatGateway.md → models/NatGateway.md} +3 -3
  117. data/docs/{NatGatewayEntities.md → models/NatGatewayEntities.md} +0 -0
  118. data/docs/{NatGatewayLanProperties.md → models/NatGatewayLanProperties.md} +2 -2
  119. data/docs/{NatGatewayProperties.md → models/NatGatewayProperties.md} +3 -3
  120. data/docs/{NatGatewayPut.md → models/NatGatewayPut.md} +3 -3
  121. data/docs/{NatGatewayRule.md → models/NatGatewayRule.md} +3 -3
  122. data/docs/{NatGatewayRuleProperties.md → models/NatGatewayRuleProperties.md} +7 -7
  123. data/docs/{NatGatewayRuleProtocol.md → models/NatGatewayRuleProtocol.md} +0 -0
  124. data/docs/{NatGatewayRulePut.md → models/NatGatewayRulePut.md} +3 -3
  125. data/docs/{NatGatewayRuleType.md → models/NatGatewayRuleType.md} +0 -0
  126. data/docs/{NatGatewayRules.md → models/NatGatewayRules.md} +4 -4
  127. data/docs/{NatGateways.md → models/NatGateways.md} +6 -6
  128. data/docs/{NetworkLoadBalancer.md → models/NetworkLoadBalancer.md} +3 -3
  129. data/docs/{NetworkLoadBalancerEntities.md → models/NetworkLoadBalancerEntities.md} +0 -0
  130. data/docs/{NetworkLoadBalancerForwardingRule.md → models/NetworkLoadBalancerForwardingRule.md} +3 -3
  131. data/docs/{NetworkLoadBalancerForwardingRuleHealthCheck.md → models/NetworkLoadBalancerForwardingRuleHealthCheck.md} +0 -2
  132. data/docs/{NetworkLoadBalancerForwardingRuleProperties.md → models/NetworkLoadBalancerForwardingRuleProperties.md} +3 -3
  133. data/docs/{NetworkLoadBalancerForwardingRulePut.md → models/NetworkLoadBalancerForwardingRulePut.md} +3 -3
  134. data/docs/{NetworkLoadBalancerForwardingRuleTarget.md → models/NetworkLoadBalancerForwardingRuleTarget.md} +0 -0
  135. data/docs/{NetworkLoadBalancerForwardingRuleTargetHealthCheck.md → models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md} +0 -0
  136. data/docs/{NetworkLoadBalancerForwardingRules.md → models/NetworkLoadBalancerForwardingRules.md} +6 -6
  137. data/docs/{NetworkLoadBalancerProperties.md → models/NetworkLoadBalancerProperties.md} +4 -4
  138. data/docs/{NetworkLoadBalancerPut.md → models/NetworkLoadBalancerPut.md} +3 -3
  139. data/docs/{NetworkLoadBalancers.md → models/NetworkLoadBalancers.md} +6 -6
  140. data/docs/{Nic.md → models/Nic.md} +3 -3
  141. data/docs/{NicEntities.md → models/NicEntities.md} +0 -0
  142. data/docs/models/NicProperties.md +34 -0
  143. data/docs/{NicPut.md → models/NicPut.md} +3 -3
  144. data/docs/{Nics.md → models/Nics.md} +6 -6
  145. data/docs/{NoStateMetaData.md → models/NoStateMetaData.md} +5 -5
  146. data/docs/{PaginationLinks.md → models/PaginationLinks.md} +3 -3
  147. data/docs/{Peer.md → models/Peer.md} +0 -0
  148. data/docs/{PrivateCrossConnect.md → models/PrivateCrossConnect.md} +3 -3
  149. data/docs/{PrivateCrossConnectProperties.md → models/PrivateCrossConnectProperties.md} +4 -4
  150. data/docs/{PrivateCrossConnects.md → models/PrivateCrossConnects.md} +4 -4
  151. data/docs/{RemoteConsoleUrl.md → models/RemoteConsoleUrl.md} +0 -0
  152. data/docs/{Request.md → models/Request.md} +3 -3
  153. data/docs/{RequestMetadata.md → models/RequestMetadata.md} +2 -2
  154. data/docs/{RequestProperties.md → models/RequestProperties.md} +0 -0
  155. data/docs/{RequestStatus.md → models/RequestStatus.md} +3 -3
  156. data/docs/{RequestStatusMetadata.md → models/RequestStatusMetadata.md} +1 -1
  157. data/docs/{RequestTarget.md → models/RequestTarget.md} +0 -0
  158. data/docs/{Requests.md → models/Requests.md} +6 -6
  159. data/docs/{Resource.md → models/Resource.md} +3 -3
  160. data/docs/{ResourceEntities.md → models/ResourceEntities.md} +0 -0
  161. data/docs/{ResourceGroups.md → models/ResourceGroups.md} +4 -4
  162. data/docs/models/ResourceLimits.md +60 -0
  163. data/docs/{ResourceProperties.md → models/ResourceProperties.md} +2 -2
  164. data/docs/{ResourceReference.md → models/ResourceReference.md} +3 -3
  165. data/docs/{Resources.md → models/Resources.md} +4 -4
  166. data/docs/{ResourcesUsers.md → models/ResourcesUsers.md} +4 -4
  167. data/docs/models/S3Bucket.md +18 -0
  168. data/docs/{S3Key.md → models/S3Key.md} +3 -3
  169. data/docs/{S3KeyMetadata.md → models/S3KeyMetadata.md} +2 -2
  170. data/docs/{S3KeyProperties.md → models/S3KeyProperties.md} +2 -2
  171. data/docs/{S3Keys.md → models/S3Keys.md} +4 -4
  172. data/docs/{S3ObjectStorageSSO.md → models/S3ObjectStorageSSO.md} +0 -0
  173. data/docs/{Server.md → models/Server.md} +3 -3
  174. data/docs/{ServerEntities.md → models/ServerEntities.md} +0 -0
  175. data/docs/{ServerProperties.md → models/ServerProperties.md} +7 -7
  176. data/docs/{Servers.md → models/Servers.md} +6 -6
  177. data/docs/{Snapshot.md → models/Snapshot.md} +3 -3
  178. data/docs/models/SnapshotProperties.md +48 -0
  179. data/docs/{Snapshots.md → models/Snapshots.md} +4 -4
  180. data/docs/{TargetPortRange.md → models/TargetPortRange.md} +2 -2
  181. data/docs/{Template.md → models/Template.md} +3 -3
  182. data/docs/{TemplateProperties.md → models/TemplateProperties.md} +4 -4
  183. data/docs/{Templates.md → models/Templates.md} +4 -4
  184. data/docs/{Token.md → models/Token.md} +1 -1
  185. data/docs/{Type.md → models/Type.md} +0 -0
  186. data/docs/{User.md → models/User.md} +3 -3
  187. data/docs/{UserMetadata.md → models/UserMetadata.md} +3 -3
  188. data/docs/{UserPost.md → models/UserPost.md} +0 -0
  189. data/docs/models/UserProperties.md +32 -0
  190. data/docs/models/UserPropertiesPost.md +32 -0
  191. data/docs/models/UserPropertiesPut.md +32 -0
  192. data/docs/{UserPut.md → models/UserPut.md} +1 -1
  193. data/docs/models/Users.md +30 -0
  194. data/docs/{UsersEntities.md → models/UsersEntities.md} +0 -0
  195. data/docs/{Volume.md → models/Volume.md} +3 -3
  196. data/docs/{VolumeProperties.md → models/VolumeProperties.md} +19 -17
  197. data/docs/{Volumes.md → models/Volumes.md} +6 -6
  198. data/docs/summary.md +192 -382
  199. data/ionoscloud.gemspec +3 -3
  200. data/lib/ionoscloud/api/_api.rb +8 -8
  201. data/lib/ionoscloud/api/backup_units_api.rb +98 -98
  202. data/lib/ionoscloud/api/contract_resources_api.rb +12 -12
  203. data/lib/ionoscloud/api/data_centers_api.rb +85 -85
  204. data/lib/ionoscloud/api/firewall_rules_api.rb +121 -121
  205. data/lib/ionoscloud/api/flow_logs_api.rb +107 -107
  206. data/lib/ionoscloud/api/images_api.rb +69 -69
  207. data/lib/ionoscloud/api/ip_blocks_api.rb +99 -81
  208. data/lib/ionoscloud/api/kubernetes_api.rb +237 -237
  209. data/lib/ionoscloud/api/labels_api.rb +419 -455
  210. data/lib/ionoscloud/api/lans_api.rb +220 -220
  211. data/lib/ionoscloud/api/load_balancers_api.rb +162 -198
  212. data/lib/ionoscloud/api/locations_api.rb +38 -38
  213. data/lib/ionoscloud/api/nat_gateways_api.rb +287 -305
  214. data/lib/ionoscloud/api/network_interfaces_api.rb +109 -109
  215. data/lib/ionoscloud/api/network_load_balancers_api.rb +301 -319
  216. data/lib/ionoscloud/api/private_cross_connects_api.rb +67 -85
  217. data/lib/ionoscloud/api/requests_api.rb +70 -46
  218. data/lib/ionoscloud/api/servers_api.rb +381 -381
  219. data/lib/ionoscloud/api/snapshots_api.rb +67 -67
  220. data/lib/ionoscloud/api/templates_api.rb +16 -16
  221. data/lib/ionoscloud/api/user_management_api.rb +350 -330
  222. data/lib/ionoscloud/api/user_s3_keys_api.rb +85 -85
  223. data/lib/ionoscloud/api/volumes_api.rb +140 -140
  224. data/lib/ionoscloud/api_client.rb +20 -20
  225. data/lib/ionoscloud/api_error.rb +2 -2
  226. data/lib/ionoscloud/configuration.rb +4 -4
  227. data/lib/ionoscloud/models/attached_volumes.rb +75 -19
  228. data/lib/ionoscloud/models/backup_unit.rb +52 -10
  229. data/lib/ionoscloud/models/backup_unit_properties.rb +33 -7
  230. data/lib/ionoscloud/models/backup_unit_sso.rb +13 -3
  231. data/lib/ionoscloud/models/backup_units.rb +48 -16
  232. data/lib/ionoscloud/models/balanced_nics.rb +75 -19
  233. data/lib/ionoscloud/models/cdroms.rb +75 -19
  234. data/lib/ionoscloud/models/connectable_datacenter.rb +31 -5
  235. data/lib/ionoscloud/models/contract.rb +23 -5
  236. data/lib/ionoscloud/models/contract_properties.rb +53 -11
  237. data/lib/ionoscloud/models/contracts.rb +45 -13
  238. data/lib/ionoscloud/models/cpu_architecture_properties.rb +41 -7
  239. data/lib/ionoscloud/models/data_center_entities.rb +58 -8
  240. data/lib/ionoscloud/models/datacenter.rb +61 -11
  241. data/lib/ionoscloud/models/datacenter_element_metadata.rb +82 -16
  242. data/lib/ionoscloud/models/datacenter_properties.rb +77 -45
  243. data/lib/ionoscloud/models/datacenters.rb +75 -19
  244. data/lib/ionoscloud/models/error.rb +25 -9
  245. data/lib/ionoscloud/models/error_message.rb +24 -6
  246. data/lib/ionoscloud/models/firewall_rule.rb +52 -10
  247. data/lib/ionoscloud/models/firewall_rules.rb +75 -19
  248. data/lib/ionoscloud/models/firewallrule_properties.rb +140 -43
  249. data/lib/ionoscloud/models/flow_log.rb +52 -10
  250. data/lib/ionoscloud/models/flow_log_properties.rb +41 -7
  251. data/lib/ionoscloud/models/flow_log_put.rb +43 -9
  252. data/lib/ionoscloud/models/flow_logs.rb +75 -19
  253. data/lib/ionoscloud/models/group.rb +52 -10
  254. data/lib/ionoscloud/models/group_entities.rb +22 -4
  255. data/lib/ionoscloud/models/group_members.rb +46 -14
  256. data/lib/ionoscloud/models/group_properties.rb +144 -28
  257. data/lib/ionoscloud/models/group_share.rb +42 -8
  258. data/lib/ionoscloud/models/group_share_properties.rb +22 -4
  259. data/lib/ionoscloud/models/group_shares.rb +45 -13
  260. data/lib/ionoscloud/models/group_users.rb +47 -15
  261. data/lib/ionoscloud/models/groups.rb +46 -14
  262. data/lib/ionoscloud/models/image.rb +52 -10
  263. data/lib/ionoscloud/models/image_properties.rb +226 -40
  264. data/lib/ionoscloud/models/images.rb +46 -14
  265. data/lib/ionoscloud/models/info.rb +31 -5
  266. data/lib/ionoscloud/models/ip_block.rb +52 -10
  267. data/lib/ionoscloud/models/ip_block_properties.rb +58 -20
  268. data/lib/ionoscloud/models/ip_blocks.rb +101 -16
  269. data/lib/ionoscloud/models/ip_consumer.rb +104 -12
  270. data/lib/ionoscloud/models/ip_failover.rb +22 -4
  271. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +22 -4
  272. data/lib/ionoscloud/models/kubernetes_cluster.rb +60 -10
  273. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +13 -3
  274. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +60 -10
  275. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +60 -10
  276. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +86 -34
  277. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +64 -24
  278. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +72 -10
  279. data/lib/ionoscloud/models/kubernetes_clusters.rb +46 -14
  280. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +22 -4
  281. data/lib/ionoscloud/models/kubernetes_node.rb +51 -9
  282. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +53 -11
  283. data/lib/ionoscloud/models/kubernetes_node_pool.rb +51 -9
  284. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +51 -9
  285. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +51 -9
  286. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +39 -10
  287. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +22 -4
  288. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +182 -54
  289. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +170 -48
  290. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +97 -36
  291. data/lib/ionoscloud/models/kubernetes_node_pools.rb +46 -14
  292. data/lib/ionoscloud/models/kubernetes_node_properties.rb +42 -8
  293. data/lib/ionoscloud/models/kubernetes_nodes.rb +46 -14
  294. data/lib/ionoscloud/models/label.rb +51 -9
  295. data/lib/ionoscloud/models/label_properties.rb +52 -10
  296. data/lib/ionoscloud/models/label_resource.rb +51 -9
  297. data/lib/ionoscloud/models/label_resource_properties.rb +24 -6
  298. data/lib/ionoscloud/models/label_resources.rb +77 -21
  299. data/lib/ionoscloud/models/labels.rb +48 -16
  300. data/lib/ionoscloud/models/lan.rb +61 -11
  301. data/lib/ionoscloud/models/lan_entities.rb +13 -3
  302. data/lib/ionoscloud/models/lan_nics.rb +75 -19
  303. data/lib/ionoscloud/models/lan_post.rb +61 -11
  304. data/lib/ionoscloud/models/lan_properties.rb +45 -13
  305. data/lib/ionoscloud/models/lan_properties_post.rb +45 -13
  306. data/lib/ionoscloud/models/lans.rb +75 -19
  307. data/lib/ionoscloud/models/loadbalancer.rb +61 -11
  308. data/lib/ionoscloud/models/loadbalancer_entities.rb +13 -3
  309. data/lib/ionoscloud/models/loadbalancer_properties.rb +46 -37
  310. data/lib/ionoscloud/models/loadbalancers.rb +75 -19
  311. data/lib/ionoscloud/models/location.rb +52 -10
  312. data/lib/ionoscloud/models/location_properties.rb +47 -41
  313. data/lib/ionoscloud/models/locations.rb +46 -14
  314. data/lib/ionoscloud/models/nat_gateway.rb +61 -11
  315. data/lib/ionoscloud/models/nat_gateway_entities.rb +22 -4
  316. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +26 -10
  317. data/lib/ionoscloud/models/nat_gateway_properties.rb +38 -16
  318. data/lib/ionoscloud/models/nat_gateway_put.rb +43 -9
  319. data/lib/ionoscloud/models/nat_gateway_rule.rb +52 -10
  320. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +73 -15
  321. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +2 -2
  322. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +43 -9
  323. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +2 -2
  324. data/lib/ionoscloud/models/nat_gateway_rules.rb +46 -14
  325. data/lib/ionoscloud/models/nat_gateways.rb +75 -19
  326. data/lib/ionoscloud/models/network_load_balancer.rb +61 -11
  327. data/lib/ionoscloud/models/network_load_balancer_entities.rb +22 -4
  328. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +52 -10
  329. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +39 -15
  330. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +73 -17
  331. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +43 -9
  332. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +40 -6
  333. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +31 -5
  334. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +75 -19
  335. data/lib/ionoscloud/models/network_load_balancer_properties.rb +57 -19
  336. data/lib/ionoscloud/models/network_load_balancer_put.rb +43 -9
  337. data/lib/ionoscloud/models/network_load_balancers.rb +75 -19
  338. data/lib/ionoscloud/models/nic.rb +61 -11
  339. data/lib/ionoscloud/models/nic_entities.rb +22 -4
  340. data/lib/ionoscloud/models/nic_properties.rb +95 -23
  341. data/lib/ionoscloud/models/nic_put.rb +43 -9
  342. data/lib/ionoscloud/models/nics.rb +75 -19
  343. data/lib/ionoscloud/models/no_state_meta_data.rb +72 -14
  344. data/lib/ionoscloud/models/pagination_links.rb +34 -8
  345. data/lib/ionoscloud/models/peer.rb +49 -7
  346. data/lib/ionoscloud/models/private_cross_connect.rb +52 -10
  347. data/lib/ionoscloud/models/private_cross_connect_properties.rb +48 -18
  348. data/lib/ionoscloud/models/private_cross_connects.rb +46 -14
  349. data/lib/ionoscloud/models/remote_console_url.rb +13 -3
  350. data/lib/ionoscloud/models/request.rb +52 -10
  351. data/lib/ionoscloud/models/request_metadata.rb +42 -8
  352. data/lib/ionoscloud/models/request_properties.rb +42 -10
  353. data/lib/ionoscloud/models/request_status.rb +43 -9
  354. data/lib/ionoscloud/models/request_status_metadata.rb +43 -11
  355. data/lib/ionoscloud/models/request_target.rb +22 -4
  356. data/lib/ionoscloud/models/requests.rb +75 -19
  357. data/lib/ionoscloud/models/resource.rb +61 -11
  358. data/lib/ionoscloud/models/resource_entities.rb +13 -3
  359. data/lib/ionoscloud/models/resource_groups.rb +46 -14
  360. data/lib/ionoscloud/models/resource_limits.rb +224 -46
  361. data/lib/ionoscloud/models/resource_properties.rb +24 -6
  362. data/lib/ionoscloud/models/resource_reference.rb +34 -8
  363. data/lib/ionoscloud/models/resources.rb +47 -15
  364. data/lib/ionoscloud/models/resources_users.rb +46 -14
  365. data/lib/ionoscloud/models/s3_bucket.rb +232 -0
  366. data/lib/ionoscloud/models/s3_key.rb +52 -10
  367. data/lib/ionoscloud/models/s3_key_metadata.rb +24 -6
  368. data/lib/ionoscloud/models/s3_key_properties.rb +24 -6
  369. data/lib/ionoscloud/models/s3_keys.rb +46 -14
  370. data/lib/ionoscloud/models/s3_object_storage_sso.rb +13 -3
  371. data/lib/ionoscloud/models/server.rb +61 -11
  372. data/lib/ionoscloud/models/server_entities.rb +31 -5
  373. data/lib/ionoscloud/models/server_properties.rb +103 -21
  374. data/lib/ionoscloud/models/servers.rb +75 -19
  375. data/lib/ionoscloud/models/snapshot.rb +52 -10
  376. data/lib/ionoscloud/models/snapshot_properties.rb +162 -32
  377. data/lib/ionoscloud/models/snapshots.rb +46 -14
  378. data/lib/ionoscloud/models/target_port_range.rb +24 -6
  379. data/lib/ionoscloud/models/template.rb +52 -10
  380. data/lib/ionoscloud/models/template_properties.rb +44 -10
  381. data/lib/ionoscloud/models/templates.rb +46 -14
  382. data/lib/ionoscloud/models/token.rb +14 -4
  383. data/lib/ionoscloud/models/type.rb +4 -4
  384. data/lib/ionoscloud/models/user.rb +61 -11
  385. data/lib/ionoscloud/models/user_metadata.rb +34 -8
  386. data/lib/ionoscloud/models/user_post.rb +13 -3
  387. data/lib/ionoscloud/models/user_properties.rb +84 -18
  388. data/lib/ionoscloud/models/user_properties_post.rb +84 -18
  389. data/lib/ionoscloud/models/user_properties_put.rb +93 -17
  390. data/lib/ionoscloud/models/user_put.rb +23 -5
  391. data/lib/ionoscloud/models/users.rb +102 -17
  392. data/lib/ionoscloud/models/users_entities.rb +22 -4
  393. data/lib/ionoscloud/models/volume.rb +52 -10
  394. data/lib/ionoscloud/models/volume_properties.rb +216 -47
  395. data/lib/ionoscloud/models/volumes.rb +75 -19
  396. data/lib/ionoscloud/version.rb +3 -3
  397. data/lib/ionoscloud.rb +4 -3
  398. data/sonar-project.properties +12 -0
  399. data/spec/api_client_spec.rb +2 -2
  400. data/spec/configuration_spec.rb +2 -2
  401. data/spec/spec_helper.rb +2 -2
  402. metadata +207 -587
  403. data/docs/BackupUnitsApi.md +0 -595
  404. data/docs/DataCentersApi.md +0 -517
  405. data/docs/DefaultApi.md +0 -78
  406. data/docs/GroupProperties.md +0 -40
  407. data/docs/IPBlocksApi.md +0 -513
  408. data/docs/ImageProperties.md +0 -50
  409. data/docs/ImagesApi.md +0 -429
  410. data/docs/IpBlockProperties.md +0 -26
  411. data/docs/IpBlocks.md +0 -24
  412. data/docs/KubernetesClusterProperties.md +0 -30
  413. data/docs/KubernetesClusterPropertiesForPost.md +0 -26
  414. data/docs/KubernetesClusterPropertiesForPut.md +0 -22
  415. data/docs/LabelsApi.md +0 -2351
  416. data/docs/LansApi.md +0 -795
  417. data/docs/LocationsApi.md +0 -259
  418. data/docs/NetworkInterfacesApi.md +0 -541
  419. data/docs/NicProperties.md +0 -34
  420. data/docs/PrivateCrossConnectsApi.md +0 -431
  421. data/docs/RequestsApi.md +0 -267
  422. data/docs/ResourceLimits.md +0 -60
  423. data/docs/ServersApi.md +0 -1917
  424. data/docs/SnapshotProperties.md +0 -48
  425. data/docs/SnapshotsApi.md +0 -429
  426. data/docs/UserManagementApi.md +0 -2037
  427. data/docs/UserProperties.md +0 -32
  428. data/docs/UserPropertiesPost.md +0 -32
  429. data/docs/UserPropertiesPut.md +0 -30
  430. data/docs/UserS3KeysApi.md +0 -517
  431. data/docs/Users.md +0 -24
  432. data/docs/VolumesApi.md +0 -711
  433. data/spec/api/_api_spec.rb +0 -49
  434. data/spec/api/backup_units_api_spec.rb +0 -140
  435. data/spec/api/contract_resources_api_spec.rb +0 -49
  436. data/spec/api/data_centers_api_spec.rb +0 -128
  437. data/spec/api/firewall_rules_api_spec.rb +0 -146
  438. data/spec/api/flow_logs_api_spec.rb +0 -140
  439. data/spec/api/images_api_spec.rb +0 -111
  440. data/spec/api/ip_blocks_api_spec.rb +0 -126
  441. data/spec/api/kubernetes_api_spec.rb +0 -294
  442. data/spec/api/labels_api_spec.rb +0 -478
  443. data/spec/api/lans_api_spec.rb +0 -186
  444. data/spec/api/load_balancers_api_spec.rb +0 -205
  445. data/spec/api/locations_api_spec.rb +0 -80
  446. data/spec/api/nat_gateways_api_spec.rb +0 -336
  447. data/spec/api/network_interfaces_api_spec.rb +0 -140
  448. data/spec/api/network_load_balancers_api_spec.rb +0 -342
  449. data/spec/api/private_cross_connects_api_spec.rb +0 -112
  450. data/spec/api/requests_api_spec.rb +0 -84
  451. data/spec/api/servers_api_spec.rb +0 -401
  452. data/spec/api/snapshots_api_spec.rb +0 -111
  453. data/spec/api/templates_api_spec.rb +0 -60
  454. data/spec/api/user_management_api_spec.rb +0 -402
  455. data/spec/api/user_s3_keys_api_spec.rb +0 -128
  456. data/spec/api/volumes_api_spec.rb +0 -171
  457. data/spec/models/attached_volumes_spec.rb +0 -70
  458. data/spec/models/backup_unit_properties_spec.rb +0 -46
  459. data/spec/models/backup_unit_spec.rb +0 -62
  460. data/spec/models/backup_unit_sso_spec.rb +0 -34
  461. data/spec/models/backup_units_spec.rb +0 -56
  462. data/spec/models/balanced_nics_spec.rb +0 -70
  463. data/spec/models/cdroms_spec.rb +0 -70
  464. data/spec/models/connectable_datacenter_spec.rb +0 -46
  465. data/spec/models/contract_properties_spec.rb +0 -58
  466. data/spec/models/contract_spec.rb +0 -40
  467. data/spec/models/contracts_spec.rb +0 -52
  468. data/spec/models/cpu_architecture_properties_spec.rb +0 -52
  469. data/spec/models/data_center_entities_spec.rb +0 -64
  470. data/spec/models/datacenter_element_metadata_spec.rb +0 -80
  471. data/spec/models/datacenter_properties_spec.rb +0 -74
  472. data/spec/models/datacenter_spec.rb +0 -64
  473. data/spec/models/datacenters_spec.rb +0 -70
  474. data/spec/models/error_message_spec.rb +0 -40
  475. data/spec/models/error_spec.rb +0 -40
  476. data/spec/models/firewall_rule_spec.rb +0 -58
  477. data/spec/models/firewall_rules_spec.rb +0 -70
  478. data/spec/models/firewallrule_properties_spec.rb +0 -108
  479. data/spec/models/flow_log_properties_spec.rb +0 -60
  480. data/spec/models/flow_log_put_spec.rb +0 -52
  481. data/spec/models/flow_log_spec.rb +0 -58
  482. data/spec/models/flow_logs_spec.rb +0 -70
  483. data/spec/models/group_entities_spec.rb +0 -40
  484. data/spec/models/group_members_spec.rb +0 -52
  485. data/spec/models/group_properties_spec.rb +0 -100
  486. data/spec/models/group_share_properties_spec.rb +0 -40
  487. data/spec/models/group_share_spec.rb +0 -52
  488. data/spec/models/group_shares_spec.rb +0 -52
  489. data/spec/models/group_spec.rb +0 -58
  490. data/spec/models/group_users_spec.rb +0 -52
  491. data/spec/models/groups_spec.rb +0 -52
  492. data/spec/models/image_properties_spec.rb +0 -138
  493. data/spec/models/image_spec.rb +0 -58
  494. data/spec/models/images_spec.rb +0 -52
  495. data/spec/models/info_spec.rb +0 -46
  496. data/spec/models/ip_block_properties_spec.rb +0 -58
  497. data/spec/models/ip_block_spec.rb +0 -58
  498. data/spec/models/ip_blocks_spec.rb +0 -52
  499. data/spec/models/ip_consumer_spec.rb +0 -70
  500. data/spec/models/ip_failover_spec.rb +0 -40
  501. data/spec/models/kubernetes_auto_scaling_spec.rb +0 -40
  502. data/spec/models/kubernetes_cluster_entities_spec.rb +0 -34
  503. data/spec/models/kubernetes_cluster_for_post_spec.rb +0 -68
  504. data/spec/models/kubernetes_cluster_for_put_spec.rb +0 -68
  505. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +0 -58
  506. data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +0 -46
  507. data/spec/models/kubernetes_cluster_properties_spec.rb +0 -70
  508. data/spec/models/kubernetes_cluster_spec.rb +0 -68
  509. data/spec/models/kubernetes_clusters_spec.rb +0 -56
  510. data/spec/models/kubernetes_maintenance_window_spec.rb +0 -44
  511. data/spec/models/kubernetes_node_metadata_spec.rb +0 -62
  512. data/spec/models/kubernetes_node_pool_for_post_spec.rb +0 -62
  513. data/spec/models/kubernetes_node_pool_for_put_spec.rb +0 -62
  514. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +0 -40
  515. data/spec/models/kubernetes_node_pool_lan_spec.rb +0 -46
  516. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +0 -132
  517. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +0 -82
  518. data/spec/models/kubernetes_node_pool_properties_spec.rb +0 -138
  519. data/spec/models/kubernetes_node_pool_spec.rb +0 -62
  520. data/spec/models/kubernetes_node_pools_spec.rb +0 -56
  521. data/spec/models/kubernetes_node_properties_spec.rb +0 -52
  522. data/spec/models/kubernetes_node_spec.rb +0 -62
  523. data/spec/models/kubernetes_nodes_spec.rb +0 -56
  524. data/spec/models/label_properties_spec.rb +0 -58
  525. data/spec/models/label_resource_properties_spec.rb +0 -40
  526. data/spec/models/label_resource_spec.rb +0 -62
  527. data/spec/models/label_resources_spec.rb +0 -74
  528. data/spec/models/label_spec.rb +0 -62
  529. data/spec/models/labels_spec.rb +0 -56
  530. data/spec/models/lan_entities_spec.rb +0 -34
  531. data/spec/models/lan_nics_spec.rb +0 -70
  532. data/spec/models/lan_post_spec.rb +0 -64
  533. data/spec/models/lan_properties_post_spec.rb +0 -52
  534. data/spec/models/lan_properties_spec.rb +0 -52
  535. data/spec/models/lan_spec.rb +0 -64
  536. data/spec/models/lans_spec.rb +0 -70
  537. data/spec/models/loadbalancer_entities_spec.rb +0 -34
  538. data/spec/models/loadbalancer_properties_spec.rb +0 -50
  539. data/spec/models/loadbalancer_spec.rb +0 -64
  540. data/spec/models/loadbalancers_spec.rb +0 -70
  541. data/spec/models/location_properties_spec.rb +0 -56
  542. data/spec/models/location_spec.rb +0 -58
  543. data/spec/models/locations_spec.rb +0 -52
  544. data/spec/models/nat_gateway_entities_spec.rb +0 -40
  545. data/spec/models/nat_gateway_lan_properties_spec.rb +0 -40
  546. data/spec/models/nat_gateway_properties_spec.rb +0 -46
  547. data/spec/models/nat_gateway_put_spec.rb +0 -52
  548. data/spec/models/nat_gateway_rule_properties_spec.rb +0 -70
  549. data/spec/models/nat_gateway_rule_protocol_spec.rb +0 -28
  550. data/spec/models/nat_gateway_rule_put_spec.rb +0 -52
  551. data/spec/models/nat_gateway_rule_spec.rb +0 -58
  552. data/spec/models/nat_gateway_rule_type_spec.rb +0 -28
  553. data/spec/models/nat_gateway_rules_spec.rb +0 -52
  554. data/spec/models/nat_gateway_spec.rb +0 -64
  555. data/spec/models/nat_gateways_spec.rb +0 -70
  556. data/spec/models/network_load_balancer_entities_spec.rb +0 -40
  557. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +0 -58
  558. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +0 -78
  559. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +0 -52
  560. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +0 -58
  561. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +0 -46
  562. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +0 -52
  563. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +0 -70
  564. data/spec/models/network_load_balancer_properties_spec.rb +0 -58
  565. data/spec/models/network_load_balancer_put_spec.rb +0 -52
  566. data/spec/models/network_load_balancer_spec.rb +0 -64
  567. data/spec/models/network_load_balancers_spec.rb +0 -70
  568. data/spec/models/nic_entities_spec.rb +0 -40
  569. data/spec/models/nic_properties_spec.rb +0 -86
  570. data/spec/models/nic_put_spec.rb +0 -52
  571. data/spec/models/nic_spec.rb +0 -64
  572. data/spec/models/nics_spec.rb +0 -70
  573. data/spec/models/no_state_meta_data_spec.rb +0 -70
  574. data/spec/models/pagination_links_spec.rb +0 -46
  575. data/spec/models/peer_spec.rb +0 -58
  576. data/spec/models/private_cross_connect_properties_spec.rb +0 -52
  577. data/spec/models/private_cross_connect_spec.rb +0 -58
  578. data/spec/models/private_cross_connects_spec.rb +0 -52
  579. data/spec/models/remote_console_url_spec.rb +0 -34
  580. data/spec/models/request_metadata_spec.rb +0 -52
  581. data/spec/models/request_properties_spec.rb +0 -52
  582. data/spec/models/request_spec.rb +0 -58
  583. data/spec/models/request_status_metadata_spec.rb +0 -56
  584. data/spec/models/request_status_spec.rb +0 -52
  585. data/spec/models/request_target_spec.rb +0 -44
  586. data/spec/models/requests_spec.rb +0 -70
  587. data/spec/models/resource_entities_spec.rb +0 -34
  588. data/spec/models/resource_groups_spec.rb +0 -52
  589. data/spec/models/resource_limits_spec.rb +0 -160
  590. data/spec/models/resource_properties_spec.rb +0 -40
  591. data/spec/models/resource_reference_spec.rb +0 -46
  592. data/spec/models/resource_spec.rb +0 -64
  593. data/spec/models/resources_spec.rb +0 -52
  594. data/spec/models/resources_users_spec.rb +0 -52
  595. data/spec/models/s3_key_metadata_spec.rb +0 -40
  596. data/spec/models/s3_key_properties_spec.rb +0 -40
  597. data/spec/models/s3_key_spec.rb +0 -58
  598. data/spec/models/s3_keys_spec.rb +0 -52
  599. data/spec/models/s3_object_storage_sso_spec.rb +0 -34
  600. data/spec/models/server_entities_spec.rb +0 -46
  601. data/spec/models/server_properties_spec.rb +0 -96
  602. data/spec/models/server_spec.rb +0 -64
  603. data/spec/models/servers_spec.rb +0 -70
  604. data/spec/models/snapshot_properties_spec.rb +0 -128
  605. data/spec/models/snapshot_spec.rb +0 -58
  606. data/spec/models/snapshots_spec.rb +0 -52
  607. data/spec/models/target_port_range_spec.rb +0 -40
  608. data/spec/models/template_properties_spec.rb +0 -52
  609. data/spec/models/template_spec.rb +0 -58
  610. data/spec/models/templates_spec.rb +0 -52
  611. data/spec/models/token_spec.rb +0 -34
  612. data/spec/models/type_spec.rb +0 -28
  613. data/spec/models/user_metadata_spec.rb +0 -46
  614. data/spec/models/user_post_spec.rb +0 -34
  615. data/spec/models/user_properties_post_spec.rb +0 -76
  616. data/spec/models/user_properties_put_spec.rb +0 -70
  617. data/spec/models/user_properties_spec.rb +0 -76
  618. data/spec/models/user_put_spec.rb +0 -40
  619. data/spec/models/user_spec.rb +0 -64
  620. data/spec/models/users_entities_spec.rb +0 -40
  621. data/spec/models/users_spec.rb +0 -52
  622. data/spec/models/volume_properties_spec.rb +0 -158
  623. data/spec/models/volume_spec.rb +0 -58
  624. data/spec/models/volumes_spec.rb +0 -70
@@ -0,0 +1,2039 @@
1
+ # UserManagementApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**um_groups_delete**](UserManagementApi.md#um_groups_delete) | **DELETE** /um/groups/{groupId} | Delete groups |
8
+ | [**um_groups_find_by_id**](UserManagementApi.md#um_groups_find_by_id) | **GET** /um/groups/{groupId} | Retrieve groups |
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 groups |
11
+ | [**um_groups_put**](UserManagementApi.md#um_groups_put) | **PUT** /um/groups/{groupId} | Modify groups |
12
+ | [**um_groups_resources_get**](UserManagementApi.md#um_groups_resources_get) | **GET** /um/groups/{groupId}/resources | Retrieve group resources |
13
+ | [**um_groups_shares_delete**](UserManagementApi.md#um_groups_shares_delete) | **DELETE** /um/groups/{groupId}/shares/{resourceId} | Remove group shares |
14
+ | [**um_groups_shares_find_by_resource_id**](UserManagementApi.md#um_groups_shares_find_by_resource_id) | **GET** /um/groups/{groupId}/shares/{resourceId} | Retrieve group shares |
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 group shares |
17
+ | [**um_groups_shares_put**](UserManagementApi.md#um_groups_shares_put) | **PUT** /um/groups/{groupId}/shares/{resourceId} | Modify group share privileges |
18
+ | [**um_groups_users_delete**](UserManagementApi.md#um_groups_users_delete) | **DELETE** /um/groups/{groupId}/users/{userId} | Remove users from groups |
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 group members |
21
+ | [**um_resources_find_by_type**](UserManagementApi.md#um_resources_find_by_type) | **GET** /um/resources/{resourceType} | List 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 resources 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 users |
25
+ | [**um_users_find_by_id**](UserManagementApi.md#um_users_find_by_id) | **GET** /um/users/{userId} | Retrieve users |
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 group resources by user ID |
28
+ | [**um_users_owns_get**](UserManagementApi.md#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve user resources by user ID |
29
+ | [**um_users_post**](UserManagementApi.md#um_users_post) | **POST** /um/users | Create users |
30
+ | [**um_users_put**](UserManagementApi.md#um_users_put) | **PUT** /um/users/{userId} | Modify users |
31
+
32
+
33
+ ## um_groups_delete
34
+
35
+ > um_groups_delete(group_id, opts)
36
+
37
+ Delete groups
38
+
39
+ Remove the specified group.
40
+
41
+ ### Examples
42
+
43
+ ```ruby
44
+ require 'time'
45
+ require 'ionoscloud'
46
+ # setup authorization
47
+ Ionoscloud.configure do |config|
48
+ # Configure HTTP basic authorization: Basic Authentication
49
+ config.username = 'YOUR USERNAME'
50
+ config.password = 'YOUR PASSWORD'
51
+
52
+ # Configure API key authorization: Token Authentication
53
+ config.api_key['Authorization'] = 'YOUR API KEY'
54
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
55
+ # config.api_key_prefix['Authorization'] = 'Bearer'
56
+ end
57
+
58
+ api_instance = Ionoscloud::UserManagementApi.new
59
+ group_id = 'group_id_example' # String | The unique ID of the group.
60
+ opts = {
61
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
62
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
63
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
64
+ }
65
+
66
+ begin
67
+ # Delete groups
68
+ api_instance.um_groups_delete(group_id, opts)
69
+ rescue Ionoscloud::ApiError => e
70
+ puts "Error when calling UserManagementApi->um_groups_delete: #{e}"
71
+ end
72
+ ```
73
+
74
+ #### Using the um_groups_delete_with_http_info variant
75
+
76
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
77
+
78
+ > <Array(nil, Integer, Hash)> um_groups_delete_with_http_info(group_id, opts)
79
+
80
+ ```ruby
81
+ begin
82
+ # Delete groups
83
+ data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts)
84
+ p status_code # => 2xx
85
+ p headers # => { ... }
86
+ p data # => nil
87
+ rescue Ionoscloud::ApiError => e
88
+ puts "Error when calling UserManagementApi->um_groups_delete_with_http_info: #{e}"
89
+ end
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ | Name | Type | Description | Notes |
95
+ | ---- | ---- | ----------- | ----- |
96
+ | **group_id** | **String** | The unique ID of the group. | |
97
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
98
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
99
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
100
+
101
+ ### Return type
102
+
103
+ nil (empty response body)
104
+
105
+ ### Authorization
106
+
107
+ Basic Authentication, Token Authentication
108
+
109
+ ### HTTP request headers
110
+
111
+ - **Content-Type**: Not defined
112
+ - **Accept**: application/json
113
+
114
+
115
+ ## um_groups_find_by_id
116
+
117
+ > <Group> um_groups_find_by_id(group_id, opts)
118
+
119
+ Retrieve groups
120
+
121
+ Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.
122
+
123
+ ### Examples
124
+
125
+ ```ruby
126
+ require 'time'
127
+ require 'ionoscloud'
128
+ # setup authorization
129
+ Ionoscloud.configure do |config|
130
+ # Configure HTTP basic authorization: Basic Authentication
131
+ config.username = 'YOUR USERNAME'
132
+ config.password = 'YOUR PASSWORD'
133
+
134
+ # Configure API key authorization: Token Authentication
135
+ config.api_key['Authorization'] = 'YOUR API KEY'
136
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
137
+ # config.api_key_prefix['Authorization'] = 'Bearer'
138
+ end
139
+
140
+ api_instance = Ionoscloud::UserManagementApi.new
141
+ group_id = 'group_id_example' # String | The unique ID of the group.
142
+ opts = {
143
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
144
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
145
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
146
+ }
147
+
148
+ begin
149
+ # Retrieve groups
150
+ result = api_instance.um_groups_find_by_id(group_id, opts)
151
+ p result
152
+ rescue Ionoscloud::ApiError => e
153
+ puts "Error when calling UserManagementApi->um_groups_find_by_id: #{e}"
154
+ end
155
+ ```
156
+
157
+ #### Using the um_groups_find_by_id_with_http_info variant
158
+
159
+ This returns an Array which contains the response data, status code and headers.
160
+
161
+ > <Array(<Group>, Integer, Hash)> um_groups_find_by_id_with_http_info(group_id, opts)
162
+
163
+ ```ruby
164
+ begin
165
+ # Retrieve groups
166
+ data, status_code, headers = api_instance.um_groups_find_by_id_with_http_info(group_id, opts)
167
+ p status_code # => 2xx
168
+ p headers # => { ... }
169
+ p data # => <Group>
170
+ rescue Ionoscloud::ApiError => e
171
+ puts "Error when calling UserManagementApi->um_groups_find_by_id_with_http_info: #{e}"
172
+ end
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ | Name | Type | Description | Notes |
178
+ | ---- | ---- | ----------- | ----- |
179
+ | **group_id** | **String** | The unique ID of the group. | |
180
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
181
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
182
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
183
+
184
+ ### Return type
185
+
186
+ [**Group**](../models/Group.md)
187
+
188
+ ### Authorization
189
+
190
+ Basic Authentication, Token Authentication
191
+
192
+ ### HTTP request headers
193
+
194
+ - **Content-Type**: Not defined
195
+ - **Accept**: application/json
196
+
197
+
198
+ ## um_groups_get
199
+
200
+ > <Groups> um_groups_get(opts)
201
+
202
+ List all groups
203
+
204
+ List all the available user groups.
205
+
206
+ ### Examples
207
+
208
+ ```ruby
209
+ require 'time'
210
+ require 'ionoscloud'
211
+ # setup authorization
212
+ Ionoscloud.configure do |config|
213
+ # Configure HTTP basic authorization: Basic Authentication
214
+ config.username = 'YOUR USERNAME'
215
+ config.password = 'YOUR PASSWORD'
216
+
217
+ # Configure API key authorization: Token Authentication
218
+ config.api_key['Authorization'] = 'YOUR API KEY'
219
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
220
+ # config.api_key_prefix['Authorization'] = 'Bearer'
221
+ end
222
+
223
+ api_instance = Ionoscloud::UserManagementApi.new
224
+ opts = {
225
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
226
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
227
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
228
+ }
229
+
230
+ begin
231
+ # List all groups
232
+ result = api_instance.um_groups_get(opts)
233
+ p result
234
+ rescue Ionoscloud::ApiError => e
235
+ puts "Error when calling UserManagementApi->um_groups_get: #{e}"
236
+ end
237
+ ```
238
+
239
+ #### Using the um_groups_get_with_http_info variant
240
+
241
+ This returns an Array which contains the response data, status code and headers.
242
+
243
+ > <Array(<Groups>, Integer, Hash)> um_groups_get_with_http_info(opts)
244
+
245
+ ```ruby
246
+ begin
247
+ # List all groups
248
+ data, status_code, headers = api_instance.um_groups_get_with_http_info(opts)
249
+ p status_code # => 2xx
250
+ p headers # => { ... }
251
+ p data # => <Groups>
252
+ rescue Ionoscloud::ApiError => e
253
+ puts "Error when calling UserManagementApi->um_groups_get_with_http_info: #{e}"
254
+ end
255
+ ```
256
+
257
+ ### Parameters
258
+
259
+ | Name | Type | Description | Notes |
260
+ | ---- | ---- | ----------- | ----- |
261
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
262
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
263
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
264
+
265
+ ### Return type
266
+
267
+ [**Groups**](../models/Groups.md)
268
+
269
+ ### Authorization
270
+
271
+ Basic Authentication, Token Authentication
272
+
273
+ ### HTTP request headers
274
+
275
+ - **Content-Type**: Not defined
276
+ - **Accept**: application/json
277
+
278
+
279
+ ## um_groups_post
280
+
281
+ > <Group> um_groups_post(group, opts)
282
+
283
+ Create groups
284
+
285
+ Create a group.
286
+
287
+ ### Examples
288
+
289
+ ```ruby
290
+ require 'time'
291
+ require 'ionoscloud'
292
+ # setup authorization
293
+ Ionoscloud.configure do |config|
294
+ # Configure HTTP basic authorization: Basic Authentication
295
+ config.username = 'YOUR USERNAME'
296
+ config.password = 'YOUR PASSWORD'
297
+
298
+ # Configure API key authorization: Token Authentication
299
+ config.api_key['Authorization'] = 'YOUR API KEY'
300
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
301
+ # config.api_key_prefix['Authorization'] = 'Bearer'
302
+ end
303
+
304
+ api_instance = Ionoscloud::UserManagementApi.new
305
+ group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The group to create.
306
+ opts = {
307
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
308
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
309
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
310
+ }
311
+
312
+ begin
313
+ # Create groups
314
+ result = api_instance.um_groups_post(group, opts)
315
+ p result
316
+ rescue Ionoscloud::ApiError => e
317
+ puts "Error when calling UserManagementApi->um_groups_post: #{e}"
318
+ end
319
+ ```
320
+
321
+ #### Using the um_groups_post_with_http_info variant
322
+
323
+ This returns an Array which contains the response data, status code and headers.
324
+
325
+ > <Array(<Group>, Integer, Hash)> um_groups_post_with_http_info(group, opts)
326
+
327
+ ```ruby
328
+ begin
329
+ # Create groups
330
+ data, status_code, headers = api_instance.um_groups_post_with_http_info(group, opts)
331
+ p status_code # => 2xx
332
+ p headers # => { ... }
333
+ p data # => <Group>
334
+ rescue Ionoscloud::ApiError => e
335
+ puts "Error when calling UserManagementApi->um_groups_post_with_http_info: #{e}"
336
+ end
337
+ ```
338
+
339
+ ### Parameters
340
+
341
+ | Name | Type | Description | Notes |
342
+ | ---- | ---- | ----------- | ----- |
343
+ | **group** | [**Group**](Group.md) | The group to create. | |
344
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
345
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
346
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
347
+
348
+ ### Return type
349
+
350
+ [**Group**](../models/Group.md)
351
+
352
+ ### Authorization
353
+
354
+ Basic Authentication, Token Authentication
355
+
356
+ ### HTTP request headers
357
+
358
+ - **Content-Type**: application/json
359
+ - **Accept**: application/json
360
+
361
+
362
+ ## um_groups_put
363
+
364
+ > <Group> um_groups_put(group_id, group, opts)
365
+
366
+ Modify groups
367
+
368
+ Modify the properties of the specified group.
369
+
370
+ ### Examples
371
+
372
+ ```ruby
373
+ require 'time'
374
+ require 'ionoscloud'
375
+ # setup authorization
376
+ Ionoscloud.configure do |config|
377
+ # Configure HTTP basic authorization: Basic Authentication
378
+ config.username = 'YOUR USERNAME'
379
+ config.password = 'YOUR PASSWORD'
380
+
381
+ # Configure API key authorization: Token Authentication
382
+ config.api_key['Authorization'] = 'YOUR API KEY'
383
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
384
+ # config.api_key_prefix['Authorization'] = 'Bearer'
385
+ end
386
+
387
+ api_instance = Ionoscloud::UserManagementApi.new
388
+ group_id = 'group_id_example' # String | The unique ID of the group.
389
+ group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The modified group.
390
+ opts = {
391
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
392
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
393
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
394
+ }
395
+
396
+ begin
397
+ # Modify groups
398
+ result = api_instance.um_groups_put(group_id, group, opts)
399
+ p result
400
+ rescue Ionoscloud::ApiError => e
401
+ puts "Error when calling UserManagementApi->um_groups_put: #{e}"
402
+ end
403
+ ```
404
+
405
+ #### Using the um_groups_put_with_http_info variant
406
+
407
+ This returns an Array which contains the response data, status code and headers.
408
+
409
+ > <Array(<Group>, Integer, Hash)> um_groups_put_with_http_info(group_id, group, opts)
410
+
411
+ ```ruby
412
+ begin
413
+ # Modify groups
414
+ data, status_code, headers = api_instance.um_groups_put_with_http_info(group_id, group, opts)
415
+ p status_code # => 2xx
416
+ p headers # => { ... }
417
+ p data # => <Group>
418
+ rescue Ionoscloud::ApiError => e
419
+ puts "Error when calling UserManagementApi->um_groups_put_with_http_info: #{e}"
420
+ end
421
+ ```
422
+
423
+ ### Parameters
424
+
425
+ | Name | Type | Description | Notes |
426
+ | ---- | ---- | ----------- | ----- |
427
+ | **group_id** | **String** | The unique ID of the group. | |
428
+ | **group** | [**Group**](Group.md) | The modified group. | |
429
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
430
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
431
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
432
+
433
+ ### Return type
434
+
435
+ [**Group**](../models/Group.md)
436
+
437
+ ### Authorization
438
+
439
+ Basic Authentication, Token Authentication
440
+
441
+ ### HTTP request headers
442
+
443
+ - **Content-Type**: application/json
444
+ - **Accept**: application/json
445
+
446
+
447
+ ## um_groups_resources_get
448
+
449
+ > <ResourceGroups> um_groups_resources_get(group_id, opts)
450
+
451
+ Retrieve group resources
452
+
453
+ List the resources assigned to the group, by group ID.
454
+
455
+ ### Examples
456
+
457
+ ```ruby
458
+ require 'time'
459
+ require 'ionoscloud'
460
+ # setup authorization
461
+ Ionoscloud.configure do |config|
462
+ # Configure HTTP basic authorization: Basic Authentication
463
+ config.username = 'YOUR USERNAME'
464
+ config.password = 'YOUR PASSWORD'
465
+
466
+ # Configure API key authorization: Token Authentication
467
+ config.api_key['Authorization'] = 'YOUR API KEY'
468
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
469
+ # config.api_key_prefix['Authorization'] = 'Bearer'
470
+ end
471
+
472
+ api_instance = Ionoscloud::UserManagementApi.new
473
+ group_id = 'group_id_example' # String | The unique ID of the group.
474
+ opts = {
475
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
476
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
477
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
478
+ }
479
+
480
+ begin
481
+ # Retrieve group resources
482
+ result = api_instance.um_groups_resources_get(group_id, opts)
483
+ p result
484
+ rescue Ionoscloud::ApiError => e
485
+ puts "Error when calling UserManagementApi->um_groups_resources_get: #{e}"
486
+ end
487
+ ```
488
+
489
+ #### Using the um_groups_resources_get_with_http_info variant
490
+
491
+ This returns an Array which contains the response data, status code and headers.
492
+
493
+ > <Array(<ResourceGroups>, Integer, Hash)> um_groups_resources_get_with_http_info(group_id, opts)
494
+
495
+ ```ruby
496
+ begin
497
+ # Retrieve group resources
498
+ data, status_code, headers = api_instance.um_groups_resources_get_with_http_info(group_id, opts)
499
+ p status_code # => 2xx
500
+ p headers # => { ... }
501
+ p data # => <ResourceGroups>
502
+ rescue Ionoscloud::ApiError => e
503
+ puts "Error when calling UserManagementApi->um_groups_resources_get_with_http_info: #{e}"
504
+ end
505
+ ```
506
+
507
+ ### Parameters
508
+
509
+ | Name | Type | Description | Notes |
510
+ | ---- | ---- | ----------- | ----- |
511
+ | **group_id** | **String** | The unique ID of the group. | |
512
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
513
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
514
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
515
+
516
+ ### Return type
517
+
518
+ [**ResourceGroups**](../models/ResourceGroups.md)
519
+
520
+ ### Authorization
521
+
522
+ Basic Authentication, Token Authentication
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: Not defined
527
+ - **Accept**: application/json
528
+
529
+
530
+ ## um_groups_shares_delete
531
+
532
+ > um_groups_shares_delete(group_id, resource_id, opts)
533
+
534
+ Remove group shares
535
+
536
+ Remove the specified share from the group.
537
+
538
+ ### Examples
539
+
540
+ ```ruby
541
+ require 'time'
542
+ require 'ionoscloud'
543
+ # setup authorization
544
+ Ionoscloud.configure do |config|
545
+ # Configure HTTP basic authorization: Basic Authentication
546
+ config.username = 'YOUR USERNAME'
547
+ config.password = 'YOUR PASSWORD'
548
+
549
+ # Configure API key authorization: Token Authentication
550
+ config.api_key['Authorization'] = 'YOUR API KEY'
551
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
552
+ # config.api_key_prefix['Authorization'] = 'Bearer'
553
+ end
554
+
555
+ api_instance = Ionoscloud::UserManagementApi.new
556
+ group_id = 'group_id_example' # String | The unique ID of the group.
557
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
558
+ opts = {
559
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
560
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
561
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
562
+ }
563
+
564
+ begin
565
+ # Remove group shares
566
+ api_instance.um_groups_shares_delete(group_id, resource_id, opts)
567
+ rescue Ionoscloud::ApiError => e
568
+ puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}"
569
+ end
570
+ ```
571
+
572
+ #### Using the um_groups_shares_delete_with_http_info variant
573
+
574
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
575
+
576
+ > <Array(nil, Integer, Hash)> um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
577
+
578
+ ```ruby
579
+ begin
580
+ # Remove group shares
581
+ data, status_code, headers = api_instance.um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
582
+ p status_code # => 2xx
583
+ p headers # => { ... }
584
+ p data # => nil
585
+ rescue Ionoscloud::ApiError => e
586
+ puts "Error when calling UserManagementApi->um_groups_shares_delete_with_http_info: #{e}"
587
+ end
588
+ ```
589
+
590
+ ### Parameters
591
+
592
+ | Name | Type | Description | Notes |
593
+ | ---- | ---- | ----------- | ----- |
594
+ | **group_id** | **String** | The unique ID of the group. | |
595
+ | **resource_id** | **String** | The unique ID of the resource. | |
596
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
597
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
598
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
599
+
600
+ ### Return type
601
+
602
+ nil (empty response body)
603
+
604
+ ### Authorization
605
+
606
+ Basic Authentication, Token Authentication
607
+
608
+ ### HTTP request headers
609
+
610
+ - **Content-Type**: Not defined
611
+ - **Accept**: application/json
612
+
613
+
614
+ ## um_groups_shares_find_by_resource_id
615
+
616
+ > <GroupShare> um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
617
+
618
+ Retrieve group shares
619
+
620
+ Retrieve the properties of the specified group share.
621
+
622
+ ### Examples
623
+
624
+ ```ruby
625
+ require 'time'
626
+ require 'ionoscloud'
627
+ # setup authorization
628
+ Ionoscloud.configure do |config|
629
+ # Configure HTTP basic authorization: Basic Authentication
630
+ config.username = 'YOUR USERNAME'
631
+ config.password = 'YOUR PASSWORD'
632
+
633
+ # Configure API key authorization: Token Authentication
634
+ config.api_key['Authorization'] = 'YOUR API KEY'
635
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
636
+ # config.api_key_prefix['Authorization'] = 'Bearer'
637
+ end
638
+
639
+ api_instance = Ionoscloud::UserManagementApi.new
640
+ group_id = 'group_id_example' # String | The unique ID of the group.
641
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
642
+ opts = {
643
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
644
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
645
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
646
+ }
647
+
648
+ begin
649
+ # Retrieve group shares
650
+ result = api_instance.um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
651
+ p result
652
+ rescue Ionoscloud::ApiError => e
653
+ puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id: #{e}"
654
+ end
655
+ ```
656
+
657
+ #### Using the um_groups_shares_find_by_resource_id_with_http_info variant
658
+
659
+ This returns an Array which contains the response data, status code and headers.
660
+
661
+ > <Array(<GroupShare>, Integer, Hash)> um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
662
+
663
+ ```ruby
664
+ begin
665
+ # Retrieve group shares
666
+ data, status_code, headers = api_instance.um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
667
+ p status_code # => 2xx
668
+ p headers # => { ... }
669
+ p data # => <GroupShare>
670
+ rescue Ionoscloud::ApiError => e
671
+ puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id_with_http_info: #{e}"
672
+ end
673
+ ```
674
+
675
+ ### Parameters
676
+
677
+ | Name | Type | Description | Notes |
678
+ | ---- | ---- | ----------- | ----- |
679
+ | **group_id** | **String** | The unique ID of the group. | |
680
+ | **resource_id** | **String** | The unique ID of the resource. | |
681
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
682
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
683
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
684
+
685
+ ### Return type
686
+
687
+ [**GroupShare**](../models/GroupShare.md)
688
+
689
+ ### Authorization
690
+
691
+ Basic Authentication, Token Authentication
692
+
693
+ ### HTTP request headers
694
+
695
+ - **Content-Type**: Not defined
696
+ - **Accept**: application/json
697
+
698
+
699
+ ## um_groups_shares_get
700
+
701
+ > <GroupShares> um_groups_shares_get(group_id, opts)
702
+
703
+ List group shares
704
+
705
+ List all shares and share privileges for the specified group.
706
+
707
+ ### Examples
708
+
709
+ ```ruby
710
+ require 'time'
711
+ require 'ionoscloud'
712
+ # setup authorization
713
+ Ionoscloud.configure do |config|
714
+ # Configure HTTP basic authorization: Basic Authentication
715
+ config.username = 'YOUR USERNAME'
716
+ config.password = 'YOUR PASSWORD'
717
+
718
+ # Configure API key authorization: Token Authentication
719
+ config.api_key['Authorization'] = 'YOUR API KEY'
720
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
721
+ # config.api_key_prefix['Authorization'] = 'Bearer'
722
+ end
723
+
724
+ api_instance = Ionoscloud::UserManagementApi.new
725
+ group_id = 'group_id_example' # String | The unique ID of the group.
726
+ opts = {
727
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
728
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
729
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
730
+ }
731
+
732
+ begin
733
+ # List group shares
734
+ result = api_instance.um_groups_shares_get(group_id, opts)
735
+ p result
736
+ rescue Ionoscloud::ApiError => e
737
+ puts "Error when calling UserManagementApi->um_groups_shares_get: #{e}"
738
+ end
739
+ ```
740
+
741
+ #### Using the um_groups_shares_get_with_http_info variant
742
+
743
+ This returns an Array which contains the response data, status code and headers.
744
+
745
+ > <Array(<GroupShares>, Integer, Hash)> um_groups_shares_get_with_http_info(group_id, opts)
746
+
747
+ ```ruby
748
+ begin
749
+ # List group shares
750
+ data, status_code, headers = api_instance.um_groups_shares_get_with_http_info(group_id, opts)
751
+ p status_code # => 2xx
752
+ p headers # => { ... }
753
+ p data # => <GroupShares>
754
+ rescue Ionoscloud::ApiError => e
755
+ puts "Error when calling UserManagementApi->um_groups_shares_get_with_http_info: #{e}"
756
+ end
757
+ ```
758
+
759
+ ### Parameters
760
+
761
+ | Name | Type | Description | Notes |
762
+ | ---- | ---- | ----------- | ----- |
763
+ | **group_id** | **String** | The unique ID of the group. | |
764
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
765
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
766
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
767
+
768
+ ### Return type
769
+
770
+ [**GroupShares**](../models/GroupShares.md)
771
+
772
+ ### Authorization
773
+
774
+ Basic Authentication, Token Authentication
775
+
776
+ ### HTTP request headers
777
+
778
+ - **Content-Type**: Not defined
779
+ - **Accept**: application/json
780
+
781
+
782
+ ## um_groups_shares_post
783
+
784
+ > <GroupShare> um_groups_shares_post(group_id, resource_id, resource, opts)
785
+
786
+ Add group shares
787
+
788
+ Add the specified share to the group.
789
+
790
+ ### Examples
791
+
792
+ ```ruby
793
+ require 'time'
794
+ require 'ionoscloud'
795
+ # setup authorization
796
+ Ionoscloud.configure do |config|
797
+ # Configure HTTP basic authorization: Basic Authentication
798
+ config.username = 'YOUR USERNAME'
799
+ config.password = 'YOUR PASSWORD'
800
+
801
+ # Configure API key authorization: Token Authentication
802
+ config.api_key['Authorization'] = 'YOUR API KEY'
803
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
804
+ # config.api_key_prefix['Authorization'] = 'Bearer'
805
+ end
806
+
807
+ api_instance = Ionoscloud::UserManagementApi.new
808
+ group_id = 'group_id_example' # String | The unique ID of the group.
809
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
810
+ resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | The resource to add.
811
+ opts = {
812
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
813
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
814
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
815
+ }
816
+
817
+ begin
818
+ # Add group shares
819
+ result = api_instance.um_groups_shares_post(group_id, resource_id, resource, opts)
820
+ p result
821
+ rescue Ionoscloud::ApiError => e
822
+ puts "Error when calling UserManagementApi->um_groups_shares_post: #{e}"
823
+ end
824
+ ```
825
+
826
+ #### Using the um_groups_shares_post_with_http_info variant
827
+
828
+ This returns an Array which contains the response data, status code and headers.
829
+
830
+ > <Array(<GroupShare>, Integer, Hash)> um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
831
+
832
+ ```ruby
833
+ begin
834
+ # Add group shares
835
+ data, status_code, headers = api_instance.um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
836
+ p status_code # => 2xx
837
+ p headers # => { ... }
838
+ p data # => <GroupShare>
839
+ rescue Ionoscloud::ApiError => e
840
+ puts "Error when calling UserManagementApi->um_groups_shares_post_with_http_info: #{e}"
841
+ end
842
+ ```
843
+
844
+ ### Parameters
845
+
846
+ | Name | Type | Description | Notes |
847
+ | ---- | ---- | ----------- | ----- |
848
+ | **group_id** | **String** | The unique ID of the group. | |
849
+ | **resource_id** | **String** | The unique ID of the resource. | |
850
+ | **resource** | [**GroupShare**](GroupShare.md) | The resource to add. | |
851
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
852
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
853
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
854
+
855
+ ### Return type
856
+
857
+ [**GroupShare**](../models/GroupShare.md)
858
+
859
+ ### Authorization
860
+
861
+ Basic Authentication, Token Authentication
862
+
863
+ ### HTTP request headers
864
+
865
+ - **Content-Type**: Not defined
866
+ - **Accept**: application/json
867
+
868
+
869
+ ## um_groups_shares_put
870
+
871
+ > <GroupShare> um_groups_shares_put(group_id, resource_id, resource, opts)
872
+
873
+ Modify group share privileges
874
+
875
+ Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
876
+
877
+ ### Examples
878
+
879
+ ```ruby
880
+ require 'time'
881
+ require 'ionoscloud'
882
+ # setup authorization
883
+ Ionoscloud.configure do |config|
884
+ # Configure HTTP basic authorization: Basic Authentication
885
+ config.username = 'YOUR USERNAME'
886
+ config.password = 'YOUR PASSWORD'
887
+
888
+ # Configure API key authorization: Token Authentication
889
+ config.api_key['Authorization'] = 'YOUR API KEY'
890
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
891
+ # config.api_key_prefix['Authorization'] = 'Bearer'
892
+ end
893
+
894
+ api_instance = Ionoscloud::UserManagementApi.new
895
+ group_id = 'group_id_example' # String | The unique ID of the group.
896
+ resource_id = 'resource_id_example' # String | The unique ID of the resource.
897
+ resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | The modified resource
898
+ opts = {
899
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
900
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
901
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
902
+ }
903
+
904
+ begin
905
+ # Modify group share privileges
906
+ result = api_instance.um_groups_shares_put(group_id, resource_id, resource, opts)
907
+ p result
908
+ rescue Ionoscloud::ApiError => e
909
+ puts "Error when calling UserManagementApi->um_groups_shares_put: #{e}"
910
+ end
911
+ ```
912
+
913
+ #### Using the um_groups_shares_put_with_http_info variant
914
+
915
+ This returns an Array which contains the response data, status code and headers.
916
+
917
+ > <Array(<GroupShare>, Integer, Hash)> um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
918
+
919
+ ```ruby
920
+ begin
921
+ # Modify group share privileges
922
+ data, status_code, headers = api_instance.um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
923
+ p status_code # => 2xx
924
+ p headers # => { ... }
925
+ p data # => <GroupShare>
926
+ rescue Ionoscloud::ApiError => e
927
+ puts "Error when calling UserManagementApi->um_groups_shares_put_with_http_info: #{e}"
928
+ end
929
+ ```
930
+
931
+ ### Parameters
932
+
933
+ | Name | Type | Description | Notes |
934
+ | ---- | ---- | ----------- | ----- |
935
+ | **group_id** | **String** | The unique ID of the group. | |
936
+ | **resource_id** | **String** | The unique ID of the resource. | |
937
+ | **resource** | [**GroupShare**](GroupShare.md) | The modified resource | |
938
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
939
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
940
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
941
+
942
+ ### Return type
943
+
944
+ [**GroupShare**](../models/GroupShare.md)
945
+
946
+ ### Authorization
947
+
948
+ Basic Authentication, Token Authentication
949
+
950
+ ### HTTP request headers
951
+
952
+ - **Content-Type**: application/json
953
+ - **Accept**: application/json
954
+
955
+
956
+ ## um_groups_users_delete
957
+
958
+ > um_groups_users_delete(group_id, user_id, opts)
959
+
960
+ Remove users from groups
961
+
962
+ Remove the specified user from the group.
963
+
964
+ ### Examples
965
+
966
+ ```ruby
967
+ require 'time'
968
+ require 'ionoscloud'
969
+ # setup authorization
970
+ Ionoscloud.configure do |config|
971
+ # Configure HTTP basic authorization: Basic Authentication
972
+ config.username = 'YOUR USERNAME'
973
+ config.password = 'YOUR PASSWORD'
974
+
975
+ # Configure API key authorization: Token Authentication
976
+ config.api_key['Authorization'] = 'YOUR API KEY'
977
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
978
+ # config.api_key_prefix['Authorization'] = 'Bearer'
979
+ end
980
+
981
+ api_instance = Ionoscloud::UserManagementApi.new
982
+ group_id = 'group_id_example' # String | The unique ID of the group.
983
+ user_id = 'user_id_example' # String | The unique ID of the user.
984
+ opts = {
985
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
986
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
987
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
988
+ }
989
+
990
+ begin
991
+ # Remove users from groups
992
+ api_instance.um_groups_users_delete(group_id, user_id, opts)
993
+ rescue Ionoscloud::ApiError => e
994
+ puts "Error when calling UserManagementApi->um_groups_users_delete: #{e}"
995
+ end
996
+ ```
997
+
998
+ #### Using the um_groups_users_delete_with_http_info variant
999
+
1000
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1001
+
1002
+ > <Array(nil, Integer, Hash)> um_groups_users_delete_with_http_info(group_id, user_id, opts)
1003
+
1004
+ ```ruby
1005
+ begin
1006
+ # Remove users from groups
1007
+ data, status_code, headers = api_instance.um_groups_users_delete_with_http_info(group_id, user_id, opts)
1008
+ p status_code # => 2xx
1009
+ p headers # => { ... }
1010
+ p data # => nil
1011
+ rescue Ionoscloud::ApiError => e
1012
+ puts "Error when calling UserManagementApi->um_groups_users_delete_with_http_info: #{e}"
1013
+ end
1014
+ ```
1015
+
1016
+ ### Parameters
1017
+
1018
+ | Name | Type | Description | Notes |
1019
+ | ---- | ---- | ----------- | ----- |
1020
+ | **group_id** | **String** | The unique ID of the group. | |
1021
+ | **user_id** | **String** | The unique ID of the user. | |
1022
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1023
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1024
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1025
+
1026
+ ### Return type
1027
+
1028
+ nil (empty response body)
1029
+
1030
+ ### Authorization
1031
+
1032
+ Basic Authentication, Token Authentication
1033
+
1034
+ ### HTTP request headers
1035
+
1036
+ - **Content-Type**: Not defined
1037
+ - **Accept**: application/json
1038
+
1039
+
1040
+ ## um_groups_users_get
1041
+
1042
+ > <GroupMembers> um_groups_users_get(group_id, opts)
1043
+
1044
+ List group members
1045
+
1046
+ List all members of the specified user group.
1047
+
1048
+ ### Examples
1049
+
1050
+ ```ruby
1051
+ require 'time'
1052
+ require 'ionoscloud'
1053
+ # setup authorization
1054
+ Ionoscloud.configure do |config|
1055
+ # Configure HTTP basic authorization: Basic Authentication
1056
+ config.username = 'YOUR USERNAME'
1057
+ config.password = 'YOUR PASSWORD'
1058
+
1059
+ # Configure API key authorization: Token Authentication
1060
+ config.api_key['Authorization'] = 'YOUR API KEY'
1061
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1062
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1063
+ end
1064
+
1065
+ api_instance = Ionoscloud::UserManagementApi.new
1066
+ group_id = 'group_id_example' # String | The unique ID of the group.
1067
+ opts = {
1068
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1069
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1070
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1071
+ }
1072
+
1073
+ begin
1074
+ # List group members
1075
+ result = api_instance.um_groups_users_get(group_id, opts)
1076
+ p result
1077
+ rescue Ionoscloud::ApiError => e
1078
+ puts "Error when calling UserManagementApi->um_groups_users_get: #{e}"
1079
+ end
1080
+ ```
1081
+
1082
+ #### Using the um_groups_users_get_with_http_info variant
1083
+
1084
+ This returns an Array which contains the response data, status code and headers.
1085
+
1086
+ > <Array(<GroupMembers>, Integer, Hash)> um_groups_users_get_with_http_info(group_id, opts)
1087
+
1088
+ ```ruby
1089
+ begin
1090
+ # List group members
1091
+ data, status_code, headers = api_instance.um_groups_users_get_with_http_info(group_id, opts)
1092
+ p status_code # => 2xx
1093
+ p headers # => { ... }
1094
+ p data # => <GroupMembers>
1095
+ rescue Ionoscloud::ApiError => e
1096
+ puts "Error when calling UserManagementApi->um_groups_users_get_with_http_info: #{e}"
1097
+ end
1098
+ ```
1099
+
1100
+ ### Parameters
1101
+
1102
+ | Name | Type | Description | Notes |
1103
+ | ---- | ---- | ----------- | ----- |
1104
+ | **group_id** | **String** | The unique ID of the group. | |
1105
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1106
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1107
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1108
+
1109
+ ### Return type
1110
+
1111
+ [**GroupMembers**](../models/GroupMembers.md)
1112
+
1113
+ ### Authorization
1114
+
1115
+ Basic Authentication, Token Authentication
1116
+
1117
+ ### HTTP request headers
1118
+
1119
+ - **Content-Type**: Not defined
1120
+ - **Accept**: application/json
1121
+
1122
+
1123
+ ## um_groups_users_post
1124
+
1125
+ > <User> um_groups_users_post(group_id, user, opts)
1126
+
1127
+ Add group members
1128
+
1129
+ Add an existing user to the specified group.
1130
+
1131
+ ### Examples
1132
+
1133
+ ```ruby
1134
+ require 'time'
1135
+ require 'ionoscloud'
1136
+ # setup authorization
1137
+ Ionoscloud.configure do |config|
1138
+ # Configure HTTP basic authorization: Basic Authentication
1139
+ config.username = 'YOUR USERNAME'
1140
+ config.password = 'YOUR PASSWORD'
1141
+
1142
+ # Configure API key authorization: Token Authentication
1143
+ config.api_key['Authorization'] = 'YOUR API KEY'
1144
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1145
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1146
+ end
1147
+
1148
+ api_instance = Ionoscloud::UserManagementApi.new
1149
+ group_id = 'group_id_example' # String | The unique ID of the group.
1150
+ user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | The user to add.
1151
+ opts = {
1152
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1153
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1154
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1155
+ }
1156
+
1157
+ begin
1158
+ # Add group members
1159
+ result = api_instance.um_groups_users_post(group_id, user, opts)
1160
+ p result
1161
+ rescue Ionoscloud::ApiError => e
1162
+ puts "Error when calling UserManagementApi->um_groups_users_post: #{e}"
1163
+ end
1164
+ ```
1165
+
1166
+ #### Using the um_groups_users_post_with_http_info variant
1167
+
1168
+ This returns an Array which contains the response data, status code and headers.
1169
+
1170
+ > <Array(<User>, Integer, Hash)> um_groups_users_post_with_http_info(group_id, user, opts)
1171
+
1172
+ ```ruby
1173
+ begin
1174
+ # Add group members
1175
+ data, status_code, headers = api_instance.um_groups_users_post_with_http_info(group_id, user, opts)
1176
+ p status_code # => 2xx
1177
+ p headers # => { ... }
1178
+ p data # => <User>
1179
+ rescue Ionoscloud::ApiError => e
1180
+ puts "Error when calling UserManagementApi->um_groups_users_post_with_http_info: #{e}"
1181
+ end
1182
+ ```
1183
+
1184
+ ### Parameters
1185
+
1186
+ | Name | Type | Description | Notes |
1187
+ | ---- | ---- | ----------- | ----- |
1188
+ | **group_id** | **String** | The unique ID of the group. | |
1189
+ | **user** | [**User**](User.md) | The user to add. | |
1190
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1191
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1192
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1193
+
1194
+ ### Return type
1195
+
1196
+ [**User**](../models/User.md)
1197
+
1198
+ ### Authorization
1199
+
1200
+ Basic Authentication, Token Authentication
1201
+
1202
+ ### HTTP request headers
1203
+
1204
+ - **Content-Type**: application/json
1205
+ - **Accept**: application/json
1206
+
1207
+
1208
+ ## um_resources_find_by_type
1209
+
1210
+ > <Resources> um_resources_find_by_type(resource_type, opts)
1211
+
1212
+ List resources by type
1213
+
1214
+ List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
1215
+
1216
+ ### Examples
1217
+
1218
+ ```ruby
1219
+ require 'time'
1220
+ require 'ionoscloud'
1221
+ # setup authorization
1222
+ Ionoscloud.configure do |config|
1223
+ # Configure HTTP basic authorization: Basic Authentication
1224
+ config.username = 'YOUR USERNAME'
1225
+ config.password = 'YOUR PASSWORD'
1226
+
1227
+ # Configure API key authorization: Token Authentication
1228
+ config.api_key['Authorization'] = 'YOUR API KEY'
1229
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1230
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1231
+ end
1232
+
1233
+ api_instance = Ionoscloud::UserManagementApi.new
1234
+ resource_type = 'resource_type_example' # String | The resource type
1235
+ opts = {
1236
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1237
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1238
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1239
+ }
1240
+
1241
+ begin
1242
+ # List resources by type
1243
+ result = api_instance.um_resources_find_by_type(resource_type, opts)
1244
+ p result
1245
+ rescue Ionoscloud::ApiError => e
1246
+ puts "Error when calling UserManagementApi->um_resources_find_by_type: #{e}"
1247
+ end
1248
+ ```
1249
+
1250
+ #### Using the um_resources_find_by_type_with_http_info variant
1251
+
1252
+ This returns an Array which contains the response data, status code and headers.
1253
+
1254
+ > <Array(<Resources>, Integer, Hash)> um_resources_find_by_type_with_http_info(resource_type, opts)
1255
+
1256
+ ```ruby
1257
+ begin
1258
+ # List resources by type
1259
+ data, status_code, headers = api_instance.um_resources_find_by_type_with_http_info(resource_type, opts)
1260
+ p status_code # => 2xx
1261
+ p headers # => { ... }
1262
+ p data # => <Resources>
1263
+ rescue Ionoscloud::ApiError => e
1264
+ puts "Error when calling UserManagementApi->um_resources_find_by_type_with_http_info: #{e}"
1265
+ end
1266
+ ```
1267
+
1268
+ ### Parameters
1269
+
1270
+ | Name | Type | Description | Notes |
1271
+ | ---- | ---- | ----------- | ----- |
1272
+ | **resource_type** | **String** | The resource type | |
1273
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1274
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1275
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1276
+
1277
+ ### Return type
1278
+
1279
+ [**Resources**](../models/Resources.md)
1280
+
1281
+ ### Authorization
1282
+
1283
+ Basic Authentication, Token Authentication
1284
+
1285
+ ### HTTP request headers
1286
+
1287
+ - **Content-Type**: Not defined
1288
+ - **Accept**: application/json
1289
+
1290
+
1291
+ ## um_resources_find_by_type_and_id
1292
+
1293
+ > <Resource> um_resources_find_by_type_and_id(resource_type, resource_id, opts)
1294
+
1295
+ Retrieve resources by type
1296
+
1297
+ Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
1298
+
1299
+ ### Examples
1300
+
1301
+ ```ruby
1302
+ require 'time'
1303
+ require 'ionoscloud'
1304
+ # setup authorization
1305
+ Ionoscloud.configure do |config|
1306
+ # Configure HTTP basic authorization: Basic Authentication
1307
+ config.username = 'YOUR USERNAME'
1308
+ config.password = 'YOUR PASSWORD'
1309
+
1310
+ # Configure API key authorization: Token Authentication
1311
+ config.api_key['Authorization'] = 'YOUR API KEY'
1312
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1313
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1314
+ end
1315
+
1316
+ api_instance = Ionoscloud::UserManagementApi.new
1317
+ resource_type = 'resource_type_example' # String | The resource type
1318
+ resource_id = 'resource_id_example' # String | The resource ID
1319
+ opts = {
1320
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1321
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1322
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1323
+ }
1324
+
1325
+ begin
1326
+ # Retrieve resources by type
1327
+ result = api_instance.um_resources_find_by_type_and_id(resource_type, resource_id, opts)
1328
+ p result
1329
+ rescue Ionoscloud::ApiError => e
1330
+ puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id: #{e}"
1331
+ end
1332
+ ```
1333
+
1334
+ #### Using the um_resources_find_by_type_and_id_with_http_info variant
1335
+
1336
+ This returns an Array which contains the response data, status code and headers.
1337
+
1338
+ > <Array(<Resource>, Integer, Hash)> um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
1339
+
1340
+ ```ruby
1341
+ begin
1342
+ # Retrieve resources by type
1343
+ data, status_code, headers = api_instance.um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
1344
+ p status_code # => 2xx
1345
+ p headers # => { ... }
1346
+ p data # => <Resource>
1347
+ rescue Ionoscloud::ApiError => e
1348
+ puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id_with_http_info: #{e}"
1349
+ end
1350
+ ```
1351
+
1352
+ ### Parameters
1353
+
1354
+ | Name | Type | Description | Notes |
1355
+ | ---- | ---- | ----------- | ----- |
1356
+ | **resource_type** | **String** | The resource type | |
1357
+ | **resource_id** | **String** | The resource ID | |
1358
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1359
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1360
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1361
+
1362
+ ### Return type
1363
+
1364
+ [**Resource**](../models/Resource.md)
1365
+
1366
+ ### Authorization
1367
+
1368
+ Basic Authentication, Token Authentication
1369
+
1370
+ ### HTTP request headers
1371
+
1372
+ - **Content-Type**: Not defined
1373
+ - **Accept**: application/json
1374
+
1375
+
1376
+ ## um_resources_get
1377
+
1378
+ > <Resources> um_resources_get(opts)
1379
+
1380
+ List all resources
1381
+
1382
+ List all the available resources.
1383
+
1384
+ ### Examples
1385
+
1386
+ ```ruby
1387
+ require 'time'
1388
+ require 'ionoscloud'
1389
+ # setup authorization
1390
+ Ionoscloud.configure do |config|
1391
+ # Configure HTTP basic authorization: Basic Authentication
1392
+ config.username = 'YOUR USERNAME'
1393
+ config.password = 'YOUR PASSWORD'
1394
+
1395
+ # Configure API key authorization: Token Authentication
1396
+ config.api_key['Authorization'] = 'YOUR API KEY'
1397
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1398
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1399
+ end
1400
+
1401
+ api_instance = Ionoscloud::UserManagementApi.new
1402
+ opts = {
1403
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1404
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1405
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1406
+ }
1407
+
1408
+ begin
1409
+ # List all resources
1410
+ result = api_instance.um_resources_get(opts)
1411
+ p result
1412
+ rescue Ionoscloud::ApiError => e
1413
+ puts "Error when calling UserManagementApi->um_resources_get: #{e}"
1414
+ end
1415
+ ```
1416
+
1417
+ #### Using the um_resources_get_with_http_info variant
1418
+
1419
+ This returns an Array which contains the response data, status code and headers.
1420
+
1421
+ > <Array(<Resources>, Integer, Hash)> um_resources_get_with_http_info(opts)
1422
+
1423
+ ```ruby
1424
+ begin
1425
+ # List all resources
1426
+ data, status_code, headers = api_instance.um_resources_get_with_http_info(opts)
1427
+ p status_code # => 2xx
1428
+ p headers # => { ... }
1429
+ p data # => <Resources>
1430
+ rescue Ionoscloud::ApiError => e
1431
+ puts "Error when calling UserManagementApi->um_resources_get_with_http_info: #{e}"
1432
+ end
1433
+ ```
1434
+
1435
+ ### Parameters
1436
+
1437
+ | Name | Type | Description | Notes |
1438
+ | ---- | ---- | ----------- | ----- |
1439
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1440
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1441
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1442
+
1443
+ ### Return type
1444
+
1445
+ [**Resources**](../models/Resources.md)
1446
+
1447
+ ### Authorization
1448
+
1449
+ Basic Authentication, Token Authentication
1450
+
1451
+ ### HTTP request headers
1452
+
1453
+ - **Content-Type**: Not defined
1454
+ - **Accept**: application/json
1455
+
1456
+
1457
+ ## um_users_delete
1458
+
1459
+ > um_users_delete(user_id, opts)
1460
+
1461
+ Delete users
1462
+
1463
+ Delete the specified user.
1464
+
1465
+ ### Examples
1466
+
1467
+ ```ruby
1468
+ require 'time'
1469
+ require 'ionoscloud'
1470
+ # setup authorization
1471
+ Ionoscloud.configure do |config|
1472
+ # Configure HTTP basic authorization: Basic Authentication
1473
+ config.username = 'YOUR USERNAME'
1474
+ config.password = 'YOUR PASSWORD'
1475
+
1476
+ # Configure API key authorization: Token Authentication
1477
+ config.api_key['Authorization'] = 'YOUR API KEY'
1478
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1479
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1480
+ end
1481
+
1482
+ api_instance = Ionoscloud::UserManagementApi.new
1483
+ user_id = 'user_id_example' # String | The unique ID of the user.
1484
+ opts = {
1485
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1486
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1487
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1488
+ }
1489
+
1490
+ begin
1491
+ # Delete users
1492
+ api_instance.um_users_delete(user_id, opts)
1493
+ rescue Ionoscloud::ApiError => e
1494
+ puts "Error when calling UserManagementApi->um_users_delete: #{e}"
1495
+ end
1496
+ ```
1497
+
1498
+ #### Using the um_users_delete_with_http_info variant
1499
+
1500
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1501
+
1502
+ > <Array(nil, Integer, Hash)> um_users_delete_with_http_info(user_id, opts)
1503
+
1504
+ ```ruby
1505
+ begin
1506
+ # Delete users
1507
+ data, status_code, headers = api_instance.um_users_delete_with_http_info(user_id, opts)
1508
+ p status_code # => 2xx
1509
+ p headers # => { ... }
1510
+ p data # => nil
1511
+ rescue Ionoscloud::ApiError => e
1512
+ puts "Error when calling UserManagementApi->um_users_delete_with_http_info: #{e}"
1513
+ end
1514
+ ```
1515
+
1516
+ ### Parameters
1517
+
1518
+ | Name | Type | Description | Notes |
1519
+ | ---- | ---- | ----------- | ----- |
1520
+ | **user_id** | **String** | The unique ID of the user. | |
1521
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1522
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1523
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1524
+
1525
+ ### Return type
1526
+
1527
+ nil (empty response body)
1528
+
1529
+ ### Authorization
1530
+
1531
+ Basic Authentication, Token Authentication
1532
+
1533
+ ### HTTP request headers
1534
+
1535
+ - **Content-Type**: Not defined
1536
+ - **Accept**: application/json
1537
+
1538
+
1539
+ ## um_users_find_by_id
1540
+
1541
+ > <User> um_users_find_by_id(user_id, opts)
1542
+
1543
+ Retrieve users
1544
+
1545
+ Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
1546
+
1547
+ ### Examples
1548
+
1549
+ ```ruby
1550
+ require 'time'
1551
+ require 'ionoscloud'
1552
+ # setup authorization
1553
+ Ionoscloud.configure do |config|
1554
+ # Configure HTTP basic authorization: Basic Authentication
1555
+ config.username = 'YOUR USERNAME'
1556
+ config.password = 'YOUR PASSWORD'
1557
+
1558
+ # Configure API key authorization: Token Authentication
1559
+ config.api_key['Authorization'] = 'YOUR API KEY'
1560
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1561
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1562
+ end
1563
+
1564
+ api_instance = Ionoscloud::UserManagementApi.new
1565
+ user_id = 'user_id_example' # String | The unique ID of the user.
1566
+ opts = {
1567
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1568
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1569
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1570
+ }
1571
+
1572
+ begin
1573
+ # Retrieve users
1574
+ result = api_instance.um_users_find_by_id(user_id, opts)
1575
+ p result
1576
+ rescue Ionoscloud::ApiError => e
1577
+ puts "Error when calling UserManagementApi->um_users_find_by_id: #{e}"
1578
+ end
1579
+ ```
1580
+
1581
+ #### Using the um_users_find_by_id_with_http_info variant
1582
+
1583
+ This returns an Array which contains the response data, status code and headers.
1584
+
1585
+ > <Array(<User>, Integer, Hash)> um_users_find_by_id_with_http_info(user_id, opts)
1586
+
1587
+ ```ruby
1588
+ begin
1589
+ # Retrieve users
1590
+ data, status_code, headers = api_instance.um_users_find_by_id_with_http_info(user_id, opts)
1591
+ p status_code # => 2xx
1592
+ p headers # => { ... }
1593
+ p data # => <User>
1594
+ rescue Ionoscloud::ApiError => e
1595
+ puts "Error when calling UserManagementApi->um_users_find_by_id_with_http_info: #{e}"
1596
+ end
1597
+ ```
1598
+
1599
+ ### Parameters
1600
+
1601
+ | Name | Type | Description | Notes |
1602
+ | ---- | ---- | ----------- | ----- |
1603
+ | **user_id** | **String** | The unique ID of the user. | |
1604
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1605
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1606
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1607
+
1608
+ ### Return type
1609
+
1610
+ [**User**](../models/User.md)
1611
+
1612
+ ### Authorization
1613
+
1614
+ Basic Authentication, Token Authentication
1615
+
1616
+ ### HTTP request headers
1617
+
1618
+ - **Content-Type**: Not defined
1619
+ - **Accept**: application/json
1620
+
1621
+
1622
+ ## um_users_get
1623
+
1624
+ > <Users> um_users_get(opts)
1625
+
1626
+ List all users
1627
+
1628
+ List all the users in your account.
1629
+
1630
+ ### Examples
1631
+
1632
+ ```ruby
1633
+ require 'time'
1634
+ require 'ionoscloud'
1635
+ # setup authorization
1636
+ Ionoscloud.configure do |config|
1637
+ # Configure HTTP basic authorization: Basic Authentication
1638
+ config.username = 'YOUR USERNAME'
1639
+ config.password = 'YOUR PASSWORD'
1640
+
1641
+ # Configure API key authorization: Token Authentication
1642
+ config.api_key['Authorization'] = 'YOUR API KEY'
1643
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1644
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1645
+ end
1646
+
1647
+ api_instance = Ionoscloud::UserManagementApi.new
1648
+ opts = {
1649
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1650
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1651
+ x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1652
+ offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
1653
+ limit: 56 # Integer | The maximum number of elements to return (use together with <code>offset</code> for pagination).
1654
+ }
1655
+
1656
+ begin
1657
+ # List all users
1658
+ result = api_instance.um_users_get(opts)
1659
+ p result
1660
+ rescue Ionoscloud::ApiError => e
1661
+ puts "Error when calling UserManagementApi->um_users_get: #{e}"
1662
+ end
1663
+ ```
1664
+
1665
+ #### Using the um_users_get_with_http_info variant
1666
+
1667
+ This returns an Array which contains the response data, status code and headers.
1668
+
1669
+ > <Array(<Users>, Integer, Hash)> um_users_get_with_http_info(opts)
1670
+
1671
+ ```ruby
1672
+ begin
1673
+ # List all users
1674
+ data, status_code, headers = api_instance.um_users_get_with_http_info(opts)
1675
+ p status_code # => 2xx
1676
+ p headers # => { ... }
1677
+ p data # => <Users>
1678
+ rescue Ionoscloud::ApiError => e
1679
+ puts "Error when calling UserManagementApi->um_users_get_with_http_info: #{e}"
1680
+ end
1681
+ ```
1682
+
1683
+ ### Parameters
1684
+
1685
+ | Name | Type | Description | Notes |
1686
+ | ---- | ---- | ----------- | ----- |
1687
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1688
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1689
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1690
+ | **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). | [optional][default to 0] |
1691
+ | **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] |
1692
+
1693
+ ### Return type
1694
+
1695
+ [**Users**](../models/Users.md)
1696
+
1697
+ ### Authorization
1698
+
1699
+ Basic Authentication, Token Authentication
1700
+
1701
+ ### HTTP request headers
1702
+
1703
+ - **Content-Type**: Not defined
1704
+ - **Accept**: application/json
1705
+
1706
+
1707
+ ## um_users_groups_get
1708
+
1709
+ > <ResourceGroups> um_users_groups_get(user_id, opts)
1710
+
1711
+ Retrieve group resources by user ID
1712
+
1713
+ Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
1714
+
1715
+ ### Examples
1716
+
1717
+ ```ruby
1718
+ require 'time'
1719
+ require 'ionoscloud'
1720
+ # setup authorization
1721
+ Ionoscloud.configure do |config|
1722
+ # Configure HTTP basic authorization: Basic Authentication
1723
+ config.username = 'YOUR USERNAME'
1724
+ config.password = 'YOUR PASSWORD'
1725
+
1726
+ # Configure API key authorization: Token Authentication
1727
+ config.api_key['Authorization'] = 'YOUR API KEY'
1728
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1729
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1730
+ end
1731
+
1732
+ api_instance = Ionoscloud::UserManagementApi.new
1733
+ user_id = 'user_id_example' # String | The unique ID of the user.
1734
+ opts = {
1735
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1736
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1737
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1738
+ }
1739
+
1740
+ begin
1741
+ # Retrieve group resources by user ID
1742
+ result = api_instance.um_users_groups_get(user_id, opts)
1743
+ p result
1744
+ rescue Ionoscloud::ApiError => e
1745
+ puts "Error when calling UserManagementApi->um_users_groups_get: #{e}"
1746
+ end
1747
+ ```
1748
+
1749
+ #### Using the um_users_groups_get_with_http_info variant
1750
+
1751
+ This returns an Array which contains the response data, status code and headers.
1752
+
1753
+ > <Array(<ResourceGroups>, Integer, Hash)> um_users_groups_get_with_http_info(user_id, opts)
1754
+
1755
+ ```ruby
1756
+ begin
1757
+ # Retrieve group resources by user ID
1758
+ data, status_code, headers = api_instance.um_users_groups_get_with_http_info(user_id, opts)
1759
+ p status_code # => 2xx
1760
+ p headers # => { ... }
1761
+ p data # => <ResourceGroups>
1762
+ rescue Ionoscloud::ApiError => e
1763
+ puts "Error when calling UserManagementApi->um_users_groups_get_with_http_info: #{e}"
1764
+ end
1765
+ ```
1766
+
1767
+ ### Parameters
1768
+
1769
+ | Name | Type | Description | Notes |
1770
+ | ---- | ---- | ----------- | ----- |
1771
+ | **user_id** | **String** | The unique ID of the user. | |
1772
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1773
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1774
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1775
+
1776
+ ### Return type
1777
+
1778
+ [**ResourceGroups**](../models/ResourceGroups.md)
1779
+
1780
+ ### Authorization
1781
+
1782
+ Basic Authentication, Token Authentication
1783
+
1784
+ ### HTTP request headers
1785
+
1786
+ - **Content-Type**: Not defined
1787
+ - **Accept**: application/json
1788
+
1789
+
1790
+ ## um_users_owns_get
1791
+
1792
+ > <ResourcesUsers> um_users_owns_get(user_id, opts)
1793
+
1794
+ Retrieve user resources by user ID
1795
+
1796
+ Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
1797
+
1798
+ ### Examples
1799
+
1800
+ ```ruby
1801
+ require 'time'
1802
+ require 'ionoscloud'
1803
+ # setup authorization
1804
+ Ionoscloud.configure do |config|
1805
+ # Configure HTTP basic authorization: Basic Authentication
1806
+ config.username = 'YOUR USERNAME'
1807
+ config.password = 'YOUR PASSWORD'
1808
+
1809
+ # Configure API key authorization: Token Authentication
1810
+ config.api_key['Authorization'] = 'YOUR API KEY'
1811
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1812
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1813
+ end
1814
+
1815
+ api_instance = Ionoscloud::UserManagementApi.new
1816
+ user_id = 'user_id_example' # String | The unique ID of the user.
1817
+ opts = {
1818
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1819
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1820
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1821
+ }
1822
+
1823
+ begin
1824
+ # Retrieve user resources by user ID
1825
+ result = api_instance.um_users_owns_get(user_id, opts)
1826
+ p result
1827
+ rescue Ionoscloud::ApiError => e
1828
+ puts "Error when calling UserManagementApi->um_users_owns_get: #{e}"
1829
+ end
1830
+ ```
1831
+
1832
+ #### Using the um_users_owns_get_with_http_info variant
1833
+
1834
+ This returns an Array which contains the response data, status code and headers.
1835
+
1836
+ > <Array(<ResourcesUsers>, Integer, Hash)> um_users_owns_get_with_http_info(user_id, opts)
1837
+
1838
+ ```ruby
1839
+ begin
1840
+ # Retrieve user resources by user ID
1841
+ data, status_code, headers = api_instance.um_users_owns_get_with_http_info(user_id, opts)
1842
+ p status_code # => 2xx
1843
+ p headers # => { ... }
1844
+ p data # => <ResourcesUsers>
1845
+ rescue Ionoscloud::ApiError => e
1846
+ puts "Error when calling UserManagementApi->um_users_owns_get_with_http_info: #{e}"
1847
+ end
1848
+ ```
1849
+
1850
+ ### Parameters
1851
+
1852
+ | Name | Type | Description | Notes |
1853
+ | ---- | ---- | ----------- | ----- |
1854
+ | **user_id** | **String** | The unique ID of the user. | |
1855
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1856
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1857
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1858
+
1859
+ ### Return type
1860
+
1861
+ [**ResourcesUsers**](../models/ResourcesUsers.md)
1862
+
1863
+ ### Authorization
1864
+
1865
+ Basic Authentication, Token Authentication
1866
+
1867
+ ### HTTP request headers
1868
+
1869
+ - **Content-Type**: Not defined
1870
+ - **Accept**: application/json
1871
+
1872
+
1873
+ ## um_users_post
1874
+
1875
+ > <User> um_users_post(user, opts)
1876
+
1877
+ Create users
1878
+
1879
+ Create a user.
1880
+
1881
+ ### Examples
1882
+
1883
+ ```ruby
1884
+ require 'time'
1885
+ require 'ionoscloud'
1886
+ # setup authorization
1887
+ Ionoscloud.configure do |config|
1888
+ # Configure HTTP basic authorization: Basic Authentication
1889
+ config.username = 'YOUR USERNAME'
1890
+ config.password = 'YOUR PASSWORD'
1891
+
1892
+ # Configure API key authorization: Token Authentication
1893
+ config.api_key['Authorization'] = 'YOUR API KEY'
1894
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1895
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1896
+ end
1897
+
1898
+ api_instance = Ionoscloud::UserManagementApi.new
1899
+ user = Ionoscloud::UserPost.new({properties: Ionoscloud::UserPropertiesPost.new}) # UserPost | The user to create.
1900
+ opts = {
1901
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1902
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1903
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1904
+ }
1905
+
1906
+ begin
1907
+ # Create users
1908
+ result = api_instance.um_users_post(user, opts)
1909
+ p result
1910
+ rescue Ionoscloud::ApiError => e
1911
+ puts "Error when calling UserManagementApi->um_users_post: #{e}"
1912
+ end
1913
+ ```
1914
+
1915
+ #### Using the um_users_post_with_http_info variant
1916
+
1917
+ This returns an Array which contains the response data, status code and headers.
1918
+
1919
+ > <Array(<User>, Integer, Hash)> um_users_post_with_http_info(user, opts)
1920
+
1921
+ ```ruby
1922
+ begin
1923
+ # Create users
1924
+ data, status_code, headers = api_instance.um_users_post_with_http_info(user, opts)
1925
+ p status_code # => 2xx
1926
+ p headers # => { ... }
1927
+ p data # => <User>
1928
+ rescue Ionoscloud::ApiError => e
1929
+ puts "Error when calling UserManagementApi->um_users_post_with_http_info: #{e}"
1930
+ end
1931
+ ```
1932
+
1933
+ ### Parameters
1934
+
1935
+ | Name | Type | Description | Notes |
1936
+ | ---- | ---- | ----------- | ----- |
1937
+ | **user** | [**UserPost**](UserPost.md) | The user to create. | |
1938
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
1939
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
1940
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
1941
+
1942
+ ### Return type
1943
+
1944
+ [**User**](../models/User.md)
1945
+
1946
+ ### Authorization
1947
+
1948
+ Basic Authentication, Token Authentication
1949
+
1950
+ ### HTTP request headers
1951
+
1952
+ - **Content-Type**: application/json
1953
+ - **Accept**: application/json
1954
+
1955
+
1956
+ ## um_users_put
1957
+
1958
+ > <User> um_users_put(user_id, user, opts)
1959
+
1960
+ Modify users
1961
+
1962
+ Modify the properties of the specified user.
1963
+
1964
+ ### Examples
1965
+
1966
+ ```ruby
1967
+ require 'time'
1968
+ require 'ionoscloud'
1969
+ # setup authorization
1970
+ Ionoscloud.configure do |config|
1971
+ # Configure HTTP basic authorization: Basic Authentication
1972
+ config.username = 'YOUR USERNAME'
1973
+ config.password = 'YOUR PASSWORD'
1974
+
1975
+ # Configure API key authorization: Token Authentication
1976
+ config.api_key['Authorization'] = 'YOUR API KEY'
1977
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1978
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1979
+ end
1980
+
1981
+ api_instance = Ionoscloud::UserManagementApi.new
1982
+ user_id = 'user_id_example' # String | The unique ID of the user.
1983
+ user = Ionoscloud::UserPut.new({properties: Ionoscloud::UserPropertiesPut.new}) # UserPut | The modified user
1984
+ opts = {
1985
+ pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
1986
+ depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
1987
+ x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
1988
+ }
1989
+
1990
+ begin
1991
+ # Modify users
1992
+ result = api_instance.um_users_put(user_id, user, opts)
1993
+ p result
1994
+ rescue Ionoscloud::ApiError => e
1995
+ puts "Error when calling UserManagementApi->um_users_put: #{e}"
1996
+ end
1997
+ ```
1998
+
1999
+ #### Using the um_users_put_with_http_info variant
2000
+
2001
+ This returns an Array which contains the response data, status code and headers.
2002
+
2003
+ > <Array(<User>, Integer, Hash)> um_users_put_with_http_info(user_id, user, opts)
2004
+
2005
+ ```ruby
2006
+ begin
2007
+ # Modify users
2008
+ data, status_code, headers = api_instance.um_users_put_with_http_info(user_id, user, opts)
2009
+ p status_code # => 2xx
2010
+ p headers # => { ... }
2011
+ p data # => <User>
2012
+ rescue Ionoscloud::ApiError => e
2013
+ puts "Error when calling UserManagementApi->um_users_put_with_http_info: #{e}"
2014
+ end
2015
+ ```
2016
+
2017
+ ### Parameters
2018
+
2019
+ | Name | Type | Description | Notes |
2020
+ | ---- | ---- | ----------- | ----- |
2021
+ | **user_id** | **String** | The unique ID of the user. | |
2022
+ | **user** | [**UserPut**](UserPut.md) | The modified user | |
2023
+ | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
2024
+ | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth&#x3D;0: Only direct properties are included; children (servers and other elements) 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] |
2025
+ | **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, against which all API requests are to be executed. | [optional] |
2026
+
2027
+ ### Return type
2028
+
2029
+ [**User**](../models/User.md)
2030
+
2031
+ ### Authorization
2032
+
2033
+ Basic Authentication, Token Authentication
2034
+
2035
+ ### HTTP request headers
2036
+
2037
+ - **Content-Type**: application/json
2038
+ - **Accept**: application/json
2039
+