master
User Guides APIs, SDKs & Tools Support FAQ

UserS3KeysApi

UserS3KeysApi

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

MethodHTTP requestDescription

umUsersS3keysDelete

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

Delete S3 keys

umUsersS3keysFindByKeyId

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

Retrieve user S3 keys by key ID

umUsersS3keysGet

GET /um/users/{userId}/s3keys

List user S3 keys

umUsersS3keysPost

POST /um/users/{userId}/s3keys

Create user S3 keys

umUsersS3keysPut

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

Modify a S3 Key by Key ID

umUsersS3ssourlGet

GET /um/users/{userId}/s3ssourl

Retrieve S3 single sign-on URLs

umUsersS3keysDelete

umUsersS3keysDelete(userId, keyId, pretty, depth, xContractNumber)

Delete S3 keys

Delete the specified user S3 key.

Parameters

NameTypeDescriptionNotes

userId

String

The unique ID of the user.

keyId

String

The unique ID of the S3 key.

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 umUsersS3keysDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersS3keysDelete 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.UserS3KeysApi;

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");

    UserS3KeysApi apiInstance = new UserS3KeysApi(defaultClient);
    String userId = "userId_example"; // String | The unique ID of the user.
    String keyId = "keyId_example"; // String | The unique ID of the S3 key.
    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.umUsersS3keysDeleteWithHttpInfo(userId, keyId, pretty, depth, xContractNumber);
    } catch (ApiException e) {
      System.err.println("Exception when calling UserS3KeysApi#umUsersS3keysDelete");
      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.umUsersS3keysDelete(userId, keyId)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling UserS3KeysApi#umUsersS3keysDelete");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

umUsersS3keysFindByKeyId

S3Key umUsersS3keysFindByKeyId(userId, keyId, pretty, depth, xContractNumber)

Retrieve user S3 keys by key ID

Retrieve the specified user S3 key. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. The key ID is in the response body when the S3 key is created, and in the list of all user S3 keys, returned by GET.

Parameters

NameTypeDescriptionNotes

userId

String

The unique ID of the user.

keyId

String

The unique ID of the S3 key.

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

S3Key

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

⚠️ Note: the example bellow uses the umUsersS3keysFindByKeyIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersS3keysFindByKeyId 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.UserS3KeysApi;

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");

    UserS3KeysApi apiInstance = new UserS3KeysApi(defaultClient);
    String userId = "userId_example"; // String | The unique ID of the user.
    String keyId = "keyId_example"; // String | The unique ID of the S3 key.
    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<S3Key> result = apiInstance.umUsersS3keysFindByKeyIdWithHttpInfo(userId, keyId, 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 UserS3KeysApi#umUsersS3keysFindByKeyId");
      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 {
        S3Key result = apiInstance.umUsersS3keysFindByKeyId(userId, keyId)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling UserS3KeysApi#umUsersS3keysFindByKeyId");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

umUsersS3keysGet

S3Keys umUsersS3keysGet(userId, pretty, depth, xContractNumber)

List user S3 keys

List S3 keys 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

NameTypeDescriptionNotes

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

S3Keys

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

⚠️ Note: the example bellow uses the umUsersS3keysGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersS3keysGet 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.UserS3KeysApi;

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");

    UserS3KeysApi apiInstance = new UserS3KeysApi(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<S3Keys> result = apiInstance.umUsersS3keysGetWithHttpInfo(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 UserS3KeysApi#umUsersS3keysGet");
      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 {
        S3Keys result = apiInstance.umUsersS3keysGet(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 UserS3KeysApi#umUsersS3keysGet");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

umUsersS3keysPost

S3Key umUsersS3keysPost(userId, pretty, depth, xContractNumber)

Create user S3 keys

Create an S3 key for the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET. A maximum of five keys per user can be generated.

Parameters

NameTypeDescriptionNotes

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

S3Key

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

⚠️ Note: the example bellow uses the umUsersS3keysPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersS3keysPost 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.UserS3KeysApi;

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");

    UserS3KeysApi apiInstance = new UserS3KeysApi(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<S3Key> result = apiInstance.umUsersS3keysPostWithHttpInfo(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 UserS3KeysApi#umUsersS3keysPost");
      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 {
        S3Key result = apiInstance.umUsersS3keysPost(userId)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling UserS3KeysApi#umUsersS3keysPost");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

umUsersS3keysPut

S3Key umUsersS3keysPut(userId, keyId, s3Key, pretty, depth, xContractNumber)

Modify a S3 Key by Key ID

Enables or disables the specified user S3 key.

Parameters

NameTypeDescriptionNotes

userId

String

The unique ID of the user.

keyId

String

The unique ID of the S3 key.

s3Key

S3Key

The modified S3 key.

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

S3Key

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

⚠️ Note: the example bellow uses the umUsersS3keysPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersS3keysPut 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.UserS3KeysApi;

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");

    UserS3KeysApi apiInstance = new UserS3KeysApi(defaultClient);
    String userId = "userId_example"; // String | The unique ID of the user.
    String keyId = "keyId_example"; // String | The unique ID of the S3 key.
    properties = new S3KeyProperties(); // S3KeyProperties | 
    s3Key = new S3Key(S3KeyProperties); // S3Key | The modified S3 key.
    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<S3Key> result = apiInstance.umUsersS3keysPutWithHttpInfo(userId, keyId, s3Key, 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 UserS3KeysApi#umUsersS3keysPut");
      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 {
        S3Key result = apiInstance.umUsersS3keysPut(userId, keyId, s3Key)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling UserS3KeysApi#umUsersS3keysPut");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

umUsersS3ssourlGet

S3ObjectStorageSSO umUsersS3ssourlGet(userId, pretty, xContractNumber)

Retrieve S3 single sign-on URLs

Retrieve S3 Object Storage single sign-on URLs for the the specified user. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

Parameters

NameTypeDescriptionNotes

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]

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

S3ObjectStorageSSO

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

⚠️ Note: the example bellow uses the umUsersS3ssourlGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use umUsersS3ssourlGet 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.UserS3KeysApi;

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");

    UserS3KeysApi apiInstance = new UserS3KeysApi(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 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<S3ObjectStorageSSO> result = apiInstance.umUsersS3ssourlGetWithHttpInfo(userId, pretty, 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 UserS3KeysApi#umUsersS3ssourlGet");
      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 {
        S3ObjectStorageSSO result = apiInstance.umUsersS3ssourlGet(userId)
                .pretty(true)
                .xContractNumber(56)
                .orderBy("orderBy_example")
                .maxResults(5)
                .filters(filters)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling UserS3KeysApi#umUsersS3ssourlGet");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }
PreviousUserManagementApiNextVolumesApi

Last updated