lib/ionoscloud/api/user_management_api.rb in ionoscloud-6.0.0.beta.4 vs lib/ionoscloud/api/user_management_api.rb in ionoscloud-6.0.0
- old
+ new
@@ -1,11 +1,11 @@
=begin
#CLOUD API
#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.3
+The version of the OpenAPI document: 6.0
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 5.2.1-SNAPSHOT
=end
@@ -17,26 +17,26 @@
attr_accessor :api_client
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
- # Delete a Group
- # Delete a group
- # @param group_id [String] The unique ID of the group
+ # Delete groups
+ # Remove the specified group.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
+ # Delete groups
+ # Remove the specified group.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
@@ -97,26 +97,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
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
+ # Retrieve groups
+ # Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
+ # Retrieve groups
+ # Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
@@ -177,24 +177,24 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # List All Groups.
- # You can retrieve a complete list of all groups that you have access to
+ # List all groups
+ # List all the available user groups.
# @param [Hash] opts the optional parameters
# @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
+ # List all groups
+ # List all the available user groups.
# @param [Hash] opts the optional parameters
# @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
@@ -251,26 +251,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Create a Group
- # You can use this POST method to create a group
- # @param group [Group] Group to be created
+ # Create groups
+ # Create a group.
+ # @param group [Group] The group to create.
# @param [Hash] opts the optional parameters
# @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
+ # Create groups
+ # Create a group.
+ # @param group [Group] The group to create.
# @param [Hash] opts the optional parameters
# @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
@@ -333,28 +333,28 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # 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
+ # Modify groups
+ # Modify the properties of the specified group.
+ # @param group_id [String] The unique ID of the group.
+ # @param group [Group] The modified group.
# @param [Hash] opts the optional parameters
# @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
- # 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
+ # Modify groups
+ # Modify the properties of the specified group.
+ # @param group_id [String] The unique ID of the group.
+ # @param group [Group] The modified group.
# @param [Hash] opts the optional parameters
# @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
@@ -421,24 +421,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Retrieve resources assigned to a group
- # @param group_id [String] The unique ID of the group
+ # Retrieve group resources
+ # List the resources assigned to the group, by group ID.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
+ # Retrieve group resources
+ # List the resources assigned to the group, by group ID.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
@@ -499,28 +501,28 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_resources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Remove a resource from a group
- # This will remove a resource from a group
- # @param group_id [String]
- # @param resource_id [String]
+ # Remove group shares
+ # Remove the specified share from the group.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
# @param [Hash] opts the optional parameters
# @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
- # Remove a resource from a group
- # This will remove a resource from a group
- # @param group_id [String]
- # @param resource_id [String]
+ # Remove group shares
+ # Remove the specified share from the group.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
# @param [Hash] opts the optional parameters
# @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
@@ -585,28 +587,28 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_shares_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Retrieve a group share
- # This will retrieve the properties of a group share.
- # @param group_id [String]
- # @param resource_id [String]
+ # Retrieve group shares
+ # Retrieve the properties of the specified group share.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
# @param [Hash] opts the optional parameters
# @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
- # Retrieve a group share
- # This will retrieve the properties of a group share.
- # @param group_id [String]
- # @param resource_id [String]
+ # Retrieve group shares
+ # Retrieve the properties of the specified group share.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
# @param [Hash] opts the optional parameters
# @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
@@ -671,26 +673,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_shares_find_by_resource_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # List Group Shares
- # You can retrieve a list of all resources along with their permissions of the group
- # @param group_id [String]
+ # List group shares
+ # List all shares and share privileges for the specified group.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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]
+ # List group shares
+ # List all shares and share privileges for the specified group.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
@@ -751,30 +753,30 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_shares_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Add a resource to a group
- # This will add a resource to the group.
- # @param group_id [String]
- # @param resource_id [String]
- # @param resource [GroupShare] Resource to be added
+ # Add group shares
+ # Add the specified share to the group.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
+ # @param resource [GroupShare] The resource to add.
# @param [Hash] opts the optional parameters
# @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
- # Add a resource to a group
- # This will add a resource to the group.
- # @param group_id [String]
- # @param resource_id [String]
- # @param resource [GroupShare] Resource to be added
+ # Add group shares
+ # Add the specified share to the group.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
+ # @param resource [GroupShare] The resource to add.
# @param [Hash] opts the optional parameters
# @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
@@ -843,30 +845,30 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_shares_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Modify resource permissions of a group
- # 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
+ # Modify group share privileges
+ # Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
+ # @param resource [GroupShare] The modified resource
# @param [Hash] opts the optional parameters
# @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
- # Modify resource permissions of a group
- # 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
+ # Modify group share privileges
+ # Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
+ # @param group_id [String] The unique ID of the group.
+ # @param resource_id [String] The unique ID of the resource.
+ # @param resource [GroupShare] The modified resource
# @param [Hash] opts the optional parameters
# @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
@@ -937,28 +939,28 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_shares_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Remove a user from a group
- # This will remove a user from a group.
- # @param group_id [String]
- # @param user_id [String]
+ # Remove users from groups
+ # Remove the specified user from the group.
+ # @param group_id [String] The unique ID of the group.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
- # Remove a user from a group
- # This will remove a user from a group.
- # @param group_id [String]
- # @param user_id [String]
+ # Remove users from groups
+ # Remove the specified user from the group.
+ # @param group_id [String] The unique ID of the group.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
@@ -1023,26 +1025,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_users_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # List Group Members
- # You can retrieve a list of users who are members of the group
- # @param group_id [String]
+ # List group members
+ # List all members of the specified user group.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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]
+ # List group members
+ # List all members of the specified user group.
+ # @param group_id [String] The unique ID of the group.
# @param [Hash] opts the optional parameters
# @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
@@ -1103,28 +1105,28 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # 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
+ # Add group members
+ # Add an existing user to the specified group.
+ # @param group_id [String] The unique ID of the group.
+ # @param user [User] The user to add.
# @param [Hash] opts the optional parameters
# @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
- # 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
+ # Add group members
+ # Add an existing user to the specified group.
+ # @param group_id [String] The unique ID of the group.
+ # @param user [User] The user to add.
# @param [Hash] opts the optional parameters
# @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
@@ -1191,26 +1193,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_groups_users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
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
+ # List resources by type
+ # List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
+ # @param resource_type [String] The resource type
# @param [Hash] opts the optional parameters
# @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
+ # List resources by type
+ # List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
+ # @param resource_type [String] The resource type
# @param [Hash] opts the optional parameters
# @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
@@ -1271,28 +1273,28 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_resources_find_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # 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
+ # Retrieve resources by type
+ # Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
+ # @param resource_type [String] The resource type
+ # @param resource_id [String] The resource ID
# @param [Hash] opts the optional parameters
# @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
- # 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
+ # Retrieve resources by type
+ # Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
+ # @param resource_type [String] The resource type
+ # @param resource_id [String] The resource ID
# @param [Hash] opts the optional parameters
# @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
@@ -1357,24 +1359,24 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_resources_find_by_type_and_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # List All Resources.
- # You can retrieve a complete list of all resources that you have access to.
+ # List all resources
+ # List all the available resources.
# @param [Hash] opts the optional parameters
# @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.
+ # List all resources
+ # List all the available resources.
# @param [Hash] opts the optional parameters
# @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
@@ -1431,26 +1433,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_resources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Delete a User
- # Delete a user
- # @param user_id [String] The unique ID of the user
+ # Delete users
+ # Delete the specified user.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
+ # Delete users
+ # Delete the specified user.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
@@ -1511,26 +1513,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_users_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
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
+ # Retrieve users
+ # Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
+ # Retrieve users
+ # Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
@@ -1591,32 +1593,32 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_users_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # List all Users
- # You can retrieve a complete list of users under your account
+ # List all users
+ # List all the users in your account.
# @param [Hash] opts the optional parameters
# @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)
+ # @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
+ # List all users
+ # List all the users in your account.
# @param [Hash] opts the optional parameters
# @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)
+ # @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
@@ -1683,26 +1685,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
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
+ # Retrieve group resources by user ID
+ # Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
+ # Retrieve group resources by user ID
+ # Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
@@ -1763,26 +1765,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_users_groups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
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
+ # Retrieve user resources by user ID
+ # Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
+ # Retrieve user resources by user ID
+ # Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
+ # @param user_id [String] The unique ID of the user.
# @param [Hash] opts the optional parameters
# @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
@@ -1843,26 +1845,26 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_users_owns_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Create a user
- # You can use this POST method to create a user
- # @param user [UserPost] User to be created
+ # Create users
+ # Create a user.
+ # @param user [UserPost] The user to create.
# @param [Hash] opts the optional parameters
# @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
+ # Create users
+ # Create a user.
+ # @param user [UserPost] The user to create.
# @param [Hash] opts the optional parameters
# @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
@@ -1925,27 +1927,27 @@
@api_client.config.logger.debug "API called: UserManagementApi#um_users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end
- # Modify a user
- # You can use update attributes of a User
- # @param user_id [String]
- # @param user [UserPut] Modified user
+ # Modify users
+ # Modify the properties of the specified user.
+ # @param user_id [String] The unique ID of the user.
+ # @param user [UserPut] The modified user
# @param [Hash] opts the optional parameters
# @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
- # Modify a user
- # You can use update attributes of a User
- # @param user_id [String]
- # @param user [UserPut] Modified user
+ # Modify users
+ # Modify the properties of the specified user.
+ # @param user_id [String] The unique ID of the user.
+ # @param user [UserPut] The modified user
# @param [Hash] opts the optional parameters
# @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