ionoscloud 5.1.2 → 6.0.0.beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (601) hide show
  1. checksums.yaml +4 -4
  2. data/docs/{models/AttachedVolumes.md → AttachedVolumes.md} +1 -1
  3. data/docs/{models/BackupUnit.md → BackupUnit.md} +0 -0
  4. data/docs/{models/BackupUnitProperties.md → BackupUnitProperties.md} +0 -0
  5. data/docs/{models/BackupUnitSSO.md → BackupUnitSSO.md} +0 -0
  6. data/docs/{models/BackupUnits.md → BackupUnits.md} +0 -0
  7. data/docs/{api/BackupUnitApi.md → BackupUnitsApi.md} +42 -42
  8. data/docs/{models/BalancedNics.md → BalancedNics.md} +0 -0
  9. data/docs/CHANGELOG.md +1 -0
  10. data/docs/{models/Cdroms.md → Cdroms.md} +1 -1
  11. data/docs/{models/ConnectableDatacenter.md → ConnectableDatacenter.md} +0 -0
  12. data/docs/{models/Contract.md → Contract.md} +0 -0
  13. data/docs/{models/ContractProperties.md → ContractProperties.md} +0 -0
  14. data/docs/{api/ContractApi.md → ContractResourcesApi.md} +11 -11
  15. data/docs/Contracts.md +24 -0
  16. data/docs/CpuArchitectureProperties.md +24 -0
  17. data/docs/{models/DataCenterEntities.md → DataCenterEntities.md} +5 -1
  18. data/docs/{api/DataCenterApi.md → DataCentersApi.md} +31 -31
  19. data/docs/{models/Datacenter.md → Datacenter.md} +0 -0
  20. data/docs/{models/DatacenterElementMetadata.md → DatacenterElementMetadata.md} +0 -0
  21. data/docs/{models/DatacenterProperties.md → DatacenterProperties.md} +3 -1
  22. data/docs/{models/Datacenters.md → Datacenters.md} +0 -0
  23. data/docs/{api/DefaultApi.md → DefaultApi.md} +2 -13
  24. data/docs/{models/Error.md → Error.md} +0 -0
  25. data/docs/{models/ErrorMessage.md → ErrorMessage.md} +0 -0
  26. data/docs/{models/FirewallRule.md → FirewallRule.md} +0 -0
  27. data/docs/{models/FirewallRules.md → FirewallRules.md} +0 -0
  28. data/docs/FirewallRulesApi.md +553 -0
  29. data/docs/{models/FirewallruleProperties.md → FirewallruleProperties.md} +3 -1
  30. data/docs/FlowLog.md +26 -0
  31. data/docs/FlowLogProperties.md +24 -0
  32. data/docs/FlowLogPut.md +24 -0
  33. data/docs/FlowLogs.md +30 -0
  34. data/docs/FlowLogsApi.md +541 -0
  35. data/docs/{models/Group.md → Group.md} +1 -1
  36. data/docs/{models/GroupEntities.md → GroupEntities.md} +0 -0
  37. data/docs/{models/GroupMembers.md → GroupMembers.md} +1 -1
  38. data/docs/{models/GroupProperties.md → GroupProperties.md} +5 -1
  39. data/docs/{models/GroupShare.md → GroupShare.md} +1 -1
  40. data/docs/{models/GroupShareProperties.md → GroupShareProperties.md} +0 -0
  41. data/docs/{models/GroupShares.md → GroupShares.md} +1 -1
  42. data/docs/{models/GroupUsers.md → GroupUsers.md} +1 -1
  43. data/docs/{models/Groups.md → Groups.md} +1 -1
  44. data/docs/{api/IPBlocksApi.md → IPBlocksApi.md} +7 -11
  45. data/docs/{models/IPFailover.md → IPFailover.md} +0 -0
  46. data/docs/{models/Image.md → Image.md} +0 -0
  47. data/docs/{models/ImageProperties.md → ImageProperties.md} +1 -5
  48. data/docs/{models/Images.md → Images.md} +0 -0
  49. data/docs/{api/ImageApi.md → ImagesApi.md} +25 -25
  50. data/docs/{models/Info.md → Info.md} +0 -0
  51. data/docs/{models/IpBlock.md → IpBlock.md} +0 -0
  52. data/docs/{models/IpBlockProperties.md → IpBlockProperties.md} +1 -1
  53. data/docs/IpBlocks.md +24 -0
  54. data/docs/{models/IpConsumer.md → IpConsumer.md} +1 -5
  55. data/docs/{api/KubernetesApi.md → KubernetesApi.md} +17 -93
  56. data/docs/{models/KubernetesAutoScaling.md → KubernetesAutoScaling.md} +2 -2
  57. data/docs/{models/KubernetesCluster.md → KubernetesCluster.md} +0 -0
  58. data/docs/{models/KubernetesClusterEntities.md → KubernetesClusterEntities.md} +0 -0
  59. data/docs/{models/KubernetesClusterForPost.md → KubernetesClusterForPost.md} +0 -0
  60. data/docs/{models/KubernetesClusterForPut.md → KubernetesClusterForPut.md} +0 -0
  61. data/docs/{models/KubernetesClusterProperties.md → KubernetesClusterProperties.md} +4 -4
  62. data/docs/{models/KubernetesClusterPropertiesForPost.md → KubernetesClusterPropertiesForPost.md} +4 -4
  63. data/docs/{models/KubernetesClusterPropertiesForPut.md → KubernetesClusterPropertiesForPut.md} +1 -5
  64. data/docs/{models/KubernetesClusters.md → KubernetesClusters.md} +1 -1
  65. data/docs/{models/KubernetesMaintenanceWindow.md → KubernetesMaintenanceWindow.md} +2 -2
  66. data/docs/{models/KubernetesNode.md → KubernetesNode.md} +0 -0
  67. data/docs/{models/KubernetesNodeMetadata.md → KubernetesNodeMetadata.md} +0 -0
  68. data/docs/{models/KubernetesNodePool.md → KubernetesNodePool.md} +0 -0
  69. data/docs/{models/KubernetesNodePoolForPost.md → KubernetesNodePoolForPost.md} +0 -0
  70. data/docs/{models/KubernetesNodePoolForPut.md → KubernetesNodePoolForPut.md} +0 -0
  71. data/docs/KubernetesNodePoolLan.md +22 -0
  72. data/docs/KubernetesNodePoolLanRoutes.md +20 -0
  73. data/docs/{models/KubernetesNodePoolProperties.md → KubernetesNodePoolProperties.md} +2 -1
  74. data/docs/{models/KubernetesNodePoolPropertiesForPost.md → KubernetesNodePoolPropertiesForPost.md} +2 -1
  75. data/docs/{models/KubernetesNodePoolPropertiesForPut.md → KubernetesNodePoolPropertiesForPut.md} +0 -0
  76. data/docs/{models/KubernetesNodePools.md → KubernetesNodePools.md} +1 -1
  77. data/docs/{models/KubernetesNodeProperties.md → KubernetesNodeProperties.md} +0 -0
  78. data/docs/{models/KubernetesNodes.md → KubernetesNodes.md} +0 -0
  79. data/docs/{models/Label.md → Label.md} +0 -0
  80. data/docs/{models/LabelProperties.md → LabelProperties.md} +0 -0
  81. data/docs/{models/LabelResource.md → LabelResource.md} +0 -0
  82. data/docs/{models/LabelResourceProperties.md → LabelResourceProperties.md} +0 -0
  83. data/docs/{models/LabelResources.md → LabelResources.md} +0 -0
  84. data/docs/{models/Labels.md → Labels.md} +0 -0
  85. data/docs/{api/LabelApi.md → LabelsApi.md} +128 -132
  86. data/docs/{models/Lan.md → Lan.md} +0 -0
  87. data/docs/{models/LanEntities.md → LanEntities.md} +0 -0
  88. data/docs/{models/LanNics.md → LanNics.md} +0 -0
  89. data/docs/{models/LanPost.md → LanPost.md} +0 -0
  90. data/docs/{models/LanProperties.md → LanProperties.md} +0 -0
  91. data/docs/{models/LanPropertiesPost.md → LanPropertiesPost.md} +0 -0
  92. data/docs/{models/Lans.md → Lans.md} +1 -1
  93. data/docs/{api/LanApi.md → LansApi.md} +55 -55
  94. data/docs/{api/LoadBalancerApi.md → LoadBalancersApi.md} +73 -69
  95. data/docs/{models/Loadbalancer.md → Loadbalancer.md} +0 -0
  96. data/docs/{models/LoadbalancerEntities.md → LoadbalancerEntities.md} +0 -0
  97. data/docs/{models/LoadbalancerProperties.md → LoadbalancerProperties.md} +0 -0
  98. data/docs/{models/Loadbalancers.md → Loadbalancers.md} +0 -0
  99. data/docs/{models/Location.md → Location.md} +0 -0
  100. data/docs/{models/LocationProperties.md → LocationProperties.md} +3 -1
  101. data/docs/{models/Locations.md → Locations.md} +0 -0
  102. data/docs/{api/LocationApi.md → LocationsApi.md} +14 -14
  103. data/docs/NATGatewaysApi.md +1581 -0
  104. data/docs/NatGateway.md +28 -0
  105. data/docs/NatGatewayEntities.md +20 -0
  106. data/docs/NatGatewayLanProperties.md +20 -0
  107. data/docs/NatGatewayProperties.md +22 -0
  108. data/docs/NatGatewayPut.md +24 -0
  109. data/docs/NatGatewayRule.md +26 -0
  110. data/docs/NatGatewayRuleProperties.md +30 -0
  111. data/docs/{models/S3Bucket.md → NatGatewayRuleProtocol.md} +2 -5
  112. data/docs/NatGatewayRulePut.md +24 -0
  113. data/docs/NatGatewayRuleType.md +15 -0
  114. data/docs/NatGatewayRules.md +24 -0
  115. data/docs/NatGateways.md +30 -0
  116. data/docs/NetworkInterfacesApi.md +541 -0
  117. data/docs/NetworkLoadBalancer.md +28 -0
  118. data/docs/NetworkLoadBalancerEntities.md +20 -0
  119. data/docs/NetworkLoadBalancerForwardingRule.md +26 -0
  120. data/docs/NetworkLoadBalancerForwardingRuleHealthCheck.md +26 -0
  121. data/docs/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
  122. data/docs/NetworkLoadBalancerForwardingRulePut.md +24 -0
  123. data/docs/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
  124. data/docs/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
  125. data/docs/NetworkLoadBalancerForwardingRules.md +30 -0
  126. data/docs/NetworkLoadBalancerProperties.md +26 -0
  127. data/docs/NetworkLoadBalancerPut.md +24 -0
  128. data/docs/NetworkLoadBalancers.md +30 -0
  129. data/docs/NetworkLoadBalancersApi.md +1593 -0
  130. data/docs/{models/Nic.md → Nic.md} +0 -0
  131. data/docs/{models/NicEntities.md → NicEntities.md} +2 -0
  132. data/docs/{models/NicProperties.md → NicProperties.md} +6 -2
  133. data/docs/NicPut.md +24 -0
  134. data/docs/{models/Nics.md → Nics.md} +1 -1
  135. data/docs/{models/NoStateMetaData.md → NoStateMetaData.md} +0 -0
  136. data/docs/{models/PaginationLinks.md → PaginationLinks.md} +0 -0
  137. data/docs/{models/Peer.md → Peer.md} +0 -0
  138. data/docs/{models/PrivateCrossConnect.md → PrivateCrossConnect.md} +0 -0
  139. data/docs/{models/PrivateCrossConnectProperties.md → PrivateCrossConnectProperties.md} +0 -0
  140. data/docs/{models/PrivateCrossConnects.md → PrivateCrossConnects.md} +0 -0
  141. data/docs/{api/PrivateCrossConnectApi.md → PrivateCrossConnectsApi.md} +34 -30
  142. data/docs/README.md +4 -4
  143. data/docs/RemoteConsoleUrl.md +18 -0
  144. data/docs/{models/Request.md → Request.md} +0 -0
  145. data/docs/{models/RequestMetadata.md → RequestMetadata.md} +0 -0
  146. data/docs/{models/RequestProperties.md → RequestProperties.md} +0 -0
  147. data/docs/{models/RequestStatus.md → RequestStatus.md} +0 -0
  148. data/docs/{models/RequestStatusMetadata.md → RequestStatusMetadata.md} +0 -0
  149. data/docs/{models/RequestTarget.md → RequestTarget.md} +0 -0
  150. data/docs/{models/Requests.md → Requests.md} +1 -1
  151. data/docs/{api/RequestApi.md → RequestsApi.md} +24 -40
  152. data/docs/{models/Resource.md → Resource.md} +1 -1
  153. data/docs/{models/ResourceEntities.md → ResourceEntities.md} +0 -0
  154. data/docs/{models/ResourceGroups.md → ResourceGroups.md} +1 -1
  155. data/docs/{models/ResourceLimits.md → ResourceLimits.md} +11 -1
  156. data/docs/{models/ResourceProperties.md → ResourceProperties.md} +0 -0
  157. data/docs/{models/ResourceReference.md → ResourceReference.md} +0 -0
  158. data/docs/{models/Resources.md → Resources.md} +1 -1
  159. data/docs/{models/ResourcesUsers.md → ResourcesUsers.md} +1 -1
  160. data/docs/{models/S3Key.md → S3Key.md} +1 -1
  161. data/docs/{models/S3KeyMetadata.md → S3KeyMetadata.md} +0 -0
  162. data/docs/{models/S3KeyProperties.md → S3KeyProperties.md} +0 -0
  163. data/docs/{models/S3Keys.md → S3Keys.md} +1 -1
  164. data/docs/{models/S3ObjectStorageSSO.md → S3ObjectStorageSSO.md} +0 -0
  165. data/docs/{models/Server.md → Server.md} +0 -0
  166. data/docs/{models/ServerEntities.md → ServerEntities.md} +0 -0
  167. data/docs/{models/ServerProperties.md → ServerProperties.md} +6 -2
  168. data/docs/{models/Servers.md → Servers.md} +0 -0
  169. data/docs/{api/ServerApi.md → ServersApi.md} +430 -86
  170. data/docs/{models/Snapshot.md → Snapshot.md} +0 -0
  171. data/docs/{models/SnapshotProperties.md → SnapshotProperties.md} +0 -0
  172. data/docs/{models/Snapshots.md → Snapshots.md} +0 -0
  173. data/docs/{api/SnapshotApi.md → SnapshotsApi.md} +28 -28
  174. data/docs/TargetPortRange.md +20 -0
  175. data/docs/Template.md +26 -0
  176. data/docs/TemplateProperties.md +24 -0
  177. data/docs/Templates.md +24 -0
  178. data/docs/TemplatesApi.md +165 -0
  179. data/docs/Token.md +18 -0
  180. data/docs/{models/Type.md → Type.md} +0 -0
  181. data/docs/{models/User.md → User.md} +0 -0
  182. data/docs/{api/UserManagementApi.md → UserManagementApi.md} +12 -526
  183. data/docs/{models/UserMetadata.md → UserMetadata.md} +0 -0
  184. data/docs/{models/UserPost.md → UserPost.md} +0 -0
  185. data/docs/{models/UserProperties.md → UserProperties.md} +0 -0
  186. data/docs/{models/UserPropertiesPost.md → UserPropertiesPost.md} +0 -0
  187. data/docs/{models/UserPropertiesPut.md → UserPropertiesPut.md} +0 -0
  188. data/docs/{models/UserPut.md → UserPut.md} +0 -0
  189. data/docs/UserS3KeysApi.md +517 -0
  190. data/docs/Users.md +24 -0
  191. data/docs/{models/UsersEntities.md → UsersEntities.md} +0 -0
  192. data/docs/{models/Volume.md → Volume.md} +0 -0
  193. data/docs/{models/VolumeProperties.md → VolumeProperties.md} +5 -5
  194. data/docs/{models/Volumes.md → Volumes.md} +0 -0
  195. data/docs/{api/VolumeApi.md → VolumesApi.md} +42 -42
  196. data/docs/summary.md +386 -159
  197. data/ionoscloud.gemspec +2 -2
  198. data/lib/ionoscloud/api/_api.rb +3 -3
  199. data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +56 -56
  200. data/lib/ionoscloud/api/{contract_api.rb → contract_resources_api.rb} +13 -13
  201. data/lib/ionoscloud/api/{data_center_api.rb → data_centers_api.rb} +49 -49
  202. data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
  203. data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
  204. data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +36 -36
  205. data/lib/ionoscloud/api/ip_blocks_api.rb +12 -30
  206. data/lib/ionoscloud/api/kubernetes_api.rb +17 -80
  207. data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +245 -263
  208. data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +101 -101
  209. data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +144 -126
  210. data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +21 -21
  211. data/lib/ionoscloud/api/nat_gateways_api.rb +1690 -0
  212. data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
  213. data/lib/ionoscloud/api/network_load_balancers_api.rb +1708 -0
  214. data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +57 -39
  215. data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +33 -57
  216. data/lib/ionoscloud/api/{server_api.rb → servers_api.rb} +501 -157
  217. data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +42 -42
  218. data/lib/ionoscloud/api/templates_api.rb +164 -0
  219. data/lib/ionoscloud/api/user_management_api.rb +12 -525
  220. data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
  221. data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +71 -71
  222. data/lib/ionoscloud/api_client.rb +21 -21
  223. data/lib/ionoscloud/api_error.rb +2 -2
  224. data/lib/ionoscloud/configuration.rb +6 -6
  225. data/lib/ionoscloud/models/attached_volumes.rb +13 -69
  226. data/lib/ionoscloud/models/backup_unit.rb +7 -49
  227. data/lib/ionoscloud/models/backup_unit_properties.rb +5 -31
  228. data/lib/ionoscloud/models/backup_unit_sso.rb +3 -13
  229. data/lib/ionoscloud/models/backup_units.rb +12 -44
  230. data/lib/ionoscloud/models/balanced_nics.rb +13 -69
  231. data/lib/ionoscloud/models/cdroms.rb +13 -69
  232. data/lib/ionoscloud/models/connectable_datacenter.rb +5 -31
  233. data/lib/ionoscloud/models/contract.rb +4 -22
  234. data/lib/ionoscloud/models/contract_properties.rb +7 -49
  235. data/lib/ionoscloud/models/contracts.rb +249 -0
  236. data/lib/ionoscloud/models/cpu_architecture_properties.rb +247 -0
  237. data/lib/ionoscloud/models/data_center_entities.rb +27 -43
  238. data/lib/ionoscloud/models/datacenter.rb +8 -58
  239. data/lib/ionoscloud/models/datacenter_element_metadata.rb +12 -78
  240. data/lib/ionoscloud/models/datacenter_properties.rb +49 -63
  241. data/lib/ionoscloud/models/datacenters.rb +13 -69
  242. data/lib/ionoscloud/models/error.rb +8 -24
  243. data/lib/ionoscloud/models/error_message.rb +4 -22
  244. data/lib/ionoscloud/models/firewall_rule.rb +7 -49
  245. data/lib/ionoscloud/models/firewall_rules.rb +13 -69
  246. data/lib/ionoscloud/models/firewallrule_properties.rb +57 -124
  247. data/lib/ionoscloud/models/flow_log.rb +260 -0
  248. data/lib/ionoscloud/models/flow_log_properties.rb +313 -0
  249. data/lib/ionoscloud/models/{kubernetes_config.rb → flow_log_put.rb} +13 -81
  250. data/lib/ionoscloud/models/flow_logs.rb +278 -0
  251. data/lib/ionoscloud/models/group.rb +7 -49
  252. data/lib/ionoscloud/models/group_entities.rb +4 -22
  253. data/lib/ionoscloud/models/group_members.rb +10 -42
  254. data/lib/ionoscloud/models/group_properties.rb +35 -97
  255. data/lib/ionoscloud/models/group_share.rb +6 -40
  256. data/lib/ionoscloud/models/group_share_properties.rb +4 -22
  257. data/lib/ionoscloud/models/group_shares.rb +10 -42
  258. data/lib/ionoscloud/models/group_users.rb +10 -42
  259. data/lib/ionoscloud/models/groups.rb +10 -42
  260. data/lib/ionoscloud/models/image.rb +7 -49
  261. data/lib/ionoscloud/models/image_properties.rb +24 -210
  262. data/lib/ionoscloud/models/images.rb +10 -42
  263. data/lib/ionoscloud/models/info.rb +5 -31
  264. data/lib/ionoscloud/models/ip_block.rb +7 -49
  265. data/lib/ionoscloud/models/ip_block_properties.rb +15 -53
  266. data/lib/ionoscloud/models/ip_blocks.rb +13 -98
  267. data/lib/ionoscloud/models/ip_consumer.rb +12 -104
  268. data/lib/ionoscloud/models/ip_failover.rb +4 -22
  269. data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +13 -21
  270. data/lib/ionoscloud/models/kubernetes_cluster.rb +8 -58
  271. data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +3 -13
  272. data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +8 -58
  273. data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +8 -58
  274. data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +32 -84
  275. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +22 -62
  276. data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +8 -70
  277. data/lib/ionoscloud/models/kubernetes_clusters.rb +11 -43
  278. data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +13 -21
  279. data/lib/ionoscloud/models/kubernetes_node.rb +7 -49
  280. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +9 -51
  281. data/lib/ionoscloud/models/kubernetes_node_pool.rb +7 -49
  282. data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +7 -49
  283. data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +7 -49
  284. data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +28 -21
  285. data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +227 -0
  286. data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +42 -170
  287. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +37 -159
  288. data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +27 -93
  289. data/lib/ionoscloud/models/kubernetes_node_pools.rb +11 -43
  290. data/lib/ionoscloud/models/kubernetes_node_properties.rb +6 -40
  291. data/lib/ionoscloud/models/kubernetes_nodes.rb +10 -42
  292. data/lib/ionoscloud/models/label.rb +7 -49
  293. data/lib/ionoscloud/models/label_properties.rb +7 -49
  294. data/lib/ionoscloud/models/label_resource.rb +7 -49
  295. data/lib/ionoscloud/models/label_resource_properties.rb +4 -22
  296. data/lib/ionoscloud/models/label_resources.rb +15 -71
  297. data/lib/ionoscloud/models/labels.rb +12 -44
  298. data/lib/ionoscloud/models/lan.rb +8 -58
  299. data/lib/ionoscloud/models/lan_entities.rb +3 -13
  300. data/lib/ionoscloud/models/lan_nics.rb +13 -69
  301. data/lib/ionoscloud/models/lan_post.rb +8 -58
  302. data/lib/ionoscloud/models/lan_properties.rb +10 -42
  303. data/lib/ionoscloud/models/lan_properties_post.rb +10 -42
  304. data/lib/ionoscloud/models/lans.rb +14 -70
  305. data/lib/ionoscloud/models/loadbalancer.rb +8 -58
  306. data/lib/ionoscloud/models/loadbalancer_entities.rb +3 -13
  307. data/lib/ionoscloud/models/loadbalancer_properties.rb +34 -43
  308. data/lib/ionoscloud/models/loadbalancers.rb +13 -69
  309. data/lib/ionoscloud/models/location.rb +7 -49
  310. data/lib/ionoscloud/models/location_properties.rb +49 -37
  311. data/lib/ionoscloud/models/locations.rb +10 -42
  312. data/lib/ionoscloud/models/nat_gateway.rb +269 -0
  313. data/lib/ionoscloud/models/nat_gateway_entities.rb +225 -0
  314. data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +234 -0
  315. data/lib/ionoscloud/models/nat_gateway_properties.rb +251 -0
  316. data/lib/ionoscloud/models/nat_gateway_put.rb +251 -0
  317. data/lib/ionoscloud/models/nat_gateway_rule.rb +260 -0
  318. data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +291 -0
  319. data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
  320. data/lib/ionoscloud/models/nat_gateway_rule_put.rb +251 -0
  321. data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
  322. data/lib/ionoscloud/models/nat_gateway_rules.rb +249 -0
  323. data/lib/ionoscloud/models/nat_gateways.rb +278 -0
  324. data/lib/ionoscloud/models/network_load_balancer.rb +269 -0
  325. data/lib/ionoscloud/models/network_load_balancer_entities.rb +225 -0
  326. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +260 -0
  327. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +257 -0
  328. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +354 -0
  329. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +251 -0
  330. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +261 -0
  331. data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +237 -0
  332. data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +278 -0
  333. data/lib/ionoscloud/models/network_load_balancer_properties.rb +276 -0
  334. data/lib/ionoscloud/models/network_load_balancer_put.rb +251 -0
  335. data/lib/ionoscloud/models/network_load_balancers.rb +278 -0
  336. data/lib/ionoscloud/models/nic.rb +8 -58
  337. data/lib/ionoscloud/models/nic_entities.rb +13 -14
  338. data/lib/ionoscloud/models/nic_properties.rb +71 -73
  339. data/lib/ionoscloud/models/nic_put.rb +251 -0
  340. data/lib/ionoscloud/models/nics.rb +13 -69
  341. data/lib/ionoscloud/models/no_state_meta_data.rb +9 -67
  342. data/lib/ionoscloud/models/pagination_links.rb +5 -31
  343. data/lib/ionoscloud/models/peer.rb +7 -49
  344. data/lib/ionoscloud/models/private_cross_connect.rb +7 -49
  345. data/lib/ionoscloud/models/private_cross_connect_properties.rb +14 -44
  346. data/lib/ionoscloud/models/private_cross_connects.rb +10 -42
  347. data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +13 -23
  348. data/lib/ionoscloud/models/request.rb +7 -49
  349. data/lib/ionoscloud/models/request_metadata.rb +6 -40
  350. data/lib/ionoscloud/models/request_properties.rb +10 -42
  351. data/lib/ionoscloud/models/request_status.rb +6 -40
  352. data/lib/ionoscloud/models/request_status_metadata.rb +10 -42
  353. data/lib/ionoscloud/models/request_target.rb +4 -22
  354. data/lib/ionoscloud/models/requests.rb +14 -70
  355. data/lib/ionoscloud/models/resource.rb +8 -58
  356. data/lib/ionoscloud/models/resource_entities.rb +3 -13
  357. data/lib/ionoscloud/models/resource_groups.rb +10 -42
  358. data/lib/ionoscloud/models/resource_limits.rb +94 -157
  359. data/lib/ionoscloud/models/resource_properties.rb +4 -22
  360. data/lib/ionoscloud/models/resource_reference.rb +5 -31
  361. data/lib/ionoscloud/models/resources.rb +10 -42
  362. data/lib/ionoscloud/models/resources_users.rb +10 -42
  363. data/lib/ionoscloud/models/s3_key.rb +7 -49
  364. data/lib/ionoscloud/models/s3_key_metadata.rb +4 -22
  365. data/lib/ionoscloud/models/s3_key_properties.rb +4 -22
  366. data/lib/ionoscloud/models/s3_keys.rb +10 -42
  367. data/lib/ionoscloud/models/s3_object_storage_sso.rb +3 -13
  368. data/lib/ionoscloud/models/server.rb +8 -58
  369. data/lib/ionoscloud/models/server_entities.rb +5 -31
  370. data/lib/ionoscloud/models/server_properties.rb +36 -82
  371. data/lib/ionoscloud/models/servers.rb +13 -69
  372. data/lib/ionoscloud/models/snapshot.rb +7 -49
  373. data/lib/ionoscloud/models/snapshot_properties.rb +18 -148
  374. data/lib/ionoscloud/models/snapshots.rb +10 -42
  375. data/lib/ionoscloud/models/target_port_range.rb +227 -0
  376. data/lib/ionoscloud/models/template.rb +260 -0
  377. data/lib/ionoscloud/models/template_properties.rb +267 -0
  378. data/lib/ionoscloud/models/templates.rb +249 -0
  379. data/lib/ionoscloud/models/{s3_bucket.rb → token.rb} +13 -28
  380. data/lib/ionoscloud/models/type.rb +10 -2
  381. data/lib/ionoscloud/models/user.rb +8 -58
  382. data/lib/ionoscloud/models/user_metadata.rb +5 -31
  383. data/lib/ionoscloud/models/user_post.rb +3 -13
  384. data/lib/ionoscloud/models/user_properties.rb +10 -76
  385. data/lib/ionoscloud/models/user_properties_post.rb +10 -76
  386. data/lib/ionoscloud/models/user_properties_put.rb +9 -67
  387. data/lib/ionoscloud/models/user_put.rb +4 -22
  388. data/lib/ionoscloud/models/users.rb +13 -98
  389. data/lib/ionoscloud/models/users_entities.rb +4 -22
  390. data/lib/ionoscloud/models/volume.rb +7 -49
  391. data/lib/ionoscloud/models/volume_properties.rb +40 -191
  392. data/lib/ionoscloud/models/volumes.rb +13 -69
  393. data/lib/ionoscloud/version.rb +3 -3
  394. data/lib/ionoscloud.rb +60 -19
  395. data/spec/api/_api_spec.rb +49 -0
  396. data/spec/api/backup_units_api_spec.rb +140 -0
  397. data/spec/api/contract_resources_api_spec.rb +49 -0
  398. data/spec/api/data_centers_api_spec.rb +128 -0
  399. data/spec/api/firewall_rules_api_spec.rb +146 -0
  400. data/spec/api/flow_logs_api_spec.rb +140 -0
  401. data/spec/api/images_api_spec.rb +111 -0
  402. data/spec/api/ip_blocks_api_spec.rb +126 -0
  403. data/spec/api/kubernetes_api_spec.rb +294 -0
  404. data/spec/api/labels_api_spec.rb +478 -0
  405. data/spec/api/lans_api_spec.rb +186 -0
  406. data/spec/api/load_balancers_api_spec.rb +205 -0
  407. data/spec/api/locations_api_spec.rb +80 -0
  408. data/spec/api/nat_gateways_api_spec.rb +336 -0
  409. data/spec/api/network_interfaces_api_spec.rb +140 -0
  410. data/spec/api/network_load_balancers_api_spec.rb +342 -0
  411. data/spec/api/private_cross_connects_api_spec.rb +112 -0
  412. data/spec/api/requests_api_spec.rb +84 -0
  413. data/spec/api/servers_api_spec.rb +401 -0
  414. data/spec/api/snapshots_api_spec.rb +111 -0
  415. data/spec/api/templates_api_spec.rb +60 -0
  416. data/spec/api/user_management_api_spec.rb +402 -0
  417. data/spec/api/user_s3_keys_api_spec.rb +128 -0
  418. data/spec/api/volumes_api_spec.rb +171 -0
  419. data/spec/api_client_spec.rb +2 -2
  420. data/spec/configuration_spec.rb +5 -5
  421. data/spec/models/attached_volumes_spec.rb +70 -0
  422. data/spec/models/backup_unit_properties_spec.rb +46 -0
  423. data/spec/models/backup_unit_spec.rb +62 -0
  424. data/spec/models/backup_unit_sso_spec.rb +34 -0
  425. data/spec/models/backup_units_spec.rb +56 -0
  426. data/spec/models/balanced_nics_spec.rb +70 -0
  427. data/spec/models/cdroms_spec.rb +70 -0
  428. data/spec/models/connectable_datacenter_spec.rb +46 -0
  429. data/spec/models/contract_properties_spec.rb +58 -0
  430. data/spec/models/contract_spec.rb +40 -0
  431. data/spec/models/contracts_spec.rb +52 -0
  432. data/spec/models/cpu_architecture_properties_spec.rb +52 -0
  433. data/spec/models/data_center_entities_spec.rb +64 -0
  434. data/spec/models/datacenter_element_metadata_spec.rb +80 -0
  435. data/spec/models/datacenter_properties_spec.rb +74 -0
  436. data/spec/models/datacenter_spec.rb +64 -0
  437. data/spec/models/datacenters_spec.rb +70 -0
  438. data/spec/models/error_message_spec.rb +40 -0
  439. data/spec/models/error_spec.rb +40 -0
  440. data/spec/models/firewall_rule_spec.rb +58 -0
  441. data/spec/models/firewall_rules_spec.rb +70 -0
  442. data/spec/models/firewallrule_properties_spec.rb +108 -0
  443. data/spec/models/flow_log_properties_spec.rb +60 -0
  444. data/spec/models/flow_log_put_spec.rb +52 -0
  445. data/spec/models/flow_log_spec.rb +58 -0
  446. data/spec/models/flow_logs_spec.rb +70 -0
  447. data/spec/models/group_entities_spec.rb +40 -0
  448. data/spec/models/group_members_spec.rb +52 -0
  449. data/spec/models/group_properties_spec.rb +100 -0
  450. data/spec/models/group_share_properties_spec.rb +40 -0
  451. data/spec/models/group_share_spec.rb +52 -0
  452. data/spec/models/group_shares_spec.rb +52 -0
  453. data/spec/models/group_spec.rb +58 -0
  454. data/spec/models/group_users_spec.rb +52 -0
  455. data/spec/models/groups_spec.rb +52 -0
  456. data/spec/models/image_properties_spec.rb +138 -0
  457. data/spec/models/image_spec.rb +58 -0
  458. data/spec/models/images_spec.rb +52 -0
  459. data/spec/models/info_spec.rb +46 -0
  460. data/spec/models/ip_block_properties_spec.rb +58 -0
  461. data/spec/models/ip_block_spec.rb +58 -0
  462. data/spec/models/ip_blocks_spec.rb +52 -0
  463. data/spec/models/ip_consumer_spec.rb +70 -0
  464. data/spec/models/ip_failover_spec.rb +40 -0
  465. data/spec/models/kubernetes_auto_scaling_spec.rb +40 -0
  466. data/spec/models/kubernetes_cluster_entities_spec.rb +34 -0
  467. data/spec/models/kubernetes_cluster_for_post_spec.rb +68 -0
  468. data/spec/models/kubernetes_cluster_for_put_spec.rb +68 -0
  469. data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +58 -0
  470. data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +46 -0
  471. data/spec/models/kubernetes_cluster_properties_spec.rb +70 -0
  472. data/spec/models/kubernetes_cluster_spec.rb +68 -0
  473. data/spec/models/kubernetes_clusters_spec.rb +56 -0
  474. data/spec/models/kubernetes_maintenance_window_spec.rb +44 -0
  475. data/spec/models/kubernetes_node_metadata_spec.rb +62 -0
  476. data/spec/models/kubernetes_node_pool_for_post_spec.rb +62 -0
  477. data/spec/models/kubernetes_node_pool_for_put_spec.rb +62 -0
  478. data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
  479. data/spec/models/kubernetes_node_pool_lan_spec.rb +46 -0
  480. data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +132 -0
  481. data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +82 -0
  482. data/spec/models/kubernetes_node_pool_properties_spec.rb +138 -0
  483. data/spec/models/kubernetes_node_pool_spec.rb +62 -0
  484. data/spec/models/kubernetes_node_pools_spec.rb +56 -0
  485. data/spec/models/kubernetes_node_properties_spec.rb +52 -0
  486. data/spec/models/kubernetes_node_spec.rb +62 -0
  487. data/spec/models/kubernetes_nodes_spec.rb +56 -0
  488. data/spec/models/label_properties_spec.rb +58 -0
  489. data/spec/models/label_resource_properties_spec.rb +40 -0
  490. data/spec/models/label_resource_spec.rb +62 -0
  491. data/spec/models/label_resources_spec.rb +74 -0
  492. data/spec/models/label_spec.rb +62 -0
  493. data/spec/models/labels_spec.rb +56 -0
  494. data/spec/models/lan_entities_spec.rb +34 -0
  495. data/spec/models/lan_nics_spec.rb +70 -0
  496. data/spec/models/lan_post_spec.rb +64 -0
  497. data/spec/models/lan_properties_post_spec.rb +52 -0
  498. data/spec/models/lan_properties_spec.rb +52 -0
  499. data/spec/models/lan_spec.rb +64 -0
  500. data/spec/models/lans_spec.rb +70 -0
  501. data/spec/models/loadbalancer_entities_spec.rb +34 -0
  502. data/spec/models/loadbalancer_properties_spec.rb +50 -0
  503. data/spec/models/loadbalancer_spec.rb +64 -0
  504. data/spec/models/loadbalancers_spec.rb +70 -0
  505. data/spec/models/location_properties_spec.rb +56 -0
  506. data/spec/models/location_spec.rb +58 -0
  507. data/spec/models/locations_spec.rb +52 -0
  508. data/spec/models/nat_gateway_entities_spec.rb +40 -0
  509. data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
  510. data/spec/models/nat_gateway_properties_spec.rb +46 -0
  511. data/spec/models/nat_gateway_put_spec.rb +52 -0
  512. data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
  513. data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
  514. data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
  515. data/spec/models/nat_gateway_rule_spec.rb +58 -0
  516. data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
  517. data/spec/models/nat_gateway_rules_spec.rb +52 -0
  518. data/spec/models/nat_gateway_spec.rb +64 -0
  519. data/spec/models/nat_gateways_spec.rb +70 -0
  520. data/spec/models/network_load_balancer_entities_spec.rb +40 -0
  521. data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +58 -0
  522. data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
  523. data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
  524. data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
  525. data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
  526. data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
  527. data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
  528. data/spec/models/network_load_balancer_properties_spec.rb +58 -0
  529. data/spec/models/network_load_balancer_put_spec.rb +52 -0
  530. data/spec/models/network_load_balancer_spec.rb +64 -0
  531. data/spec/models/network_load_balancers_spec.rb +70 -0
  532. data/spec/models/nic_entities_spec.rb +40 -0
  533. data/spec/models/nic_properties_spec.rb +86 -0
  534. data/spec/models/nic_put_spec.rb +52 -0
  535. data/spec/models/nic_spec.rb +64 -0
  536. data/spec/models/nics_spec.rb +70 -0
  537. data/spec/models/no_state_meta_data_spec.rb +70 -0
  538. data/spec/models/pagination_links_spec.rb +46 -0
  539. data/spec/models/peer_spec.rb +58 -0
  540. data/spec/models/private_cross_connect_properties_spec.rb +52 -0
  541. data/spec/models/private_cross_connect_spec.rb +58 -0
  542. data/spec/models/private_cross_connects_spec.rb +52 -0
  543. data/spec/models/remote_console_url_spec.rb +34 -0
  544. data/spec/models/request_metadata_spec.rb +52 -0
  545. data/spec/models/request_properties_spec.rb +52 -0
  546. data/spec/models/request_spec.rb +58 -0
  547. data/spec/models/request_status_metadata_spec.rb +56 -0
  548. data/spec/models/request_status_spec.rb +52 -0
  549. data/spec/models/request_target_spec.rb +44 -0
  550. data/spec/models/requests_spec.rb +70 -0
  551. data/spec/models/resource_entities_spec.rb +34 -0
  552. data/spec/models/resource_groups_spec.rb +52 -0
  553. data/spec/models/resource_limits_spec.rb +160 -0
  554. data/spec/models/resource_properties_spec.rb +40 -0
  555. data/spec/models/resource_reference_spec.rb +46 -0
  556. data/spec/models/resource_spec.rb +64 -0
  557. data/spec/models/resources_spec.rb +52 -0
  558. data/spec/models/resources_users_spec.rb +52 -0
  559. data/spec/models/s3_key_metadata_spec.rb +40 -0
  560. data/spec/models/s3_key_properties_spec.rb +40 -0
  561. data/spec/models/s3_key_spec.rb +58 -0
  562. data/spec/models/s3_keys_spec.rb +52 -0
  563. data/spec/models/s3_object_storage_sso_spec.rb +34 -0
  564. data/spec/models/server_entities_spec.rb +46 -0
  565. data/spec/models/server_properties_spec.rb +96 -0
  566. data/spec/models/server_spec.rb +64 -0
  567. data/spec/models/servers_spec.rb +70 -0
  568. data/spec/models/snapshot_properties_spec.rb +128 -0
  569. data/spec/models/snapshot_spec.rb +58 -0
  570. data/spec/models/snapshots_spec.rb +52 -0
  571. data/spec/models/target_port_range_spec.rb +40 -0
  572. data/spec/models/template_properties_spec.rb +52 -0
  573. data/spec/models/template_spec.rb +58 -0
  574. data/spec/models/templates_spec.rb +52 -0
  575. data/spec/models/token_spec.rb +34 -0
  576. data/spec/models/type_spec.rb +28 -0
  577. data/spec/models/user_metadata_spec.rb +46 -0
  578. data/spec/models/user_post_spec.rb +34 -0
  579. data/spec/models/user_properties_post_spec.rb +76 -0
  580. data/spec/models/user_properties_put_spec.rb +70 -0
  581. data/spec/models/user_properties_spec.rb +76 -0
  582. data/spec/models/user_put_spec.rb +40 -0
  583. data/spec/models/user_spec.rb +64 -0
  584. data/spec/models/users_entities_spec.rb +40 -0
  585. data/spec/models/users_spec.rb +52 -0
  586. data/spec/models/volume_properties_spec.rb +158 -0
  587. data/spec/models/volume_spec.rb +58 -0
  588. data/spec/models/volumes_spec.rb +70 -0
  589. data/spec/spec_helper.rb +2 -2
  590. metadata +642 -179
  591. data/Gemfile.lock +0 -68
  592. data/LICENSE +0 -190
  593. data/README.md +0 -65
  594. data/docs/api/NicApi.md +0 -1087
  595. data/docs/models/IpBlocks.md +0 -30
  596. data/docs/models/KubernetesConfig.md +0 -24
  597. data/docs/models/KubernetesConfigProperties.md +0 -18
  598. data/docs/models/KubernetesNodePoolLan.md +0 -18
  599. data/docs/models/Users.md +0 -30
  600. data/lib/ionoscloud/api/nic_api.rb +0 -1222
  601. data/lib/test_driver.rb +0 -104
