UserS3KeysApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​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 S3 keys by key ID
​UmUsersS3ssourlGet​
Get /um/users/{userId}/s3ssourl
Retrieve S3 single sign-on URLs
UmUsersS3keysDelete
1
var result  = UmUsersS3keysDelete(ctx, userId, keyId)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
Delete S3 keys
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    userId := "userId_example" // string | The unique ID of the user.
12
    keyId := "keyId_example" // string | The unique ID of the S3 key.
13
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
14
    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)
15
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
16
​
17
    configuration := openapiclient.NewConfiguration()
18
    apiClient := openapiclient.NewAPIClient(configuration)
19
    resp, r, err := apiClient.UserS3KeysApi.UmUsersS3keysDelete(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
20
    if err != nil {
21
        fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysDelete``: %v\n", err)
22
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
23
    }
24
}
Copied!
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 S3 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
1
var result S3Key = UmUsersS3keysFindByKeyId(ctx, userId, keyId)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
Retrieve user S3 keys by key ID
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    userId := "userId_example" // string | The unique ID of the user.
12
    keyId := "keyId_example" // string | The unique ID of the S3 key.
13
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
14
    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)
15
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
16
​
17
    configuration := openapiclient.NewConfiguration()
18
    apiClient := openapiclient.NewAPIClient(configuration)
19
    resp, r, err := apiClient.UserS3KeysApi.UmUsersS3keysFindByKeyId(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
20
    if err != nil {
21
        fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysFindByKeyId``: %v\n", err)
22
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
23
    }
24
    // response from `UmUsersS3keysFindByKeyId`: S3Key
25
    fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysFindByKeyId`: %v\n", resp)
26
}
Copied!
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 S3 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​
HTTP request headers
Content-Type: Not defined
Accept: application/json
UmUsersS3keysGet
1
var result S3Keys = UmUsersS3keysGet(ctx, userId)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
List user S3 keys
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    userId := "userId_example" // string | The unique ID of the user.
12
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
13
    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)
14
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
15
​
16
    configuration := openapiclient.NewConfiguration()
17
    apiClient := openapiclient.NewAPIClient(configuration)
18
    resp, r, err := apiClient.UserS3KeysApi.UmUsersS3keysGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
    if err != nil {
20
        fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysGet``: %v\n", err)
21
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
    }
23
    // response from `UmUsersS3keysGet`: S3Keys
24
    fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysGet`: %v\n", resp)
25
}
Copied!
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​
HTTP request headers
Content-Type: Not defined
Accept: application/json
UmUsersS3keysPost
1
var result S3Key = UmUsersS3keysPost(ctx, userId)
2
                      .Pretty(pretty)
3
                      .Depth(depth)
4
                      .XContractNumber(xContractNumber)
5
                      .Execute()
Copied!
Create user S3 keys
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    userId := "userId_example" // string | The unique ID of the user.
12
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
13
    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)
14
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
15
​
16
    configuration := openapiclient.NewConfiguration()
17
    apiClient := openapiclient.NewAPIClient(configuration)
18
    resp, r, err := apiClient.UserS3KeysApi.UmUsersS3keysPost(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
    if err != nil {
20
        fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysPost``: %v\n", err)
21
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
    }
23
    // response from `UmUsersS3keysPost`: S3Key
24
    fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysPost`: %v\n", resp)
25
}
Copied!
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​
HTTP request headers
Content-Type: Not defined
Accept: application/json
UmUsersS3keysPut
1
var result S3Key = UmUsersS3keysPut(ctx, userId, keyId)
2
                      .S3Key(s3Key)
3
                      .Pretty(pretty)
4
                      .Depth(depth)
5
                      .XContractNumber(xContractNumber)
6
                      .Execute()
Copied!
Modify S3 keys by key ID
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    userId := "userId_example" // string | The unique ID of the user.
12
    keyId := "keyId_example" // string | The unique ID of the S3 key.
13
    s3Key := *openapiclient.NewS3Key(*openapiclient.NewS3KeyProperties()) // S3Key | The modified S3 key.
14
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
15
    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)
16
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
17
​
18
    configuration := openapiclient.NewConfiguration()
19
    apiClient := openapiclient.NewAPIClient(configuration)
20
    resp, r, err := apiClient.UserS3KeysApi.UmUsersS3keysPut(context.Background(), userId, keyId).S3Key(s3Key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
21
    if err != nil {
22
        fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3keysPut``: %v\n", err)
23
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
24
    }
25
    // response from `UmUsersS3keysPut`: S3Key
26
    fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3keysPut`: %v\n", resp)
27
}
Copied!
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 S3 key.
​
Other Parameters
Other parameters are passed through a pointer to a apiUmUsersS3keysPutRequest struct via the builder pattern
Name
Type
Description
Notes
s3Key
​S3Key​
The modified S3 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​
HTTP request headers
Content-Type: application/json
Accept: application/json
UmUsersS3ssourlGet
1
var result S3ObjectStorageSSO = UmUsersS3ssourlGet(ctx, userId)
2
                      .Pretty(pretty)
3
                      .XContractNumber(xContractNumber)
4
                      .Execute()
Copied!
Retrieve S3 single sign-on URLs
Example
1
package main
2
​
3
import (
4
    "context"
5
    "fmt"
6
    "os"
7
    openapiclient "./openapi"
8
)
9
​
10
func main() {
11
    userId := "userId_example" // string | The unique ID of the user.
12
    pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true)
13
    xContractNumber := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional)
14
​
15
    configuration := openapiclient.NewConfiguration()
16
    apiClient := openapiclient.NewAPIClient(configuration)
17
    resp, r, err := apiClient.UserS3KeysApi.UmUsersS3ssourlGet(context.Background(), userId).Pretty(pretty).XContractNumber(xContractNumber).Execute()
18
    if err != nil {
19
        fmt.Fprintf(os.Stderr, "Error when calling `UserS3KeysApi.UmUsersS3ssourlGet``: %v\n", err)
20
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
21
    }
22
    // response from `UmUsersS3ssourlGet`: S3ObjectStorageSSO
23
    fmt.Fprintf(os.Stdout, "Response from `UserS3KeysApi.UmUsersS3ssourlGet`: %v\n", resp)
24
}
Copied!
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​
HTTP request headers
Content-Type: Not defined
Accept: application/json

API - Previous

UserManagementApi

Next - API

VolumesApi

Last modified 3mo ago