# UserS3KeysApi All URIs are relative to ** | Method | HTTP request | Description | | --------------------------------------------------------- | -------------------------------------------- | ------------------------------------------- | | [**UmUsersS3keysDelete**](#UmUsersS3keysDelete) | **Delete** /um/users/{userId}/s3keys/{keyId} | Delete Object storage keys | | [**UmUsersS3keysFindByKeyId**](#UmUsersS3keysFindByKeyId) | **Get** /um/users/{userId}/s3keys/{keyId} | Retrieve user Object storage keys by key ID | | [**UmUsersS3keysGet**](#UmUsersS3keysGet) | **Get** /um/users/{userId}/s3keys | List user Object storage keys | | [**UmUsersS3keysPost**](#UmUsersS3keysPost) | **Post** /um/users/{userId}/s3keys | Create user Object storage keys | | [**UmUsersS3keysPut**](#UmUsersS3keysPut) | **Put** /um/users/{userId}/s3keys/{keyId} | Modify a Object storage Key by Key ID | | [**UmUsersS3ssourlGet**](#UmUsersS3ssourlGet) | **Get** /um/users/{userId}/s3ssourl | Retrieve Object storage single sign-on URLs | ## UmUsersS3keysDelete ```go var result = UmUsersS3keysDelete(ctx, userId, keyId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Delete Object storage keys ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { userId := "userId_example" // string | The unique ID of the user. keyId := "keyId_example" // string | The unique ID of the Object storage key. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resp, err := apiClient.UserS3KeysApi.UmUsersS3keysDelete(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` ### Path Parameters | Name | Type | Description | Notes | | ---------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **userId** | **string** | The unique ID of the user. | | | **keyId** | **string** | The unique ID of the Object storage key. | | ### Other Parameters Other parameters are passed through a pointer to a apiUmUsersS3keysDeleteRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type (empty response body) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## UmUsersS3keysFindByKeyId ```go var result S3Key = UmUsersS3keysFindByKeyId(ctx, userId, keyId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Retrieve user Object storage keys by key ID ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { userId := "userId_example" // string | The unique ID of the user. keyId := "keyId_example" // string | The unique ID of the Object storage key. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.UserS3KeysApi.UmUsersS3keysFindByKeyId(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysFindByKeyId``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `UmUsersS3keysFindByKeyId`: S3Key fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysFindByKeyId`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | ---------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **userId** | **string** | The unique ID of the user. | | | **keyId** | **string** | The unique ID of the Object storage key. | | ### Other Parameters Other parameters are passed through a pointer to a apiUmUsersS3keysFindByKeyIdRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**S3Key**](https://docs.ionos.com/sections-test/go-sdk/cloud-api-go-sdk/models/s3key) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## UmUsersS3keysGet ```go var result S3Keys = UmUsersS3keysGet(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` List user Object storage keys ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { userId := "userId_example" // string | The unique ID of the user. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.UserS3KeysApi.UmUsersS3keysGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `UmUsersS3keysGet`: S3Keys fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysGet`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | ---------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **userId** | **string** | The unique ID of the user. | | ### Other Parameters Other parameters are passed through a pointer to a apiUmUsersS3keysGetRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**S3Keys**](https://docs.ionos.com/sections-test/go-sdk/cloud-api-go-sdk/models/s3keys) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## UmUsersS3keysPost ```go var result S3Key = UmUsersS3keysPost(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Create user Object storage keys ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { userId := "userId_example" // string | The unique ID of the user. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.UserS3KeysApi.UmUsersS3keysPost(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `UmUsersS3keysPost`: S3Key fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysPost`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | ---------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **userId** | **string** | The unique ID of the user. | | ### Other Parameters Other parameters are passed through a pointer to a apiUmUsersS3keysPostRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**S3Key**](https://docs.ionos.com/sections-test/go-sdk/cloud-api-go-sdk/models/s3key) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## UmUsersS3keysPut ```go var result S3Key = UmUsersS3keysPut(ctx, userId, keyId) .S3Key(s3Key) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Modify a Object storage Key by Key ID ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { userId := "userId_example" // string | The unique ID of the user. keyId := "keyId_example" // string | The unique ID of the Object storage key. s3Key := *openapiclient.NewS3Key(*openapiclient.NewS3KeyProperties()) // S3Key | The modified Object storage key. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.UserS3KeysApi.UmUsersS3keysPut(context.Background(), userId, keyId).S3Key(s3Key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysPut``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `UmUsersS3keysPut`: S3Key fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysPut`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | ---------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **userId** | **string** | The unique ID of the user. | | | **keyId** | **string** | The unique ID of the Object storage key. | | ### Other Parameters Other parameters are passed through a pointer to a apiUmUsersS3keysPutRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **s3Key** | [**S3Key**](https://docs.ionos.com/sections-test/go-sdk/cloud-api-go-sdk/models/s3key) | The modified Object storage key. | | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**S3Key**](https://docs.ionos.com/sections-test/go-sdk/cloud-api-go-sdk/models/s3key) ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## UmUsersS3ssourlGet ```go var result S3ObjectStorageSSO = UmUsersS3ssourlGet(ctx, userId) .Pretty(pretty) .XContractNumber(xContractNumber) .Execute() ``` Retrieve Object storage single sign-on URLs ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { userId := "userId_example" // string | The unique ID of the user. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.UserS3KeysApi.UmUsersS3ssourlGet(context.Background(), userId).Pretty(pretty).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3ssourlGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `UmUsersS3ssourlGet`: S3ObjectStorageSSO fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3ssourlGet`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | ---------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **userId** | **string** | The unique ID of the user. | | ### Other Parameters Other parameters are passed through a pointer to a apiUmUsersS3ssourlGetRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | -------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**S3ObjectStorageSSO**](https://docs.ionos.com/sections-test/go-sdk/cloud-api-go-sdk/models/s3objectstoragesso) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json