UserManagementApi

UserManagementApi
All URIs are relative to https://api.ionos.com/cloudapi/v5​
Method
HTTP request
Description
​umGroupsDelete​
DELETE /um/groups/{groupId}
Delete a Group
​umGroupsFindById​
GET /um/groups/{groupId}
Retrieve a Group
​umGroupsGet​
GET /um/groups
List All Groups.
​umGroupsPost​
POST /um/groups
Create a Group
​umGroupsPut​
PUT /um/groups/{groupId}
Modify a group
​umGroupsResourcesGet​
GET /um/groups/{groupId}/resources
Retrieve resources assigned to a group
​umGroupsSharesDelete​
DELETE /um/groups/{groupId}/shares/{resourceId}
Remove a resource from a group
​umGroupsSharesFindByResourceId​
GET /um/groups/{groupId}/shares/{resourceId}
Retrieve a group share
​umGroupsSharesGet​
GET /um/groups/{groupId}/shares
List Group Shares
​umGroupsSharesPost​
POST /um/groups/{groupId}/shares/{resourceId}
Add a resource to a group
​umGroupsSharesPut​
PUT /um/groups/{groupId}/shares/{resourceId}
Modify resource permissions of a group
​umGroupsUsersDelete​
DELETE /um/groups/{groupId}/users/{userId}
Remove a user from a group
​umGroupsUsersGet​
GET /um/groups/{groupId}/users
List Group Members
​umGroupsUsersPost​
POST /um/groups/{groupId}/users
Add a user to a group
​umResourcesFindByType​
GET /um/resources/{resourceType}
Retrieve a list of Resources by type.
​umResourcesFindByTypeAndId​
GET /um/resources/{resourceType}/{resourceId}
Retrieve a Resource by type.
​umResourcesGet​
GET /um/resources
List All Resources.
​umUsersDelete​
DELETE /um/users/{userId}
Delete a User
​umUsersFindById​
GET /um/users/{userId}
Retrieve a User
​umUsersGet​
GET /um/users
List all Users
​umUsersGroupsGet​
GET /um/users/{userId}/groups
Retrieve a User's group resources
​umUsersOwnsGet​
GET /um/users/{userId}/owns
Retrieve a User's own resources
​umUsersPost​
POST /um/users
Create a user
​umUsersPut​
PUT /um/users/{userId}
Modify a user
​umUsersS3keysDelete​
DELETE /um/users/{userId}/s3keys/{keyId}
Delete a S3 key
​umUsersS3keysFindByKeyId​
GET /um/users/{userId}/s3keys/{keyId}
Retrieve given S3 key belonging to the given User
​umUsersS3keysGet​
GET /um/users/{userId}/s3keys
Retrieve a User's S3 keys
​umUsersS3keysPost​
POST /um/users/{userId}/s3keys
Create a S3 key for the given user
​umUsersS3keysPut​
PUT /um/users/{userId}/s3keys/{keyId}
Modify a S3 key having the given key id
​umUsersS3ssourlGet​
GET /um/users/{userId}/s3ssourl
Retrieve S3 object storage single signon URL for the given user
umGroupsDelete
Object umGroupsDelete(groupId, pretty, depth, xContractNumber)
Delete a Group
Delete a group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | The unique ID of the group
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Object result = apiInstance.umGroupsDelete(groupId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
The unique ID of the group
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
Object
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsFindById
Group umGroupsFindById(groupId, pretty, depth, xContractNumber)
Retrieve a Group
You can retrieve a group by using the group ID. This value can be found in the response body when a group is created or when you GET a list of groups.
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | The unique ID of the group
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Group result = apiInstance.umGroupsFindById(groupId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
The unique ID of the group
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​Group​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsGet
Groups umGroupsGet(pretty, depth, xContractNumber)
List All Groups.
You can retrieve a complete list of all groups that you have access to
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Groups result = apiInstance.umGroupsGet(pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​Groups​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsPost
Group umGroupsPost(group, pretty, depth, xContractNumber)
Create a Group
You can use this POST method to create a group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    Group group = new Group(); // Group | Group to be created
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Group result = apiInstance.umGroupsPost(group, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
group
​Group​
Group to be created
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​Group​
HTTP request headers
Content-Type: application/json
Accept: application/json
umGroupsPut
Group umGroupsPut(groupId, group, pretty, depth, xContractNumber)
Modify a group
You can use this method to update properties of the group.
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | The unique ID of the group
    Group group = new Group(); // Group | Modified properties of the Group
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Group result = apiInstance.umGroupsPut(groupId, group, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
The unique ID of the group
​
group
​Group​
Modified properties of the Group
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​Group​
HTTP request headers
Content-Type: application/json
Accept: application/json
umGroupsResourcesGet
ResourceGroups umGroupsResourcesGet(groupId, pretty, depth, xContractNumber)
Retrieve resources assigned to a group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | The unique ID of the group
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      ResourceGroups result = apiInstance.umGroupsResourcesGet(groupId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
The unique ID of the group
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​ResourceGroups​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsSharesDelete
Object umGroupsSharesDelete(groupId, resourceId, pretty, depth, xContractNumber)
Remove a resource from a group
This will remove a resource from a group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    String resourceId = "resourceId_example"; // String | 
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Object result = apiInstance.umGroupsSharesDelete(groupId, resourceId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
resourceId
String
​
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
Object
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsSharesFindByResourceId
GroupShare umGroupsSharesFindByResourceId(groupId, resourceId, pretty, depth, xContractNumber)
Retrieve a group share
This will retrieve the properties of a group share.
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    String resourceId = "resourceId_example"; // String | 
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      GroupShare result = apiInstance.umGroupsSharesFindByResourceId(groupId, resourceId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
resourceId
String
​
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​GroupShare​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsSharesGet
GroupShares umGroupsSharesGet(groupId, pretty, depth, xContractNumber)
List Group Shares
You can retrieve a list of all resources along with their permissions of the group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      GroupShares result = apiInstance.umGroupsSharesGet(groupId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​GroupShares​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsSharesPost
GroupShare umGroupsSharesPost(groupId, resourceId, resource, pretty, depth, xContractNumber)
Add a resource to a group
This will add a resource to the group.
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    String resourceId = "resourceId_example"; // String | 
    GroupShare resource = new GroupShare(); // GroupShare | Resource to be added
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      GroupShare result = apiInstance.umGroupsSharesPost(groupId, resourceId, resource, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
resourceId
String
​
​
resource
​GroupShare​
Resource to be added
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​GroupShare​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsSharesPut
GroupShare umGroupsSharesPut(groupId, resourceId, resource, pretty, depth, xContractNumber)
Modify resource permissions of a group
You can use update resource permissions of a group. If empty body will be provided, no updates will happen, instead you will be returned the current permissions of resource in a group. In this case response code will be 200
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    String resourceId = "resourceId_example"; // String | 
    GroupShare resource = new GroupShare(); // GroupShare | Modified Resource
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      GroupShare result = apiInstance.umGroupsSharesPut(groupId, resourceId, resource, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
resourceId
String
​
​
resource
​GroupShare​
Modified Resource
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​GroupShare​
HTTP request headers
Content-Type: application/json
Accept: application/json
umGroupsUsersDelete
Object umGroupsUsersDelete(groupId, userId, pretty, depth, xContractNumber)
Remove a user from a group
This will remove a user from a group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    String userId = "userId_example"; // String | 
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      Object result = apiInstance.umGroupsUsersDelete(groupId, userId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
userId
String
​
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
Object
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsUsersGet
GroupMembers umGroupsUsersGet(groupId, pretty, depth, xContractNumber)
List Group Members
You can retrieve a list of users who are members of the group
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      GroupMembers result = apiInstance.umGroupsUsersGet(groupId, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​GroupMembers​
HTTP request headers
Content-Type: Not defined
Accept: application/json
umGroupsUsersPost
User umGroupsUsersPost(groupId, user, pretty, depth, xContractNumber)
Add a user to a group
This will attach a pre-existing user to a group.
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
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");
​
​
    UserManagementApi apiInstance = new UserManagementApi(defaultClient);
    String groupId = "groupId_example"; // String | 
    User user = new User(); // User | User to be added
    Boolean pretty = true; // Boolean | Controls whether response is pretty-printed (with indentation and new lines)
    Integer depth = 0; // Integer | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
    Integer xContractNumber = 56; // Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
    try {
      User result = apiInstance.umGroupsUsersPost(groupId, user, pretty, depth, xContractNumber);
      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();
    }
  }
}
Parameters
Name
Type
Description
Notes
groupId
String
​
​
user
​User​
User to be added
​
pretty
Boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to true]
depth
Integer
Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​User​
HTTP request headers
Content-Type: application/json
Accept: application/json
umResourcesFindByType
Resources umResourcesFindByType(resourceType, pretty, depth, xContractNumber)
Retrieve a list of Resources by type.
You can retrieve a list of resources by using the type. Allowed values are { datacenter, snapshot, image, ipblock, pcc, backupunit, k8s }. This value of resource type also be found in the response body when you GET a list of all resources.
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.UserManagementApi;
​
public class Example {
Method	HTTP request	Description
umGroupsDelete	DELETE /um/groups/{groupId}	Delete a Group
umGroupsFindById	GET /um/groups/{groupId}	Retrieve a Group
umGroupsGet	GET /um/groups	List All Groups.
umGroupsPost	POST /um/groups	Create a Group
umGroupsPut	PUT /um/groups/{groupId}	Modify a group
umGroupsResourcesGet	GET /um/groups/{groupId}/resources	Retrieve resources assigned to a group
umGroupsSharesDelete	DELETE /um/groups/{groupId}/shares/{resourceId}	Remove a resource from a group
umGroupsSharesFindByResourceId	GET /um/groups/{groupId}/shares/{resourceId}	Retrieve a group share
umGroupsSharesGet	GET /um/groups/{groupId}/shares	List Group Shares
umGroupsSharesPost	POST /um/groups/{groupId}/shares/{resourceId}	Add a resource to a group
umGroupsSharesPut	PUT /um/groups/{groupId}/shares/{resourceId}	Modify resource permissions of a group
umGroupsUsersDelete	DELETE /um/groups/{groupId}/users/{userId}	Remove a user from a group
umGroupsUsersGet	GET /um/groups/{groupId}/users	List Group Members
umGroupsUsersPost	POST /um/groups/{groupId}/users	Add a user to a group
umResourcesFindByType	GET /um/resources/{resourceType}	Retrieve a list of Resources by type.
umResourcesFindByTypeAndId	GET /um/resources/{resourceType}/{resourceId}	Retrieve a Resource by type.
umResourcesGet	GET /um/resources	List All Resources.
umUsersDelete	DELETE /um/users/{userId}	Delete a User
umUsersFindById	GET /um/users/{userId}	Retrieve a User
umUsersGet	GET /um/users	List all Users
umUsersGroupsGet	GET /um/users/{userId}/groups	Retrieve a User's group resources
umUsersOwnsGet	GET /um/users/{userId}/owns	Retrieve a User's own resources
umUsersPost	POST /um/users	Create a user
umUsersPut	PUT /um/users/{userId}	Modify a user
umUsersS3keysDelete	DELETE /um/users/{userId}/s3keys/{keyId}	Delete a S3 key
umUsersS3keysFindByKeyId	GET /um/users/{userId}/s3keys/{keyId}	Retrieve given S3 key belonging to the given User
umUsersS3keysGet	GET /um/users/{userId}/s3keys	Retrieve a User's S3 keys
umUsersS3keysPost	POST /um/users/{userId}/s3keys	Create a S3 key for the given user
umUsersS3keysPut	PUT /um/users/{userId}/s3keys/{keyId}	Modify a S3 key having the given key id
umUsersS3ssourlGet	GET /um/users/{userId}/s3ssourl	Retrieve S3 object storage single signon URL for the given user
Name	Type	Description	Notes
groupId	String
resourceId	String
resource	GroupShare	Resource to be added
pretty	Boolean	Controls whether response is pretty-printed (with indentation and new lines)	[optional] [default to true]
depth	Integer	Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on	[optional] [default to 0]
xContractNumber	Integer	Users having more than 1 contract need to provide contract number, against which all API requests should be executed	[optional]
Name	Type	Description	Notes
groupId	String
resourceId	String
resource	GroupShare	Modified Resource
pretty	Boolean	Controls whether response is pretty-printed (with indentation and new lines)	[optional] [default to true]
depth	Integer	Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on	[optional] [default to 0]
xContractNumber	Integer	Users having more than 1 contract need to provide contract number, against which all API requests should be executed	[optional]