Models

UserManagementApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method

HTTP request

Description

um_groups_delete

DELETE /um/groups/{groupId}

Delete a Group

um_groups_find_by_id

GET /um/groups/{groupId}

Retrieve a Group

um_groups_get

GET /um/groups

List All Groups.

um_groups_post

POST /um/groups

Create a Group

um_groups_put

PUT /um/groups/{groupId}

Modify a group

um_groups_resources_get

GET /um/groups/{groupId}/resources

Retrieve resources assigned to a group

um_groups_shares_delete

DELETE /um/groups/{groupId}/shares/{resourceId}

Remove a resource from a group

um_groups_shares_find_by_resource_id

GET /um/groups/{groupId}/shares/{resourceId}

Retrieve a group share

um_groups_shares_get

GET /um/groups/{groupId}/shares

List Group Shares

um_groups_shares_post

POST /um/groups/{groupId}/shares/{resourceId}

Add a resource to a group

um_groups_shares_put

PUT /um/groups/{groupId}/shares/{resourceId}

Modify resource permissions of a group

um_groups_users_delete

DELETE /um/groups/{groupId}/users/{userId}

Remove a user from a group

um_groups_users_get

GET /um/groups/{groupId}/users

List Group Members

um_groups_users_post

POST /um/groups/{groupId}/users

Add a user to a group

um_resources_find_by_type

GET /um/resources/{resourceType}

Retrieve a list of Resources by type.

um_resources_find_by_type_and_id

GET /um/resources/{resourceType}/{resourceId}

Retrieve a Resource by type.

um_resources_get

GET /um/resources

List All Resources.

um_users_delete

DELETE /um/users/{userId}

Delete a User

um_users_find_by_id

GET /um/users/{userId}

Retrieve a User

um_users_get

GET /um/users

List all Users

um_users_groups_get

GET /um/users/{userId}/groups

Retrieve a User's group resources

um_users_owns_get

GET /um/users/{userId}/owns

Retrieve a User's own resources

um_users_post

POST /um/users

Create a user

um_users_put

PUT /um/users/{userId}

Modify a user

um_users_s3keys_delete

DELETE /um/users/{userId}/s3keys/{keyId}

Delete a S3 key

um_users_s3keys_find_by_key_id

GET /um/users/{userId}/s3keys/{keyId}

Retrieve given S3 key belonging to the given User

um_users_s3keys_get

GET /um/users/{userId}/s3keys

Retrieve a User's S3 keys

um_users_s3keys_post

POST /um/users/{userId}/s3keys

Create a S3 key for the given user

um_users_s3keys_put

PUT /um/users/{userId}/s3keys/{keyId}

Modify a S3 key having the given key id

um_users_s3ssourl_get

GET /um/users/{userId}/s3ssourl

Retrieve S3 object storage single signon URL for the given user

um_groups_delete

Object um_groups_delete(group_id, opts)

Delete a Group

Delete a group

