UserManagementApi
UserManagementApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
umGroupsDelete
umGroupsDelete(groupId, pretty, depth, xContractNumber)
Delete groups
Remove the specified group.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsDelete instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
apiInstance.umGroupsDeleteWithHttpInfo(groupId, pretty, depth, xContractNumber);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
apiInstance.umGroupsDelete(groupId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsFindById
Group umGroupsFindById(groupId, pretty, depth, xContractNumber)
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.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsFindByIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsFindById instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<Group> result = apiInstance.umGroupsFindByIdWithHttpInfo(groupId, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsFindById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Group result = apiInstance.umGroupsFindById(groupId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsFindById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsGet
Groups umGroupsGet(pretty, depth, xContractNumber)
List all groups
List all the available user groups.
Parameters
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<Groups> result = apiInstance.umGroupsGetWithHttpInfo(pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Groups result = apiInstance.umGroupsGet()
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsPost
Group umGroupsPost(group, pretty, depth, xContractNumber)
Create groups
Create a group.
Parameters
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsPost instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
properties = new GroupProperties(); // GroupProperties |
group = new Group(GroupProperties); // Group | The group to create.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<Group> result = apiInstance.umGroupsPostWithHttpInfo(group, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Group result = apiInstance.umGroupsPost(group)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsPut
Group umGroupsPut(groupId, group, pretty, depth, xContractNumber)
Modify groups
Modify the properties of the specified group.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsPut instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
properties = new GroupProperties(); // GroupProperties |
group = new Group(GroupProperties); // Group | The modified group.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<Group> result = apiInstance.umGroupsPutWithHttpInfo(groupId, group, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Group result = apiInstance.umGroupsPut(groupId, group)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsResourcesGet
ResourceGroups umGroupsResourcesGet(groupId, pretty, depth, xContractNumber)
Retrieve group resources
List the resources assigned to the group, by group ID.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsResourcesGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsResourcesGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<ResourceGroups> result = apiInstance.umGroupsResourcesGetWithHttpInfo(groupId, pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsResourcesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
ResourceGroups result = apiInstance.umGroupsResourcesGet(groupId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsResourcesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsSharesDelete
umGroupsSharesDelete(groupId, resourceId, pretty, depth, xContractNumber)
Remove group shares
Remove the specified share from the group.
Parameters
groupId
String
The unique ID of the group.
resourceId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsSharesDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsSharesDelete instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
String resourceId = "resourceId_example"; // String | The unique ID of the resource.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
apiInstance.umGroupsSharesDeleteWithHttpInfo(groupId, resourceId, pretty, depth, xContractNumber);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
apiInstance.umGroupsSharesDelete(groupId, resourceId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsSharesFindByResourceId
GroupShare umGroupsSharesFindByResourceId(groupId, resourceId, pretty, depth, xContractNumber)
Retrieve group shares
Retrieve the properties of the specified group share.
Parameters
groupId
String
The unique ID of the group.
resourceId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsSharesFindByResourceIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsSharesFindByResourceId instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
String resourceId = "resourceId_example"; // String | The unique ID of the resource.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<GroupShare> result = apiInstance.umGroupsSharesFindByResourceIdWithHttpInfo(groupId, resourceId, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesFindByResourceId");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
GroupShare result = apiInstance.umGroupsSharesFindByResourceId(groupId, resourceId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesFindByResourceId");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsSharesGet
GroupShares umGroupsSharesGet(groupId, pretty, depth, xContractNumber)
List group shares
List all shares and share privileges for the specified group.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsSharesGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsSharesGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<GroupShares> result = apiInstance.umGroupsSharesGetWithHttpInfo(groupId, pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
GroupShares result = apiInstance.umGroupsSharesGet(groupId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsSharesPost
GroupShare umGroupsSharesPost(groupId, resourceId, resource, pretty, depth, xContractNumber)
Add group shares
Add the specified share to the group.
Parameters
groupId
String
The unique ID of the group.
resourceId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsSharesPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsSharesPost instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
String resourceId = "resourceId_example"; // String | The unique ID of the resource.
properties = new GroupShareProperties(); // GroupShareProperties |
resource = new GroupShare(GroupShareProperties); // GroupShare | The resource to add.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<GroupShare> result = apiInstance.umGroupsSharesPostWithHttpInfo(groupId, resourceId, resource, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
GroupShare result = apiInstance.umGroupsSharesPost(groupId, resourceId, resource)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsSharesPut
GroupShare umGroupsSharesPut(groupId, resourceId, resource, pretty, depth, xContractNumber)
Modify group share privileges
Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.
Parameters
groupId
String
The unique ID of the group.
resourceId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsSharesPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsSharesPut instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
String resourceId = "resourceId_example"; // String | The unique ID of the resource.
properties = new GroupShareProperties(); // GroupShareProperties |
resource = new GroupShare(GroupShareProperties); // GroupShare | The modified resource
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<GroupShare> result = apiInstance.umGroupsSharesPutWithHttpInfo(groupId, resourceId, resource, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
GroupShare result = apiInstance.umGroupsSharesPut(groupId, resourceId, resource)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsSharesPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsUsersDelete
umGroupsUsersDelete(groupId, userId, pretty, depth, xContractNumber)
Remove users from groups
Remove the specified user from the group.
Parameters
groupId
String
The unique ID of the group.
userId
String
The unique ID of the user.
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsUsersDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsUsersDelete instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
String userId = "userId_example"; // String | The unique ID of the user.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
apiInstance.umGroupsUsersDeleteWithHttpInfo(groupId, userId, pretty, depth, xContractNumber);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsUsersDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
apiInstance.umGroupsUsersDelete(groupId, userId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsUsersDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsUsersGet
GroupMembers umGroupsUsersGet(groupId, pretty, depth, xContractNumber)
List group members
List all members of the specified user group.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsUsersGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsUsersGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<GroupMembers> result = apiInstance.umGroupsUsersGetWithHttpInfo(groupId, pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsUsersGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
GroupMembers result = apiInstance.umGroupsUsersGet(groupId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsUsersGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umGroupsUsersPost
User umGroupsUsersPost(groupId, user, pretty, depth, xContractNumber)
Add a Group Member
Adds an existing user to the specified group.
Parameters
groupId
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the umGroupsUsersPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umGroupsUsersPost instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String groupId = "groupId_example"; // String | The unique ID of the group.
properties = new UserProperties(); // UserProperties |
user = new User(UserProperties); // User | The user to add.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<User> result = apiInstance.umGroupsUsersPostWithHttpInfo(groupId, user, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsUsersPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
User result = apiInstance.umGroupsUsersPost(groupId, user)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umGroupsUsersPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umResourcesFindByType
Resources umResourcesFindByType(resourceType, pretty, depth, xContractNumber)
List resources by type
List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
Parameters
resourceType
String
The resource type
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umResourcesFindByTypeWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umResourcesFindByType instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String resourceType = "resourceType_example"; // String | The resource type
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<Resources> result = apiInstance.umResourcesFindByTypeWithHttpInfo(resourceType, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umResourcesFindByType");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Resources result = apiInstance.umResourcesFindByType(resourceType)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umResourcesFindByType");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umResourcesFindByTypeAndId
Resource umResourcesFindByTypeAndId(resourceType, resourceId, pretty, depth, xContractNumber)
Retrieve resources by type
Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.
Parameters
resourceType
String
The resource type
resourceId
String
The resource ID
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umResourcesFindByTypeAndIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umResourcesFindByTypeAndId instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String resourceType = "resourceType_example"; // String | The resource type
String resourceId = "resourceId_example"; // String | The resource ID
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<Resource> result = apiInstance.umResourcesFindByTypeAndIdWithHttpInfo(resourceType, resourceId, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umResourcesFindByTypeAndId");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Resource result = apiInstance.umResourcesFindByTypeAndId(resourceType, resourceId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umResourcesFindByTypeAndId");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umResourcesGet
Resources umResourcesGet(pretty, depth, xContractNumber)
List all resources
List all the available resources.
Parameters
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umResourcesGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umResourcesGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<Resources> result = apiInstance.umResourcesGetWithHttpInfo(pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umResourcesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Resources result = apiInstance.umResourcesGet()
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umResourcesGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersDelete
umUsersDelete(userId, pretty, depth, xContractNumber)
Delete users
Delete the specified user.
Parameters
userId
String
The unique ID of the user.
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umUsersDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersDelete instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String userId = "userId_example"; // String | The unique ID of the user.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
apiInstance.umUsersDeleteWithHttpInfo(userId, pretty, depth, xContractNumber);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
apiInstance.umUsersDelete(userId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersDelete");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersFindById
User umUsersFindById(userId, pretty, depth, xContractNumber)
Retrieve users
Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
Parameters
userId
String
The unique ID of the user.
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umUsersFindByIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersFindById instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String userId = "userId_example"; // String | The unique ID of the user.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<User> result = apiInstance.umUsersFindByIdWithHttpInfo(userId, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersFindById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
User result = apiInstance.umUsersFindById(userId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersFindById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersGet
Users umUsersGet(pretty, depth, xContractNumber, offset, limit)
List all users
List all the users in your account.
Parameters
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
offset
Integer
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[optional] [default to 0]
limit
Integer
The maximum number of elements to return (use together with <code>offset</code> for pagination).
[optional] [default to 100]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umUsersGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Integer offset = 0; // Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
Integer limit = 100; // Integer | The maximum number of elements to return (use together with <code>offset</code> for pagination).
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<Users> result = apiInstance.umUsersGetWithHttpInfo(pretty, depth, xContractNumber, offset, limit, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Users result = apiInstance.umUsersGet()
.pretty(true)
.depth(0)
.offset(0)
.limit(100)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersGroupsGet
ResourceGroups umUsersGroupsGet(userId, pretty, depth, xContractNumber)
Retrieve group resources by user ID
Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
Parameters
userId
String
The unique ID of the user.
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umUsersGroupsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersGroupsGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String userId = "userId_example"; // String | The unique ID of the user.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<ResourceGroups> result = apiInstance.umUsersGroupsGetWithHttpInfo(userId, pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersGroupsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
ResourceGroups result = apiInstance.umUsersGroupsGet(userId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersGroupsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersOwnsGet
ResourcesUsers umUsersOwnsGet(userId, pretty, depth, xContractNumber)
Retrieve user resources by user ID
Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.
Parameters
userId
String
The unique ID of the user.
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the umUsersOwnsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersOwnsGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String userId = "userId_example"; // String | The unique ID of the user.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<ResourcesUsers> result = apiInstance.umUsersOwnsGetWithHttpInfo(userId, pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersOwnsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
ResourcesUsers result = apiInstance.umUsersOwnsGet(userId)
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersOwnsGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersPost
User umUsersPost(user, pretty, depth, xContractNumber)
Create users
Create a user.
Parameters
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the umUsersPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersPost instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
properties = new UserPropertiesPost(); // UserPropertiesPost |
user = new UserPost(UserPropertiesPost); // UserPost | The user to create.
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<User> result = apiInstance.umUsersPostWithHttpInfo(user, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
User result = apiInstance.umUsersPost(user)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersPost");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
umUsersPut
User umUsersPut(userId, user, pretty, depth, xContractNumber)
Modify users
Modify the properties of the specified user.
Parameters
userId
String
The unique ID of the user.
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]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the umUsersPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersPut instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: Basic Authentication
HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
basicAuthentication.setUsername("YOUR USERNAME");
basicAuthentication.setPassword("YOUR PASSWORD");
// Configure Api Key authorization: Token Authentication
defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");
UserManagementApi apiInstance = new UserManagementApi(defaultClient);
String userId = "userId_example"; // String | The unique ID of the user.
properties = new UserPropertiesPut(); // UserPropertiesPut |
user = new UserPut(UserPropertiesPut); // UserPut | The modified user
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // 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
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
try {
ApiResponse<User> result = apiInstance.umUsersPutWithHttpInfo(userId, user, pretty, depth, xContractNumber);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
User result = apiInstance.umUsersPut(userId, user)
.pretty(true)
.depth(0)
.xContractNumber(56)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling UserManagementApi#umUsersPut");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
Last updated