UserManagementApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /um/groups/{groupId} | Delete groups | |
GET /um/groups/{groupId} | Retrieve groups | |
GET /um/groups | List all groups | |
POST /um/groups | Create groups | |
PUT /um/groups/{groupId} | Modify groups | |
GET /um/groups/{groupId}/resources | Retrieve group resources | |
DELETE /um/groups/{groupId}/shares/{resourceId} | Remove group shares | |
GET /um/groups/{groupId}/shares/{resourceId} | Retrieve group shares | |
GET /um/groups/{groupId}/shares | List group shares | |
POST /um/groups/{groupId}/shares/{resourceId} | Add group shares | |
PUT /um/groups/{groupId}/shares/{resourceId} | Modify group share privileges | |
DELETE /um/groups/{groupId}/users/{userId} | Remove users from groups | |
GET /um/groups/{groupId}/users | List group members | |
POST /um/groups/{groupId}/users | Add a Group Member | |
GET /um/resources/{resourceType} | List resources by type | |
GET /um/resources/{resourceType}/{resourceId} | Retrieve resources by type | |
GET /um/resources | List all resources | |
DELETE /um/users/{userId} | Delete users | |
GET /um/users/{userId} | Retrieve users | |
GET /um/users | List all users | |
GET /um/users/{userId}/groups | Retrieve group resources by user ID | |
GET /um/users/{userId}/owns | Retrieve user resources by user ID | |
POST /um/users | Create users | |
PUT /um/users/{userId} | Modify users |
um_groups_delete(group_id, opts)
Delete groups
Remove the specified group.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
group_id = 'group_id_example' # String | The unique ID of the group.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Delete groups
api_instance.um_groups_delete(group_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_delete: #{e}"
end
This returns an Array which contains the response data (
nil
in this case), status code and headers.<Array(nil, Integer, Hash)> um_groups_delete_with_http_info(group_id, opts)
begin
# Delete groups
data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_delete_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group. | |
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
um_groups_find_by_id(group_id, opts)
Retrieve groups
Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
group_id = 'group_id_example' # String | The unique ID of the group.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Retrieve groups
result = api_instance.um_groups_find_by_id(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_find_by_id: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_find_by_id_with_http_info(group_id, opts)
begin
# Retrieve groups
data, status_code, headers = api_instance.um_groups_find_by_id_with_http_info(group_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Group>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_find_by_id_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group. | |
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
um_groups_get(opts)
List all groups
List all the available user groups.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# List all groups
result = api_instance.um_groups_get(opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_get: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_get_with_http_info(opts)
begin
# List all groups
data, status_code, headers = api_instance.um_groups_get_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Groups>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_get_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
um_groups_post(group, opts)
Create groups
Create a group.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The group to create.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Create groups
result = api_instance.um_groups_post(group, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_post: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_post_with_http_info(group, opts)
begin
# Create groups
data, status_code, headers = api_instance.um_groups_post_with_http_info(group, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Group>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_post_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
group | The group to create. | | |
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
um_groups_put(group_id, group, opts)
Modify groups
Modify the properties of the specified group.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
group_id = 'group_id_example' # String | The unique ID of the group.
group = Ionoscloud::Group.new({properties: Ionoscloud::GroupProperties.new}) # Group | The modified group.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Modify groups
result = api_instance.um_groups_put(group_id, group, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_put: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_put_with_http_info(group_id, group, opts)
begin
# Modify groups
data, status_code, headers = api_instance.um_groups_put_with_http_info(group_id, group, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Group>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_put_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group. | |
group | The modified group. | | |
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
um_groups_resources_get(group_id, opts)
Retrieve group resources
List the resources assigned to the group, by group ID.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
group_id = 'group_id_example' # String | The unique ID of the group.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Retrieve group resources
result = api_instance.um_groups_resources_get(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_resources_get: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> um_groups_resources_get_with_http_info(group_id, opts)
begin
# Retrieve group resources
data, status_code, headers = api_instance.um_groups_resources_get_with_http_info(group_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <ResourceGroups>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_resources_get_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group. | |
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
um_groups_shares_delete(group_id, resource_id, opts)
Remove group shares
Remove the specified share from the group.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
group_id = 'group_id_example' # String | The unique ID of the group.
resource_id = 'resource_id_example' # String | The unique ID of the resource.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Remove group shares
api_instance.um_groups_shares_delete(group_id, resource_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}"
end
This returns an Array which contains the response data (
nil
in this case), status code and headers.<Array(nil, Integer, Hash)> um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
begin
# Remove group shares
data, status_code, headers = api_instance.um_groups_shares_delete_with_http_info(group_id, resource_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_delete_with_http_info: #{e}"
end
Name | Type | Description | Notes |
---|---|---|---|
group_id | String | The unique ID of the group. | |
resource_id | String | The unique ID of the resource. | |
pretty | Boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json