Examples

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 response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Delete a Group
result = api_instance.um_groups_delete(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_delete: #{e}"
end

Using the um_groups_delete_with_http_info variant

This returns an Array which contains the response data, status code and headers.

um_groups_delete_with_http_info(group_id, opts)

begin
# Delete a Group
data, status_code, headers = api_instance.um_groups_delete_with_http_info(group_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => Object
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_delete_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

The unique ID of the group

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Object

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_find_by_id

um_groups_find_by_id(group_id, opts)

Retrieve 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.

Examples

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 response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Retrieve a Group
result = api_instance.um_groups_find_by_id(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_find_by_id: #{e}"
end

Using the um_groups_find_by_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_find_by_id_with_http_info(group_id, opts)

begin
# Retrieve a Group
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

Parameters

Name

Type

Description

Notes

group_id

String

The unique ID of the group

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_get

um_groups_get(opts)

List All Groups.

You can retrieve a complete list of all groups that you have access to

Examples

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 response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# List All Groups.
result = api_instance.um_groups_get(opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_get: #{e}"
end

Using the um_groups_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, 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

Parameters

Name

Type

Description

Notes

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Groups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_post

um_groups_post(group, opts)

Create a Group

You can use this POST method to create a group

Examples

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 | Group to be created
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Create a Group
result = api_instance.um_groups_post(group, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_post: #{e}"
end

Using the um_groups_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_post_with_http_info(group, opts)

begin
# Create a Group
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

Parameters

Name

Type

Description

Notes

group

Group

Group to be created

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

um_groups_put

um_groups_put(group_id, group, opts)

Modify a group

You can use this method to update properties of the group.

Examples

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 | Modified properties of the Group
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Modify a group
result = api_instance.um_groups_put(group_id, group, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_put: #{e}"
end

Using the um_groups_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_put_with_http_info(group_id, group, opts)

begin
# Modify a group
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

Parameters

Name

Type

Description

Notes

group_id

String

The unique ID of the group

group

Group

Modified properties of the Group

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

um_groups_resources_get

um_groups_resources_get(group_id, opts)

Retrieve resources assigned to a group

Examples

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 response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Retrieve resources assigned to a group
result = api_instance.um_groups_resources_get(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_resources_get: #{e}"
end

Using the um_groups_resources_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_resources_get_with_http_info(group_id, opts)

begin
# Retrieve resources assigned to a group
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

Parameters

Name

Type

Description

Notes

group_id

String

The unique ID of the group

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

ResourceGroups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_shares_delete

Object um_groups_shares_delete(group_id, resource_id, opts)

Remove a resource from a group

This will remove a resource from a group

Examples

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 |
resource_id = 'resource_id_example' # String |
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Remove a resource from a group
result = api_instance.um_groups_shares_delete(group_id, resource_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_delete: #{e}"
end

Using the um_groups_shares_delete_with_http_info variant

This returns an Array which contains the response data, status code and headers.

um_groups_shares_delete_with_http_info(group_id, resource_id, opts)

begin
# Remove a resource from a group
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 # => Object
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_delete_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

resource_id

String

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Object

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_shares_find_by_resource_id

um_groups_shares_find_by_resource_id(group_id, resource_id, opts)

Retrieve a group share

This will retrieve the properties of a group share.

Examples

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 |
resource_id = 'resource_id_example' # String |
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Retrieve a group share
result = api_instance.um_groups_shares_find_by_resource_id(group_id, resource_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id: #{e}"
end

Using the um_groups_shares_find_by_resource_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)

begin
# Retrieve a group share
data, status_code, headers = api_instance.um_groups_shares_find_by_resource_id_with_http_info(group_id, resource_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GroupShare>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_find_by_resource_id_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

resource_id

String

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

GroupShare

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_shares_get

um_groups_shares_get(group_id, opts)

List Group Shares

You can retrieve a list of all resources along with their permissions of the group

Examples

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 |
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# List Group Shares
result = api_instance.um_groups_shares_get(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_get: #{e}"
end

Using the um_groups_shares_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_shares_get_with_http_info(group_id, opts)

begin
# List Group Shares
data, status_code, headers = api_instance.um_groups_shares_get_with_http_info(group_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GroupShares>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_get_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

GroupShares

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_shares_post

um_groups_shares_post(group_id, resource_id, resource, opts)

Add a resource to a group

This will add a resource to the group.

Examples

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 |
resource_id = 'resource_id_example' # String |
resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Resource to be added
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Add a resource to a group
result = api_instance.um_groups_shares_post(group_id, resource_id, resource, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_post: #{e}"
end

Using the um_groups_shares_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)

begin
# Add a resource to a group
data, status_code, headers = api_instance.um_groups_shares_post_with_http_info(group_id, resource_id, resource, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GroupShare>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_post_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

resource_id

String

resource

GroupShare

Resource to be added

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

GroupShare

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_shares_put

um_groups_shares_put(group_id, resource_id, resource, opts)

Modify 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

Examples

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 |
resource_id = 'resource_id_example' # String |
resource = Ionoscloud::GroupShare.new({properties: Ionoscloud::GroupShareProperties.new}) # GroupShare | Modified Resource
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Modify resource permissions of a group
result = api_instance.um_groups_shares_put(group_id, resource_id, resource, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_put: #{e}"
end

Using the um_groups_shares_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)

begin
# Modify resource permissions of a group
data, status_code, headers = api_instance.um_groups_shares_put_with_http_info(group_id, resource_id, resource, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GroupShare>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_shares_put_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

resource_id

String

resource

GroupShare

Modified Resource

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

GroupShare

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

um_groups_users_delete

Object um_groups_users_delete(group_id, user_id, opts)

Remove a user from a group

This will remove a user from a group

Examples

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 |
user_id = 'user_id_example' # String |
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Remove a user from a group
result = api_instance.um_groups_users_delete(group_id, user_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_users_delete: #{e}"
end

Using the um_groups_users_delete_with_http_info variant

This returns an Array which contains the response data, status code and headers.

um_groups_users_delete_with_http_info(group_id, user_id, opts)

begin
# Remove a user from a group
data, status_code, headers = api_instance.um_groups_users_delete_with_http_info(group_id, user_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => Object
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_users_delete_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

user_id

String

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Object

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_users_get

um_groups_users_get(group_id, opts)

List Group Members

You can retrieve a list of users who are members of the group

Examples

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 |
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# List Group Members
result = api_instance.um_groups_users_get(group_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_users_get: #{e}"
end

Using the um_groups_users_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_users_get_with_http_info(group_id, opts)

begin
# List Group Members
data, status_code, headers = api_instance.um_groups_users_get_with_http_info(group_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <GroupMembers>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_users_get_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

GroupMembers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_groups_users_post

um_groups_users_post(group_id, user, opts)

Add a user to a group

This will attach a pre-existing user to a group.

Examples

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 |
user = Ionoscloud::User.new({properties: Ionoscloud::UserProperties.new}) # User | User to be added
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Add a user to a group
result = api_instance.um_groups_users_post(group_id, user, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_users_post: #{e}"
end

Using the um_groups_users_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_groups_users_post_with_http_info(group_id, user, opts)

begin
# Add a user to a group
data, status_code, headers = api_instance.um_groups_users_post_with_http_info(group_id, user, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <User>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_groups_users_post_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

group_id

String

user

User

User to be added

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

User

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

um_resources_find_by_type

um_resources_find_by_type(resource_type, opts)

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.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
resource_type = 'resource_type_example' # String | The resource Type
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Retrieve a list of Resources by type.
result = api_instance.um_resources_find_by_type(resource_type, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_resources_find_by_type: #{e}"
end

Using the um_resources_find_by_type_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_resources_find_by_type_with_http_info(resource_type, opts)

begin
# Retrieve a list of Resources by type.
data, status_code, headers = api_instance.um_resources_find_by_type_with_http_info(resource_type, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Resources>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_resources_find_by_type_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

resource_type

String

The resource Type

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Resources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_resources_find_by_type_and_id

um_resources_find_by_type_and_id(resource_type, resource_id, opts)

Retrieve 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.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::UserManagementApi.new
resource_type = 'resource_type_example' # String | The resource Type
resource_id = 'resource_id_example' # String | The resource Uuid
opts = {
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}
begin
# Retrieve a Resource by type.
result = api_instance.um_resources_find_by_type_and_id(resource_type, resource_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id: #{e}"
end

Using the um_resources_find_by_type_and_id_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)

begin
# Retrieve a Resource by type.
data, status_code, headers = api_instance.um_resources_find_by_type_and_id_with_http_info(resource_type, resource_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Resource>
rescue Ionoscloud::ApiError => e
puts "Error when calling UserManagementApi->um_resources_find_by_type_and_id_with_http_info: #{e}"
end

Parameters

Name

Type

Description

Notes

resource_type

String

The resource Type

resource_id

String

The resource Uuid

pretty

Boolean

Controls whether response is pretty-printed (with indentation and new lines)

[optional][default to true]

depth

Integer

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[optional][default to 0]

x_contract_number

Integer

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

[optional]

Return type

Resource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

um_resources_get

um_resources_get(opts)