lib/ionoscloud/api/user_management_api.rb in ionoscloud-6.0.0.beta.3 vs lib/ionoscloud/api/user_management_api.rb in ionoscloud-6.0.0.beta.4
- old
+ new
@@ -1,14 +1,14 @@
=begin
#CLOUD API
-#An enterprise-grade Infrastructure is provided as a Service (IaaS) solution that can be managed through a browser-based \"Data Center Designer\" (DCD) tool or via an easy to use API. The API allows you to perform a variety of management tasks such as spinning up additional servers, adding volumes, adjusting networking, and so forth. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.
+#IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the \"Data Center Designer\" (DCD) browser-based tool. Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.
-The version of the OpenAPI document: 6.0-SDK.1
+The version of the OpenAPI document: 6.0-SDK.3
Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1-SNAPSHOT
+OpenAPI Generator version: 5.2.1-SNAPSHOT
=end
require 'cgi'
@@ -21,26 +21,26 @@
end
# Delete a Group
# Delete a group
# @param group_id [String] The unique ID of the group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [nil]
def um_groups_delete(group_id, opts = {})
um_groups_delete_with_http_info(group_id, opts)
nil
end
# Delete a Group
# Delete a group
# @param group_id [String] The unique ID of the group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def um_groups_delete_with_http_info(group_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_delete ...'
end
@@ -101,26 +101,26 @@
# Retrieve a Group
# You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
# @param group_id [String] The unique ID of the group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Group]
def um_groups_find_by_id(group_id, opts = {})
data, _status_code, _headers = um_groups_find_by_id_with_http_info(group_id, opts)
data
end
# Retrieve a Group
# You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
# @param group_id [String] The unique ID of the group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
def um_groups_find_by_id_with_http_info(group_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_find_by_id ...'
end
@@ -180,25 +180,25 @@
end
# List All Groups.
# You can retrieve a complete list of all groups that you have access to
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Groups]
def um_groups_get(opts = {})
data, _status_code, _headers = um_groups_get_with_http_info(opts)
data
end
# List All Groups.
# You can retrieve a complete list of all groups that you have access to
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Groups, Integer, Hash)>] Groups data, response status code and response headers
def um_groups_get_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_get ...'
end
@@ -255,26 +255,26 @@
# Create a Group
# You can use this POST method to create a group
# @param group [Group] Group to be created
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Group]
def um_groups_post(group, opts = {})
data, _status_code, _headers = um_groups_post_with_http_info(group, opts)
data
end
# Create a Group
# You can use this POST method to create a group
# @param group [Group] Group to be created
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
def um_groups_post_with_http_info(group, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_post ...'
end
@@ -338,13 +338,13 @@
# Modify a group
# You can use this method to update properties of the group.
# @param group_id [String] The unique ID of the group
# @param group [Group] Modified properties of the Group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Group]
def um_groups_put(group_id, group, opts = {})
data, _status_code, _headers = um_groups_put_with_http_info(group_id, group, opts)
data
end
@@ -352,13 +352,13 @@
# Modify a group
# You can use this method to update properties of the group.
# @param group_id [String] The unique ID of the group
# @param group [Group] Modified properties of the Group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Group, Integer, Hash)>] Group data, response status code and response headers
def um_groups_put_with_http_info(group_id, group, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_put ...'
end
@@ -424,25 +424,25 @@
end
# Retrieve resources assigned to a group
# @param group_id [String] The unique ID of the group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [ResourceGroups]
def um_groups_resources_get(group_id, opts = {})
data, _status_code, _headers = um_groups_resources_get_with_http_info(group_id, opts)
data
end
# Retrieve resources assigned to a group
# @param group_id [String] The unique ID of the group
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(ResourceGroups, Integer, Hash)>] ResourceGroups data, response status code and response headers
def um_groups_resources_get_with_http_info(group_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_resources_get ...'
end
@@ -504,13 +504,13 @@
# Remove a resource from a group
# This will remove a resource from a group
# @param group_id [String]
# @param resource_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [nil]
def um_groups_shares_delete(group_id, resource_id, opts = {})
um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
nil
end
@@ -518,13 +518,13 @@
# Remove a resource from a group
# This will remove a resource from a group
# @param group_id [String]
# @param resource_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def um_groups_shares_delete_with_http_info(group_id, resource_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_shares_delete ...'
end
@@ -590,13 +590,13 @@
# Retrieve a group share
# This will retrieve the properties of a group share.
# @param group_id [String]
# @param resource_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [GroupShare]
def um_groups_shares_find_by_resource_id(group_id, resource_id, opts = {})
data, _status_code, _headers = um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
data
end
@@ -604,13 +604,13 @@
# Retrieve a group share
# This will retrieve the properties of a group share.
# @param group_id [String]
# @param resource_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(GroupShare, Integer, Hash)>] GroupShare data, response status code and response headers
def um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_shares_find_by_resource_id ...'
end
@@ -675,26 +675,26 @@
# List Group Shares
# You can retrieve a list of all resources along with their permissions of the group
# @param group_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [GroupShares]
def um_groups_shares_get(group_id, opts = {})
data, _status_code, _headers = um_groups_shares_get_with_http_info(group_id, opts)
data
end
# List Group Shares
# You can retrieve a list of all resources along with their permissions of the group
# @param group_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(GroupShares, Integer, Hash)>] GroupShares data, response status code and response headers
def um_groups_shares_get_with_http_info(group_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_shares_get ...'
end
@@ -757,13 +757,13 @@
# This will add a resource to the group.
# @param group_id [String]
# @param resource_id [String]
# @param resource [GroupShare] Resource to be added
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [GroupShare]
def um_groups_shares_post(group_id, resource_id, resource, opts = {})
data, _status_code, _headers = um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
data
end
@@ -772,13 +772,13 @@
# This will add a resource to the group.
# @param group_id [String]
# @param resource_id [String]
# @param resource [GroupShare] Resource to be added
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(GroupShare, Integer, Hash)>] GroupShare data, response status code and response headers
def um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_shares_post ...'
end
@@ -849,13 +849,13 @@
# You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
# @param group_id [String]
# @param resource_id [String]
# @param resource [GroupShare] Modified Resource
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [GroupShare]
def um_groups_shares_put(group_id, resource_id, resource, opts = {})
data, _status_code, _headers = um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
data
end
@@ -864,13 +864,13 @@
# You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
# @param group_id [String]
# @param resource_id [String]
# @param resource [GroupShare] Modified Resource
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(GroupShare, Integer, Hash)>] GroupShare data, response status code and response headers
def um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_shares_put ...'
end
@@ -942,13 +942,13 @@
# Remove a user from a group
# This will remove a user from a group.
# @param group_id [String]
# @param user_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [nil]
def um_groups_users_delete(group_id, user_id, opts = {})
um_groups_users_delete_with_http_info(group_id, user_id, opts)
nil
end
@@ -956,13 +956,13 @@
# Remove a user from a group
# This will remove a user from a group.
# @param group_id [String]
# @param user_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def um_groups_users_delete_with_http_info(group_id, user_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_users_delete ...'
end
@@ -1027,26 +1027,26 @@
# List Group Members
# You can retrieve a list of users who are members of the group
# @param group_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [GroupMembers]
def um_groups_users_get(group_id, opts = {})
data, _status_code, _headers = um_groups_users_get_with_http_info(group_id, opts)
data
end
# List Group Members
# You can retrieve a list of users who are members of the group
# @param group_id [String]
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(GroupMembers, Integer, Hash)>] GroupMembers data, response status code and response headers
def um_groups_users_get_with_http_info(group_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_users_get ...'
end
@@ -1108,13 +1108,13 @@
# Add a user to a group
# This will attach a pre-existing user to a group.
# @param group_id [String]
# @param user [User] User to be added
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [User]
def um_groups_users_post(group_id, user, opts = {})
data, _status_code, _headers = um_groups_users_post_with_http_info(group_id, user, opts)
data
end
@@ -1122,13 +1122,13 @@
# Add a user to a group
# This will attach a pre-existing user to a group.
# @param group_id [String]
# @param user [User] User to be added
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
def um_groups_users_post_with_http_info(group_id, user, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_groups_users_post ...'
end
@@ -1195,26 +1195,26 @@
# Retrieve a list of Resources by type.
# You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. This value of resource type also be found in the response body when you GET a list of all resources.
# @param resource_type [String] The resource Type
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Resources]
def um_resources_find_by_type(resource_type, opts = {})
data, _status_code, _headers = um_resources_find_by_type_with_http_info(resource_type, opts)
data
end
# Retrieve a list of Resources by type.
# You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. This value of resource type also be found in the response body when you GET a list of all resources.
# @param resource_type [String] The resource Type
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Resources, Integer, Hash)>] Resources data, response status code and response headers
def um_resources_find_by_type_with_http_info(resource_type, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_resources_find_by_type ...'
end
@@ -1276,13 +1276,13 @@
# Retrieve a Resource by type.
# You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. The value of resource type can also be found in the response body when you GET a list of all resources.
# @param resource_type [String] The resource Type
# @param resource_id [String] The resource Uuid
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Resource]
def um_resources_find_by_type_and_id(resource_type, resource_id, opts = {})
data, _status_code, _headers = um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
data
end
@@ -1290,13 +1290,13 @@
# Retrieve a Resource by type.
# You can retrieve a resource by using the type and its uuid. Allowed values for types are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. The value of resource type can also be found in the response body when you GET a list of all resources.
# @param resource_type [String] The resource Type
# @param resource_id [String] The resource Uuid
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Resource, Integer, Hash)>] Resource data, response status code and response headers
def um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_resources_find_by_type_and_id ...'
end
@@ -1360,25 +1360,25 @@
end
# List All Resources.
# You can retrieve a complete list of all resources that you have access to.
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Resources]
def um_resources_get(opts = {})
data, _status_code, _headers = um_resources_get_with_http_info(opts)
data
end
# List All Resources.
# You can retrieve a complete list of all resources that you have access to.
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(Resources, Integer, Hash)>] Resources data, response status code and response headers
def um_resources_get_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_resources_get ...'
end
@@ -1435,26 +1435,26 @@
# Delete a User
# Delete a user
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [nil]
def um_users_delete(user_id, opts = {})
um_users_delete_with_http_info(user_id, opts)
nil
end
# Delete a User
# Delete a user
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
def um_users_delete_with_http_info(user_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_delete ...'
end
@@ -1515,26 +1515,26 @@
# Retrieve a User
# You can retrieve user details by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [User]
def um_users_find_by_id(user_id, opts = {})
data, _status_code, _headers = um_users_find_by_id_with_http_info(user_id, opts)
data
end
# Retrieve a User
# You can retrieve user details by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
def um_users_find_by_id_with_http_info(user_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_find_by_id ...'
end
@@ -1594,25 +1594,29 @@
end
# List all Users
# You can retrieve a complete list of users under your account
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
+ # @option opts [Integer] :offset The first element (from the complete list of the elements) to include in the response (use together with limit for pagination). (default to 0)
+ # @option opts [Integer] :limit the maximum number of elements to return (use together with <code>offset</code> for pagination) (default to 100)
# @return [Users]
def um_users_get(opts = {})
data, _status_code, _headers = um_users_get_with_http_info(opts)
data
end
# List all Users
# You can retrieve a complete list of users under your account
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
+ # @option opts [Integer] :offset The first element (from the complete list of the elements) to include in the response (use together with limit for pagination).
+ # @option opts [Integer] :limit the maximum number of elements to return (use together with <code>offset</code> for pagination)
# @return [Array<(Users, Integer, Hash)>] Users data, response status code and response headers
def um_users_get_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_get ...'
end
@@ -1622,17 +1626,31 @@
if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling UserManagementApi.um_users_get, must be greater than or equal to 0.'
end
+ if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+ fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling UserManagementApi.um_users_get, must be greater than or equal to 0.'
+ end
+
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagementApi.um_users_get, must be smaller than or equal to 100.'
+ end
+
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagementApi.um_users_get, must be greater than or equal to 1.'
+ end
+
# resource path
local_var_path = '/um/users'
# query parameters
query_params = opts[:query_params] || {}
query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
@@ -1669,26 +1687,26 @@
# Retrieve a User's group resources
# You can retrieve group resources of user by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [ResourceGroups]
def um_users_groups_get(user_id, opts = {})
data, _status_code, _headers = um_users_groups_get_with_http_info(user_id, opts)
data
end
# Retrieve a User's group resources
# You can retrieve group resources of user by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(ResourceGroups, Integer, Hash)>] ResourceGroups data, response status code and response headers
def um_users_groups_get_with_http_info(user_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_groups_get ...'
end
@@ -1749,26 +1767,26 @@
# Retrieve a User's own resources
# You can retrieve resources owned by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [ResourcesUsers]
def um_users_owns_get(user_id, opts = {})
data, _status_code, _headers = um_users_owns_get_with_http_info(user_id, opts)
data
end
# Retrieve a User's own resources
# You can retrieve resources owned by using the users ID. This value can be found in the response body when a user is created or when you GET a list of users.
# @param user_id [String] The unique ID of the user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(ResourcesUsers, Integer, Hash)>] ResourcesUsers data, response status code and response headers
def um_users_owns_get_with_http_info(user_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_owns_get ...'
end
@@ -1829,26 +1847,26 @@
# Create a user
# You can use this POST method to create a user
# @param user [UserPost] User to be created
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [User]
def um_users_post(user, opts = {})
data, _status_code, _headers = um_users_post_with_http_info(user, opts)
data
end
# Create a user
# You can use this POST method to create a user
# @param user [UserPost] User to be created
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
def um_users_post_with_http_info(user, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_post ...'
end
@@ -1912,13 +1930,13 @@
# Modify a user
# You can use update attributes of a User
# @param user_id [String]
# @param user [UserPut] Modified user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on (default to 0)
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines). (default to true)
+ # @option opts [Integer] :depth 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 (default to 0)
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [User]
def um_users_put(user_id, user, opts = {})
data, _status_code, _headers = um_users_put_with_http_info(user_id, user, opts)
data
end
@@ -1926,12 +1944,12 @@
# Modify a user
# You can use update attributes of a User
# @param user_id [String]
# @param user [UserPut] Modified user
# @param [Hash] opts the optional parameters
- # @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
- # @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
- # @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
+ # @option opts [Boolean] :pretty Controls whether the response is pretty-printed (with indentations and new lines).
+ # @option opts [Integer] :depth 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
+ # @option opts [Integer] :x_contract_number Users with multiple contracts must provide the contract number, against which all API requests are to be executed.
# @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
def um_users_put_with_http_info(user_id, user, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: UserManagementApi.um_users_put ...'
end