# UserManagementApi All URIs are relative to ** | Method | HTTP request | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------- | ----------------------------------- | | [**um\_groups\_delete**](#um_groups_delete) | **DELETE** /um/groups/{groupId} | Delete groups | | [**um\_groups\_find\_by\_id**](#um_groups_find_by_id) | **GET** /um/groups/{groupId} | Retrieve groups | | [**um\_groups\_get**](#um_groups_get) | **GET** /um/groups | List all groups | | [**um\_groups\_post**](#um_groups_post) | **POST** /um/groups | Create groups | | [**um\_groups\_put**](#um_groups_put) | **PUT** /um/groups/{groupId} | Modify groups | | [**um\_groups\_resources\_get**](#um_groups_resources_get) | **GET** /um/groups/{groupId}/resources | Retrieve group resources | | [**um\_groups\_shares\_delete**](#um_groups_shares_delete) | **DELETE** /um/groups/{groupId}/shares/{resourceId} | Remove group shares | | [**um\_groups\_shares\_find\_by\_resource\_id**](#um_groups_shares_find_by_resource_id) | **GET** /um/groups/{groupId}/shares/{resourceId} | Retrieve group shares | | [**um\_groups\_shares\_get**](#um_groups_shares_get) | **GET** /um/groups/{groupId}/shares | List group shares | | [**um\_groups\_shares\_post**](#um_groups_shares_post) | **POST** /um/groups/{groupId}/shares/{resourceId} | Add group shares | | [**um\_groups\_shares\_put**](#um_groups_shares_put) | **PUT** /um/groups/{groupId}/shares/{resourceId} | Modify group share privileges | | [**um\_groups\_users\_delete**](#um_groups_users_delete) | **DELETE** /um/groups/{groupId}/users/{userId} | Remove users from groups | | [**um\_groups\_users\_get**](#um_groups_users_get) | **GET** /um/groups/{groupId}/users | List group members | | [**um\_groups\_users\_post**](#um_groups_users_post) | **POST** /um/groups/{groupId}/users | Add a Group Member | | [**um\_resources\_find\_by\_type**](#um_resources_find_by_type) | **GET** /um/resources/{resourceType} | List resources by type | | [**um\_resources\_find\_by\_type\_and\_id**](#um_resources_find_by_type_and_id) | **GET** /um/resources/{resourceType}/{resourceId} | Retrieve resources by type | | [**um\_resources\_get**](#um_resources_get) | **GET** /um/resources | List all resources | | [**um\_users\_delete**](#um_users_delete) | **DELETE** /um/users/{userId} | Delete users | | [**um\_users\_find\_by\_id**](#um_users_find_by_id) | **GET** /um/users/{userId} | Retrieve users | | [**um\_users\_get**](#um_users_get) | **GET** /um/users | List all users | | [**um\_users\_groups\_get**](#um_users_groups_get) | **GET** /um/users/{userId}/groups | Retrieve group resources by user ID | | [**um\_users\_owns\_get**](#um_users_owns_get) | **GET** /um/users/{userId}/owns | Retrieve user resources by user ID | | [**um\_users\_post**](#um_users_post) | **POST** /um/users | Create users | | [**um\_users\_put**](#um_users_put) | **PUT** /um/users/{userId} | Modify users | ## um\_groups\_delete > um\_groups\_delete(group\_id, opts) Delete groups Remove the specified group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Delete groups api_instance.um_groups_delete(group_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_delete: #{e}" end ``` #### Using the um\_groups\_delete\_with\_http\_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > \ um\_groups\_delete\_with\_http\_info(group\_id, opts) ```ruby begin # Delete groups data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_delete_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type nil (empty response body) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_find\_by\_id > um\_groups\_find\_by\_id(group\_id, opts) Retrieve groups Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve groups result = api_instance.um_groups_find_by_id(group_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_find_by_id: #{e}" end ``` #### Using the um\_groups\_find\_by\_id\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_find\_by\_id\_with\_http\_info(group\_id, opts) ```ruby begin # Retrieve groups data, status_code, headers = api_instance.um_groups_find_by_id_with_http_info(group_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_find_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Group**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/group) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_get > um\_groups\_get(opts) List all groups List all the available user groups. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # List all groups result = api_instance.um_groups_get(opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_get: #{e}" end ``` #### Using the um\_groups\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_get\_with\_http\_info(opts) ```ruby begin # List all groups data, status_code, headers = api_instance.um_groups_get_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Groups**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groups) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_post > um\_groups\_post(group, opts) Create groups Create a group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The group to create. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Create groups result = api_instance.um_groups_post(group, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_post: #{e}" end ``` #### Using the um\_groups\_post\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_post\_with\_http\_info(group, opts) ```ruby begin # Create groups data, status_code, headers = api_instance.um_groups_post_with_http_info(group, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_post_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group** | [**Group**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/group) | The group to create. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Group**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/group) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## um\_groups\_put > um\_groups\_put(group\_id, group, opts) Modify groups Modify the properties of the specified group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The modified group. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Modify groups result = api_instance.um_groups_put(group_id, group, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_put: #{e}" end ``` #### Using the um\_groups\_put\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_put\_with\_http\_info(group\_id, group, opts) ```ruby begin # Modify groups data, status_code, headers = api_instance.um_groups_put_with_http_info(group_id, group, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_put_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **group** | [**Group**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/group) | The modified group. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Group**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/group) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## um\_groups\_resources\_get > um\_groups\_resources\_get(group\_id, opts) Retrieve group resources List the resources assigned to the group, by group ID. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve group resources result = api_instance.um_groups_resources_get(group_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_resources_get: #{e}" end ``` #### Using the um\_groups\_resources\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_resources\_get\_with\_http\_info(group\_id, opts) ```ruby begin # Retrieve group resources data, status_code, headers = api_instance.um_groups_resources_get_with_http_info(group_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_resources_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**ResourceGroups**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/resourcegroups) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_shares\_delete > um\_groups\_shares\_delete(group\_id, resource\_id, opts) Remove group shares Remove the specified share from the group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. resource_id = 'resource_id_example' # String | The unique ID of the resource. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Remove group shares api_instance.um_groups_shares_delete(group_id, resource_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}" end ``` #### Using the um\_groups\_shares\_delete\_with\_http\_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > \ um\_groups\_shares\_delete\_with\_http\_info(group\_id, resource\_id, opts) ```ruby begin # Remove group shares data, status_code, headers = api_instance.um_groups_shares_delete_with_http_info(group_id, resource_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_delete_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **resource\_id** | **String** | The unique ID of the resource. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type nil (empty response body) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_shares\_find\_by\_resource\_id > um\_groups\_shares\_find\_by\_resource\_id(group\_id, resource\_id, opts) Retrieve group shares Retrieve the properties of the specified group share. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. resource_id = 'resource_id_example' # String | The unique ID of the resource. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve group shares result = api_instance.um_groups_shares_find_by_resource_id(group_id, resource_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id: #{e}" end ``` #### Using the um\_groups\_shares\_find\_by\_resource\_id\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_shares\_find\_by\_resource\_id\_with\_http\_info(group\_id, resource\_id, opts) ```ruby begin # Retrieve group shares data, status_code, headers = api_instance.um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **resource\_id** | **String** | The unique ID of the resource. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**GroupShare**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupshare) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_shares\_get > um\_groups\_shares\_get(group\_id, opts) List group shares List all shares and share privileges for the specified group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # List group shares result = api_instance.um_groups_shares_get(group_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_get: #{e}" end ``` #### Using the um\_groups\_shares\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_shares\_get\_with\_http\_info(group\_id, opts) ```ruby begin # List group shares data, status_code, headers = api_instance.um_groups_shares_get_with_http_info(group_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**GroupShares**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupshares) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_shares\_post > um\_groups\_shares\_post(group\_id, resource\_id, resource, opts) Add group shares Add the specified share to the group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. resource_id = 'resource_id_example' # String | The unique ID of the resource. resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | The resource to add. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Add group shares result = api_instance.um_groups_shares_post(group_id, resource_id, resource, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_post: #{e}" end ``` #### Using the um\_groups\_shares\_post\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_shares\_post\_with\_http\_info(group\_id, resource\_id, resource, opts) ```ruby begin # Add group shares data, status_code, headers = api_instance.um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_post_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **resource\_id** | **String** | The unique ID of the resource. | | | **resource** | [**GroupShare**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupshare) | The resource to add. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**GroupShare**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupshare) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_shares\_put > um\_groups\_shares\_put(group\_id, resource\_id, resource, opts) Modify group share privileges Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. resource_id = 'resource_id_example' # String | The unique ID of the resource. resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | The modified resource opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Modify group share privileges result = api_instance.um_groups_shares_put(group_id, resource_id, resource, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_put: #{e}" end ``` #### Using the um\_groups\_shares\_put\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_shares\_put\_with\_http\_info(group\_id, resource\_id, resource, opts) ```ruby begin # Modify group share privileges data, status_code, headers = api_instance.um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_shares_put_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **resource\_id** | **String** | The unique ID of the resource. | | | **resource** | [**GroupShare**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupshare) | The modified resource | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**GroupShare**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupshare) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## um\_groups\_users\_delete > um\_groups\_users\_delete(group\_id, user\_id, opts) Remove users from groups Remove the specified user from the group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. user_id = 'user_id_example' # String | The unique ID of the user. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Remove users from groups api_instance.um_groups_users_delete(group_id, user_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_users_delete: #{e}" end ``` #### Using the um\_groups\_users\_delete\_with\_http\_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > \ um\_groups\_users\_delete\_with\_http\_info(group\_id, user\_id, opts) ```ruby begin # Remove users from groups data, status_code, headers = api_instance.um_groups_users_delete_with_http_info(group_id, user_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_users_delete_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **user\_id** | **String** | The unique ID of the user. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type nil (empty response body) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_users\_get > um\_groups\_users\_get(group\_id, opts) List group members List all members of the specified user group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # List group members result = api_instance.um_groups_users_get(group_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_users_get: #{e}" end ``` #### Using the um\_groups\_users\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_users\_get\_with\_http\_info(group\_id, opts) ```ruby begin # List group members data, status_code, headers = api_instance.um_groups_users_get_with_http_info(group_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_users_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**GroupMembers**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/groupmembers) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_groups\_users\_post > um\_groups\_users\_post(group\_id, user, opts) Add a Group Member Adds an existing user to the specified group. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new group_id = 'group_id_example' # String | The unique ID of the group. user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | The user to add. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Add a Group Member result = api_instance.um_groups_users_post(group_id, user, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_users_post: #{e}" end ``` #### Using the um\_groups\_users\_post\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_groups\_users\_post\_with\_http\_info(group\_id, user, opts) ```ruby begin # Add a Group Member data, status_code, headers = api_instance.um_groups_users_post_with_http_info(group_id, user, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_groups_users_post_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **group\_id** | **String** | The unique ID of the group. | | | **user** | [**User**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/user) | The user to add. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**User**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/user) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## um\_resources\_find\_by\_type > um\_resources\_find\_by\_type(resource\_type, opts) List resources by type List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new resource_type = 'resource_type_example' # String | The resource type opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # List resources by type result = api_instance.um_resources_find_by_type(resource_type, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_resources_find_by_type: #{e}" end ``` #### Using the um\_resources\_find\_by\_type\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_resources\_find\_by\_type\_with\_http\_info(resource\_type, opts) ```ruby begin # List resources by type data, status_code, headers = api_instance.um_resources_find_by_type_with_http_info(resource_type, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_resources_find_by_type_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **resource\_type** | **String** | The resource type | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Resources**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/resources) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_resources\_find\_by\_type\_and\_id > um\_resources\_find\_by\_type\_and\_id(resource\_type, resource\_id, opts) Retrieve resources by type Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new resource_type = 'resource_type_example' # String | The resource type resource_id = 'resource_id_example' # String | The resource ID opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve resources by type result = api_instance.um_resources_find_by_type_and_id(resource_type, resource_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id: #{e}" end ``` #### Using the um\_resources\_find\_by\_type\_and\_id\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_resources\_find\_by\_type\_and\_id\_with\_http\_info(resource\_type, resource\_id, opts) ```ruby begin # Retrieve resources by type data, status_code, headers = api_instance.um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **resource\_type** | **String** | The resource type | | | **resource\_id** | **String** | The resource ID | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Resource**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/resource) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_resources\_get > um\_resources\_get(opts) List all resources List all the available resources. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # List all resources result = api_instance.um_resources_get(opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_resources_get: #{e}" end ``` #### Using the um\_resources\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_resources\_get\_with\_http\_info(opts) ```ruby begin # List all resources data, status_code, headers = api_instance.um_resources_get_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_resources_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**Resources**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/resources) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_users\_delete > um\_users\_delete(user\_id, opts) Delete users Delete the specified user. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new user_id = 'user_id_example' # String | The unique ID of the user. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Delete users api_instance.um_users_delete(user_id, opts) rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_delete: #{e}" end ``` #### Using the um\_users\_delete\_with\_http\_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > \ um\_users\_delete\_with\_http\_info(user\_id, opts) ```ruby begin # Delete users data, status_code, headers = api_instance.um_users_delete_with_http_info(user_id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_delete_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **user\_id** | **String** | The unique ID of the user. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type nil (empty response body) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_users\_find\_by\_id > um\_users\_find\_by\_id(user\_id, opts) Retrieve users Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new user_id = 'user_id_example' # String | The unique ID of the user. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve users result = api_instance.um_users_find_by_id(user_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_find_by_id: #{e}" end ``` #### Using the um\_users\_find\_by\_id\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_users\_find\_by\_id\_with\_http\_info(user\_id, opts) ```ruby begin # Retrieve users data, status_code, headers = api_instance.um_users_find_by_id_with_http_info(user_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_find_by_id_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **user\_id** | **String** | The unique ID of the user. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**User**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/user) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_users\_get > um\_users\_get(opts) List all users List all the users in your account. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (used together with limit for pagination). limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination). } begin # List all users result = api_instance.um_users_get(opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_get: #{e}" end ``` #### Using the um\_users\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_users\_get\_with\_http\_info(opts) ```ruby begin # List all users data, status_code, headers = api_instance.um_users_get_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (used together with \\limit\\ for pagination). | \[optional]\[default to 0] | | **limit** | **Integer** | The maximum number of elements to return (use together with \offset\ for pagination). | \[optional]\[default to 100] | ### Return type [**Users**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/users) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_users\_groups\_get > um\_users\_groups\_get(user\_id, opts) Retrieve group resources by user ID Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new user_id = 'user_id_example' # String | The unique ID of the user. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve group resources by user ID result = api_instance.um_users_groups_get(user_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_groups_get: #{e}" end ``` #### Using the um\_users\_groups\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_users\_groups\_get\_with\_http\_info(user\_id, opts) ```ruby begin # Retrieve group resources by user ID data, status_code, headers = api_instance.um_users_groups_get_with_http_info(user_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_groups_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **user\_id** | **String** | The unique ID of the user. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**ResourceGroups**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/resourcegroups) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_users\_owns\_get > um\_users\_owns\_get(user\_id, opts) Retrieve user resources by user ID Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new user_id = 'user_id_example' # String | The unique ID of the user. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Retrieve user resources by user ID result = api_instance.um_users_owns_get(user_id, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_owns_get: #{e}" end ``` #### Using the um\_users\_owns\_get\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_users\_owns\_get\_with\_http\_info(user\_id, opts) ```ruby begin # Retrieve user resources by user ID data, status_code, headers = api_instance.um_users_owns_get_with_http_info(user_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_owns_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **user\_id** | **String** | The unique ID of the user. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**ResourcesUsers**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/resourcesusers) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## um\_users\_post > um\_users\_post(user, opts) Create users Create a user. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new user = Ionoscloud::UserPost.new({properties: Ionoscloud::UserPropertiesPost.new}) # UserPost | The user to create. opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Create users result = api_instance.um_users_post(user, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_post: #{e}" end ``` #### Using the um\_users\_post\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_users\_post\_with\_http\_info(user, opts) ```ruby begin # Create users data, status_code, headers = api_instance.um_users_post_with_http_info(user, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_post_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **user** | [**UserPost**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/userpost) | The user to create. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**User**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/user) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## um\_users\_put > um\_users\_put(user\_id, user, opts) Modify users Modify the properties of the specified user. ### Examples ```ruby require 'time' require 'ionoscloud' # setup authorization Ionoscloud.configure do |config| # Configure HTTP basic authorization: Basic Authentication config.username = 'YOUR USERNAME' config.password = 'YOUR PASSWORD' # Configure API key authorization: Token Authentication config.api_key['Authorization'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Authorization'] = 'Bearer' end api_instance = Ionoscloud::UserManagementApi.new user_id = 'user_id_example' # String | The unique ID of the user. user = Ionoscloud::UserPut.new({properties: Ionoscloud::UserPropertiesPut.new}) # UserPut | The modified user opts = { pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. } begin # Modify users result = api_instance.um_users_put(user_id, user, opts) p result rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_put: #{e}" end ``` #### Using the um\_users\_put\_with\_http\_info variant This returns an Array which contains the response data, status code and headers. > \ um\_users\_put\_with\_http\_info(user\_id, user, opts) ```ruby begin # Modify users data, status_code, headers = api_instance.um_users_put_with_http_info(user_id, user, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue Ionoscloud::ApiError => e puts "Error when calling UserManagementApi->um_users_put_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ----------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | | **user\_id** | **String** | The unique ID of the user. | | | **user** | [**UserPut**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/userput) | The modified user | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional]\[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional]\[default to 0] | | **x\_contract\_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | ### Return type [**User**](https://docs.ionos.com/sections-test/ruby-sdk/cloud-api-ruby-sdk/models/user) ### Authorization Basic Authentication, Token Authentication ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json