@@ -1,6 +1,6 @@
1
1
  # UserManagementApi
2
2
 
3
- All URIs are relative to *https://api.ionos.com/cloudapi/v5*
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v6*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -28,12 +28,6 @@ All URIs are relative to *https://api.ionos.com/cloudapi/v5*
28
28
  | [**um_users_owns_get**](UserManagementApi.md#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve a User's own resources |
29
29
  | [**um_users_post**](UserManagementApi.md#um_users_post) | **POST** /um/users | Create a user |
30
30
  | [**um_users_put**](UserManagementApi.md#um_users_put) | **PUT** /um/users/{userId} | Modify a user |
31
- | [**um_users_s3keys_delete**](UserManagementApi.md#um_users_s3keys_delete) | **DELETE** /um/users/{userId}/s3keys/{keyId} | Delete a S3 key |
32
- | [**um_users_s3keys_find_by_key_id**](UserManagementApi.md#um_users_s3keys_find_by_key_id) | **GET** /um/users/{userId}/s3keys/{keyId} | Retrieve given S3 key belonging to the given User |
33
- | [**um_users_s3keys_get**](UserManagementApi.md#um_users_s3keys_get) | **GET** /um/users/{userId}/s3keys | Retrieve a User's S3 keys |
34
- | [**um_users_s3keys_post**](UserManagementApi.md#um_users_s3keys_post) | **POST** /um/users/{userId}/s3keys | Create a S3 key for the given user |
35
- | [**um_users_s3keys_put**](UserManagementApi.md#um_users_s3keys_put) | **PUT** /um/users/{userId}/s3keys/{keyId} | Modify a S3 key having the given key id |
36
- | [**um_users_s3ssourl_get**](UserManagementApi.md#um_users_s3ssourl_get) | **GET** /um/users/{userId}/s3ssourl | Retrieve S3 object storage single signon URL for the given user |
37
31
 
38
32
 
39
33
  ## um_groups_delete
@@ -965,7 +959,7 @@ Basic Authentication, Token Authentication
965
959
 
966
960
  Remove a user from a group
967
961
 
968
- This will remove a user from a group
962
+ This will remove a user from a group.
969
963
 
970
964
  ### Examples
971
965
 
@@ -1386,7 +1380,7 @@ Basic Authentication, Token Authentication
1386
1380
 
1387
1381
  List All Resources.
1388
1382
 
1389
- You can retrieve a complete list of all resources that you have access to
1383
+ You can retrieve a complete list of all resources that you have access to.
1390
1384
 
1391
1385
  ### Examples
1392
1386
 
@@ -1656,9 +1650,7 @@ api_instance = Ionoscloud::UserManagementApi.new
1656
1650
  opts = {
1657
1651
  pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1658
1652
  depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1659
- x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1660
- offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
1661
- limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
1653
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1662
1654
  }
1663
1655
 
1664
1656
  begin
@@ -1695,8 +1687,6 @@ end
1695
1687
  | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1696
1688
  | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1697
1689
  | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1698
- | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
1699
- | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 100] |
1700
1690
 
1701
1691
  ### Return type
1702
1692
 
@@ -1880,7 +1870,7 @@ Basic Authentication, Token Authentication
1880
1870
 
1881
1871
  ## um_users_post
1882
1872
 
1883
- > <User> um_users_post(user, opts)
1873
+ > <UserPost> um_users_post(user, opts)
1884
1874
 
1885
1875
  Create a user
1886
1876
 
@@ -1924,7 +1914,7 @@ end
1924
1914
 
1925
1915
  This returns an Array which contains the response data, status code and headers.
1926
1916
 
1927
- > <Array(<User>, Integer, Hash)> um_users_post_with_http_info(user, opts)
1917
+ > <Array(<UserPost>, Integer, Hash)> um_users_post_with_http_info(user, opts)
1928
1918
 
1929
1919
  ```ruby
1930
1920
  begin
@@ -1932,7 +1922,7 @@ begin
1932
1922
  data, status_code, headers = api_instance.um_users_post_with_http_info(user, opts)
1933
1923
  p status_code # => 2xx
1934
1924
  p headers # => { ... }
1935
- p data # => <User>
1925
+ p data # => <UserPost>
1936
1926
  rescue Ionoscloud::ApiError => e
1937
1927
  puts "Error when calling UserManagementApi->um_users_post_with_http_info: #{e}"
1938
1928
  end
@@ -1949,7 +1939,7 @@ end
1949
1939
 
1950
1940
  ### Return type
1951
1941
 
1952
- [**User**](User.md)
1942
+ [**UserPost**](UserPost.md)
1953
1943
 
1954
1944
  ### Authorization
1955
1945
 
@@ -1963,7 +1953,7 @@ Basic Authentication, Token Authentication
1963
1953
 
1964
1954
  ## um_users_put
1965
1955
 
1966
- > <User> um_users_put(user_id, user, opts)
1956
+ > <UserPut> um_users_put(user_id, user, opts)
1967
1957
 
1968
1958
  Modify a user
1969
1959
 
@@ -2008,7 +1998,7 @@ end
2008
1998
 
2009
1999
  This returns an Array which contains the response data, status code and headers.
2010
2000
 
2011
- > <Array(<User>, Integer, Hash)> um_users_put_with_http_info(user_id, user, opts)
2001
+ > <Array(<UserPut>, Integer, Hash)> um_users_put_with_http_info(user_id, user, opts)
2012
2002
 
2013
2003
  ```ruby
2014
2004
  begin
@@ -2016,7 +2006,7 @@ begin
2016
2006
  data, status_code, headers = api_instance.um_users_put_with_http_info(user_id, user, opts)
2017
2007
  p status_code # => 2xx
2018
2008
  p headers # => { ... }
2019
- p data # => <User>
2009
+ p data # => <UserPut>
2020
2010
  rescue Ionoscloud::ApiError => e
2021
2011
  puts "Error when calling UserManagementApi->um_users_put_with_http_info: #{e}"
2022
2012
  end
@@ -2034,7 +2024,7 @@ end
2034
2024
 
2035
2025
  ### Return type
2036
2026
 
2037
- [**User**](User.md)
2027
+ [**UserPut**](UserPut.md)
2038
2028
 
2039
2029
  ### Authorization
2040
2030
 
@@ -2045,507 +2035,3 @@ Basic Authentication, Token Authentication
2045
2035
  - **Content-Type**: application/json
2046
2036
  - **Accept**: application/json
2047
2037
 
2048
-
2049
- ## um_users_s3keys_delete
2050
-
2051
- > Object um_users_s3keys_delete(user_id, key_id, opts)
2052
-
2053
- Delete a S3 key
2054
-
2055
- Delete a S3 key
2056
-
2057
- ### Examples
2058
-
2059
- ```ruby
2060
- require 'time'
2061
- require 'ionoscloud'
2062
- # setup authorization
2063
- Ionoscloud.configure do |config|
2064
- # Configure HTTP basic authorization: Basic Authentication
2065
- config.username = 'YOUR USERNAME'
2066
- config.password = 'YOUR PASSWORD'
2067
-
2068
- # Configure API key authorization: Token Authentication
2069
- config.api_key['Authorization'] = 'YOUR API KEY'
2070
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2071
- # config.api_key_prefix['Authorization'] = 'Bearer'
2072
- end
2073
-
2074
- api_instance = Ionoscloud::UserManagementApi.new
2075
- user_id = 'user_id_example' # String | The unique ID of the user
2076
- key_id = 'key_id_example' # String | The unique access key ID of the S3 key
2077
- opts = {
2078
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2079
- depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2080
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2081
- }
2082
-
2083
- begin
2084
- # Delete a S3 key
2085
- result = api_instance.um_users_s3keys_delete(user_id, key_id, opts)
2086
- p result
2087
- rescue Ionoscloud::ApiError => e
2088
- puts "Error when calling UserManagementApi->um_users_s3keys_delete: #{e}"
2089
- end
2090
- ```
2091
-
2092
- #### Using the um_users_s3keys_delete_with_http_info variant
2093
-
2094
- This returns an Array which contains the response data, status code and headers.
2095
-
2096
- > <Array(Object, Integer, Hash)> um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
2097
-
2098
- ```ruby
2099
- begin
2100
- # Delete a S3 key
2101
- data, status_code, headers = api_instance.um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
2102
- p status_code # => 2xx
2103
- p headers # => { ... }
2104
- p data # => Object
2105
- rescue Ionoscloud::ApiError => e
2106
- puts "Error when calling UserManagementApi->um_users_s3keys_delete_with_http_info: #{e}"
2107
- end
2108
- ```
2109
-
2110
- ### Parameters
2111
-
2112
- | Name | Type | Description | Notes |
2113
- | ---- | ---- | ----------- | ----- |
2114
- | **user_id** | **String** | The unique ID of the user | |
2115
- | **key_id** | **String** | The unique access key ID of the S3 key | |
2116
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2117
- | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2118
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2119
-
2120
- ### Return type
2121
-
2122
- **Object**
2123
-
2124
- ### Authorization
2125
-
2126
- Basic Authentication, Token Authentication
2127
-
2128
- ### HTTP request headers
2129
-
2130
- - **Content-Type**: Not defined
2131
- - **Accept**: application/json
2132
-
2133
-
2134
- ## um_users_s3keys_find_by_key_id
2135
-
2136
- > <S3Key> um_users_s3keys_find_by_key_id(user_id, key_id, opts)
2137
-
2138
- Retrieve given S3 key belonging to the given User
2139
-
2140
- You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user
2141
-
2142
- ### Examples
2143
-
2144
- ```ruby
2145
- require 'time'
2146
- require 'ionoscloud'
2147
- # setup authorization
2148
- Ionoscloud.configure do |config|
2149
- # Configure HTTP basic authorization: Basic Authentication
2150
- config.username = 'YOUR USERNAME'
2151
- config.password = 'YOUR PASSWORD'
2152
-
2153
- # Configure API key authorization: Token Authentication
2154
- config.api_key['Authorization'] = 'YOUR API KEY'
2155
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2156
- # config.api_key_prefix['Authorization'] = 'Bearer'
2157
- end
2158
-
2159
- api_instance = Ionoscloud::UserManagementApi.new
2160
- user_id = 'user_id_example' # String | The unique ID of the user
2161
- key_id = 'key_id_example' # String | The unique access key ID of the S3 key
2162
- opts = {
2163
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2164
- depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2165
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2166
- }
2167
-
2168
- begin
2169
- # Retrieve given S3 key belonging to the given User
2170
- result = api_instance.um_users_s3keys_find_by_key_id(user_id, key_id, opts)
2171
- p result
2172
- rescue Ionoscloud::ApiError => e
2173
- puts "Error when calling UserManagementApi->um_users_s3keys_find_by_key_id: #{e}"
2174
- end
2175
- ```
2176
-
2177
- #### Using the um_users_s3keys_find_by_key_id_with_http_info variant
2178
-
2179
- This returns an Array which contains the response data, status code and headers.
2180
-
2181
- > <Array(<S3Key>, Integer, Hash)> um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
2182
-
2183
- ```ruby
2184
- begin
2185
- # Retrieve given S3 key belonging to the given User
2186
- data, status_code, headers = api_instance.um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
2187
- p status_code # => 2xx
2188
- p headers # => { ... }
2189
- p data # => <S3Key>
2190
- rescue Ionoscloud::ApiError => e
2191
- puts "Error when calling UserManagementApi->um_users_s3keys_find_by_key_id_with_http_info: #{e}"
2192
- end
2193
- ```
2194
-
2195
- ### Parameters
2196
-
2197
- | Name | Type | Description | Notes |
2198
- | ---- | ---- | ----------- | ----- |
2199
- | **user_id** | **String** | The unique ID of the user | |
2200
- | **key_id** | **String** | The unique access key ID of the S3 key | |
2201
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2202
- | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2203
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2204
-
2205
- ### Return type
2206
-
2207
- [**S3Key**](S3Key.md)
2208
-
2209
- ### Authorization
2210
-
2211
- Basic Authentication, Token Authentication
2212
-
2213
- ### HTTP request headers
2214
-
2215
- - **Content-Type**: Not defined
2216
- - **Accept**: application/json
2217
-
2218
-
2219
- ## um_users_s3keys_get
2220
-
2221
- > <S3Keys> um_users_s3keys_get(user_id, opts)
2222
-
2223
- Retrieve a User's S3 keys
2224
-
2225
- You can retrieve S3 keys owned by a user by using the users ID. This user Id can be found in the response body when a user is created or when you GET a list of users.
2226
-
2227
- ### Examples
2228
-
2229
- ```ruby
2230
- require 'time'
2231
- require 'ionoscloud'
2232
- # setup authorization
2233
- Ionoscloud.configure do |config|
2234
- # Configure HTTP basic authorization: Basic Authentication
2235
- config.username = 'YOUR USERNAME'
2236
- config.password = 'YOUR PASSWORD'
2237
-
2238
- # Configure API key authorization: Token Authentication
2239
- config.api_key['Authorization'] = 'YOUR API KEY'
2240
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2241
- # config.api_key_prefix['Authorization'] = 'Bearer'
2242
- end
2243
-
2244
- api_instance = Ionoscloud::UserManagementApi.new
2245
- user_id = 'user_id_example' # String | The unique ID of the user
2246
- opts = {
2247
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2248
- depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2249
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2250
- }
2251
-
2252
- begin
2253
- # Retrieve a User's S3 keys
2254
- result = api_instance.um_users_s3keys_get(user_id, opts)
2255
- p result
2256
- rescue Ionoscloud::ApiError => e
2257
- puts "Error when calling UserManagementApi->um_users_s3keys_get: #{e}"
2258
- end
2259
- ```
2260
-
2261
- #### Using the um_users_s3keys_get_with_http_info variant
2262
-
2263
- This returns an Array which contains the response data, status code and headers.
2264
-
2265
- > <Array(<S3Keys>, Integer, Hash)> um_users_s3keys_get_with_http_info(user_id, opts)
2266
-
2267
- ```ruby
2268
- begin
2269
- # Retrieve a User's S3 keys
2270
- data, status_code, headers = api_instance.um_users_s3keys_get_with_http_info(user_id, opts)
2271
- p status_code # => 2xx
2272
- p headers # => { ... }
2273
- p data # => <S3Keys>
2274
- rescue Ionoscloud::ApiError => e
2275
- puts "Error when calling UserManagementApi->um_users_s3keys_get_with_http_info: #{e}"
2276
- end
2277
- ```
2278
-
2279
- ### Parameters
2280
-
2281
- | Name | Type | Description | Notes |
2282
- | ---- | ---- | ----------- | ----- |
2283
- | **user_id** | **String** | The unique ID of the user | |
2284
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2285
- | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2286
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2287
-
2288
- ### Return type
2289
-
2290
- [**S3Keys**](S3Keys.md)
2291
-
2292
- ### Authorization
2293
-
2294
- Basic Authentication, Token Authentication
2295
-
2296
- ### HTTP request headers
2297
-
2298
- - **Content-Type**: Not defined
2299
- - **Accept**: application/json
2300
-
2301
-
2302
- ## um_users_s3keys_post
2303
-
2304
- > <S3Key> um_users_s3keys_post(user_id, opts)
2305
-
2306
- Create a S3 key for the given user
2307
-
2308
- Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user
2309
-
2310
- ### Examples
2311
-
2312
- ```ruby
2313
- require 'time'
2314
- require 'ionoscloud'
2315
- # setup authorization
2316
- Ionoscloud.configure do |config|
2317
- # Configure HTTP basic authorization: Basic Authentication
2318
- config.username = 'YOUR USERNAME'
2319
- config.password = 'YOUR PASSWORD'
2320
-
2321
- # Configure API key authorization: Token Authentication
2322
- config.api_key['Authorization'] = 'YOUR API KEY'
2323
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2324
- # config.api_key_prefix['Authorization'] = 'Bearer'
2325
- end
2326
-
2327
- api_instance = Ionoscloud::UserManagementApi.new
2328
- user_id = 'user_id_example' # String | The unique ID of the user
2329
- opts = {
2330
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2331
- depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2332
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2333
- }
2334
-
2335
- begin
2336
- # Create a S3 key for the given user
2337
- result = api_instance.um_users_s3keys_post(user_id, opts)
2338
- p result
2339
- rescue Ionoscloud::ApiError => e
2340
- puts "Error when calling UserManagementApi->um_users_s3keys_post: #{e}"
2341
- end
2342
- ```
2343
-
2344
- #### Using the um_users_s3keys_post_with_http_info variant
2345
-
2346
- This returns an Array which contains the response data, status code and headers.
2347
-
2348
- > <Array(<S3Key>, Integer, Hash)> um_users_s3keys_post_with_http_info(user_id, opts)
2349
-
2350
- ```ruby
2351
- begin
2352
- # Create a S3 key for the given user
2353
- data, status_code, headers = api_instance.um_users_s3keys_post_with_http_info(user_id, opts)
2354
- p status_code # => 2xx
2355
- p headers # => { ... }
2356
- p data # => <S3Key>
2357
- rescue Ionoscloud::ApiError => e
2358
- puts "Error when calling UserManagementApi->um_users_s3keys_post_with_http_info: #{e}"
2359
- end
2360
- ```
2361
-
2362
- ### Parameters
2363
-
2364
- | Name | Type | Description | Notes |
2365
- | ---- | ---- | ----------- | ----- |
2366
- | **user_id** | **String** | The unique ID of the user | |
2367
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2368
- | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2369
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2370
-
2371
- ### Return type
2372
-
2373
- [**S3Key**](S3Key.md)
2374
-
2375
- ### Authorization
2376
-
2377
- Basic Authentication, Token Authentication
2378
-
2379
- ### HTTP request headers
2380
-
2381
- - **Content-Type**: Not defined
2382
- - **Accept**: application/json
2383
-
2384
-
2385
- ## um_users_s3keys_put
2386
-
2387
- > <S3Key> um_users_s3keys_put(user_id, key_id, s3_key, opts)
2388
-
2389
- Modify a S3 key having the given key id
2390
-
2391
- You can enable or disable a given S3 key.
2392
-
2393
- ### Examples
2394
-
2395
- ```ruby
2396
- require 'time'
2397
- require 'ionoscloud'
2398
- # setup authorization
2399
- Ionoscloud.configure do |config|
2400
- # Configure HTTP basic authorization: Basic Authentication
2401
- config.username = 'YOUR USERNAME'
2402
- config.password = 'YOUR PASSWORD'
2403
-
2404
- # Configure API key authorization: Token Authentication
2405
- config.api_key['Authorization'] = 'YOUR API KEY'
2406
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2407
- # config.api_key_prefix['Authorization'] = 'Bearer'
2408
- end
2409
-
2410
- api_instance = Ionoscloud::UserManagementApi.new
2411
- user_id = 'user_id_example' # String |
2412
- key_id = 'key_id_example' # String | The unique access key ID of the S3 key
2413
- s3_key = Ionoscloud::S3Key.new({properties: Ionoscloud::S3KeyProperties.new}) # S3Key | Modified S3 key
2414
- opts = {
2415
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2416
- depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2417
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2418
- }
2419
-
2420
- begin
2421
- # Modify a S3 key having the given key id
2422
- result = api_instance.um_users_s3keys_put(user_id, key_id, s3_key, opts)
2423
- p result
2424
- rescue Ionoscloud::ApiError => e
2425
- puts "Error when calling UserManagementApi->um_users_s3keys_put: #{e}"
2426
- end
2427
- ```
2428
-
2429
- #### Using the um_users_s3keys_put_with_http_info variant
2430
-
2431
- This returns an Array which contains the response data, status code and headers.
2432
-
2433
- > <Array(<S3Key>, Integer, Hash)> um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
2434
-
2435
- ```ruby
2436
- begin
2437
- # Modify a S3 key having the given key id
2438
- data, status_code, headers = api_instance.um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
2439
- p status_code # => 2xx
2440
- p headers # => { ... }
2441
- p data # => <S3Key>
2442
- rescue Ionoscloud::ApiError => e
2443
- puts "Error when calling UserManagementApi->um_users_s3keys_put_with_http_info: #{e}"
2444
- end
2445
- ```
2446
-
2447
- ### Parameters
2448
-
2449
- | Name | Type | Description | Notes |
2450
- | ---- | ---- | ----------- | ----- |
2451
- | **user_id** | **String** | | |
2452
- | **key_id** | **String** | The unique access key ID of the S3 key | |
2453
- | **s3_key** | [**S3Key**](S3Key.md) | Modified S3 key | |
2454
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2455
- | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2456
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2457
-
2458
- ### Return type
2459
-
2460
- [**S3Key**](S3Key.md)
2461
-
2462
- ### Authorization
2463
-
2464
- Basic Authentication, Token Authentication
2465
-
2466
- ### HTTP request headers
2467
-
2468
- - **Content-Type**: application/json
2469
- - **Accept**: application/json
2470
-
2471
-
2472
- ## um_users_s3ssourl_get
2473
-
2474
- > <S3ObjectStorageSSO> um_users_s3ssourl_get(user_id, opts)
2475
-
2476
- Retrieve S3 object storage single signon URL for the given user
2477
-
2478
- You can retrieve S3 object storage single signon URL for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users.
2479
-
2480
- ### Examples
2481
-
2482
- ```ruby
2483
- require 'time'
2484
- require 'ionoscloud'
2485
- # setup authorization
2486
- Ionoscloud.configure do |config|
2487
- # Configure HTTP basic authorization: Basic Authentication
2488
- config.username = 'YOUR USERNAME'
2489
- config.password = 'YOUR PASSWORD'
2490
-
2491
- # Configure API key authorization: Token Authentication
2492
- config.api_key['Authorization'] = 'YOUR API KEY'
2493
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2494
- # config.api_key_prefix['Authorization'] = 'Bearer'
2495
- end
2496
-
2497
- api_instance = Ionoscloud::UserManagementApi.new
2498
- user_id = 'user_id_example' # String | The unique ID of the user
2499
- opts = {
2500
- pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2501
- x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2502
- }
2503
-
2504
- begin
2505
- # Retrieve S3 object storage single signon URL for the given user
2506
- result = api_instance.um_users_s3ssourl_get(user_id, opts)
2507
- p result
2508
- rescue Ionoscloud::ApiError => e
2509
- puts "Error when calling UserManagementApi->um_users_s3ssourl_get: #{e}"
2510
- end
2511
- ```
2512
-
2513
- #### Using the um_users_s3ssourl_get_with_http_info variant
2514
-
2515
- This returns an Array which contains the response data, status code and headers.
2516
-
2517
- > <Array(<S3ObjectStorageSSO>, Integer, Hash)> um_users_s3ssourl_get_with_http_info(user_id, opts)
2518
-
2519
- ```ruby
2520
- begin
2521
- # Retrieve S3 object storage single signon URL for the given user
2522
- data, status_code, headers = api_instance.um_users_s3ssourl_get_with_http_info(user_id, opts)
2523
- p status_code # => 2xx
2524
- p headers # => { ... }
2525
- p data # => <S3ObjectStorageSSO>
2526
- rescue Ionoscloud::ApiError => e
2527
- puts "Error when calling UserManagementApi->um_users_s3ssourl_get_with_http_info: #{e}"
2528
- end
2529
- ```
2530
-
2531
- ### Parameters
2532
-
2533
- | Name | Type | Description | Notes |
2534
- | ---- | ---- | ----------- | ----- |
2535
- | **user_id** | **String** | The unique ID of the user | |
2536
- | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2537
- | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2538
-
2539
- ### Return type
2540
-
2541
- [**S3ObjectStorageSSO**](S3ObjectStorageSSO.md)
2542
-
2543
- ### Authorization
2544
-
2545
- Basic Authentication, Token Authentication
2546
-
2547
- ### HTTP request headers
2548
-
2549
- - **Content-Type**: Not defined
2550
- - **Accept**: application/json
2551
-
File without changes
File without changes
File without changes