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, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete groups
Remove the specified group.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
try:
# Delete groups
api_instance.um_groups_delete(group_id)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_delete: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
Group um_groups_find_by_id(group_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
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.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
try:
# Retrieve groups
api_response = api_instance.um_groups_find_by_id(group_id)
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_find_by_id: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | 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
Groups um_groups_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List all groups
List all the available user groups.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
try:
# List all groups
api_response = api_instance.um_groups_get()
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_get: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | 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
Group um_groups_post(group, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Create groups
Create a group.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group = ionoscloud.Group() # Group | The group to create.
try:
# Create groups
api_response = api_instance.um_groups_post(group)
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_post: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group | The group to create. | | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | 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
Group um_groups_put(group_id, group, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Modify groups
Modify the properties of the specified group.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
group = ionoscloud.Group() # Group | The modified group.
try:
# Modify groups
api_response = api_instance.um_groups_put(group_id, group)
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_put: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
group | The modified group. | | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | 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
ResourceGroups um_groups_resources_get(group_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve group resources
List the resources assigned to the group, by group ID.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
try:
# Retrieve group resources
api_response = api_instance.um_groups_resources_get(group_id)
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_resources_get: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | 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, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Remove group shares
Remove the specified share from the group.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
resource_id = 'resource_id_example' # str | The unique ID of the resource.
try:
# Remove group shares
api_instance.um_groups_shares_delete(group_id, resource_id)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_shares_delete: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
resource_id | str | The unique ID of the resource. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
GroupShare um_groups_shares_find_by_resource_id(group_id, resource_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve group shares
Retrieve the properties of the specified group share.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
resource_id = 'resource_id_example' # str | The unique ID of the resource.
try:
# Retrieve group shares
api_response = api_instance.um_groups_shares_find_by_resource_id(group_id, resource_id)
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_shares_find_by_resource_id: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
resource_id | str | The unique ID of the resource. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | 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
GroupShares um_groups_shares_get(group_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List group shares
List all shares and share privileges for the specified group.
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.UserManagementApi(api_client)
group_id = 'group_id_example' # str | The unique ID of the group.
try:
# List group shares
api_response = api_instance.um_groups_shares_get(group_id)
print(api_response)
except ApiException as e:
print('Exception when calling UserManagementApi.um_groups_shares_get: %s\n' % e)
Name | Type | Description | Notes |
---|---|---|---|
group_id | str | The unique ID of the group. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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 | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |