ionoscloud 5.0.0 → 5.0.1

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