ionoscloud 5.0.0 → 6.0.0.beta.3

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