latest
Models
Powered By GitBook
UserManagementApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method
HTTP request
Description
Delete /um/groups/{groupId}
Delete a Group
Get /um/groups/{groupId}
Retrieve a Group
Get /um/groups
List All Groups.
Post /um/groups
Create a Group
Put /um/groups/{groupId}
Modify a group
Get /um/groups/{groupId}/resources
Retrieve resources assigned to a group
Delete /um/groups/{groupId}/shares/{resourceId}
Remove a resource from a group
Get /um/groups/{groupId}/shares/{resourceId}
Retrieve a group share
Get /um/groups/{groupId}/shares
List Group Shares
Post /um/groups/{groupId}/shares/{resourceId}
Add a resource to a group
Put /um/groups/{groupId}/shares/{resourceId}
Modify resource permissions of a group
Delete /um/groups/{groupId}/users/{userId}
Remove a user from a group
Get /um/groups/{groupId}/users
List Group Members
Post /um/groups/{groupId}/users
Add a user to a group
Get /um/resources/{resourceType}
Retrieve a list of Resources by type.
Get /um/resources/{resourceType}/{resourceId}
Retrieve a Resource by type.
Get /um/resources
List All Resources.
Delete /um/users/{userId}
Delete a User
Get /um/users/{userId}
Retrieve a User
Get /um/users
List all Users
Get /um/users/{userId}/groups
Retrieve a User's group resources
Get /um/users/{userId}/owns
Retrieve a User's own resources
Post /um/users
Create a user
Put /um/users/{userId}
Modify a user
Delete /um/users/{userId}/s3keys/{keyId}
Delete a S3 key
Get /um/users/{userId}/s3keys/{keyId}
Retrieve given S3 key belonging to the given User
Get /um/users/{userId}/s3keys
Retrieve a User's S3 keys
Post /um/users/{userId}/s3keys
Create a S3 key for the given user
Put /um/users/{userId}/s3keys/{keyId}
Modify a S3 key having the given key id
Get /um/users/{userId}/s3ssourl
Retrieve S3 object storage single signon URL for the given user

UmGroupsDelete

1
var result map[string]interface{} = UmGroupsDelete(ctx, groupId)
2
.Pretty(pretty)
3
.Depth(depth)
4
.XContractNumber(xContractNumber)
5
.Execute()
Copied!
Delete a Group

Example

1
package main
2
3
import (
4
"context"
5
"fmt"
6
"os"
7
openapiclient "./openapi"
8
)
9
10
func main() {
11
groupId := "groupId_example" // string | The unique ID of the group
12
pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
13
depth := int32(56) // int32 | 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)
14
xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
15
16
configuration := openapiclient.NewConfiguration()
17
api_client := openapiclient.NewAPIClient(configuration)
18
resp, r, err := api_client.UserManagementApi.UmGroupsDelete(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
if err != nil {
20
fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsDelete``: %v\n", err)
21
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
}
23
// response from `UmGroupsDelete`: map[string]interface{}
24
fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsDelete`: %v\n", resp)
25
}
Copied!

Path Parameters

Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsDeleteRequest struct via the builder pattern
Name
Type
Description
Notes
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

    Content-Type: Not defined
    Accept: application/json

UmGroupsFindById

1
var result Group = UmGroupsFindById(ctx, groupId)
2
.Pretty(pretty)
3
.Depth(depth)
4
.XContractNumber(xContractNumber)
5
.Execute()
Copied!
Retrieve a Group

Example

1
package main
2
3
import (
4
"context"
5
"fmt"
6
"os"
7
openapiclient "./openapi"
8
)
9
10
func main() {
11
groupId := "groupId_example" // string | The unique ID of the group
12
pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
13
depth := int32(56) // int32 | 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)
14
xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
15
16
configuration := openapiclient.NewConfiguration()
17
api_client := openapiclient.NewAPIClient(configuration)
18
resp, r, err := api_client.UserManagementApi.UmGroupsFindById(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
if err != nil {
20
fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsFindById``: %v\n", err)
21
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
}
23
// response from `UmGroupsFindById`: Group
24
fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsFindById`: %v\n", resp)
25
}
Copied!

Path Parameters

Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsFindByIdRequest struct via the builder pattern
Name
Type
Description
Notes
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Group

HTTP request headers

    Content-Type: Not defined
    Accept: application/json

UmGroupsGet

1
var result Groups = UmGroupsGet(ctx)
2
.Pretty(pretty)
3
.Depth(depth)
4
.XContractNumber(xContractNumber)
5
.Execute()
Copied!
List All Groups.

Example

1
package main
2
3
import (
4
"context"
5
"fmt"
6
"os"
7
openapiclient "./openapi"
8
)
9
10
func main() {
11
pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
12
depth := int32(56) // int32 | 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)
13
xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
14
15
configuration := openapiclient.NewConfiguration()
16
api_client := openapiclient.NewAPIClient(configuration)
17
resp, r, err := api_client.UserManagementApi.UmGroupsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
18
if err != nil {
19
fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsGet``: %v\n", err)
20
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
21
}
22
// response from `UmGroupsGet`: Groups
23
fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsGet`: %v\n", resp)
24
}
Copied!

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsGetRequest struct via the builder pattern
Name
Type
Description
Notes
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Groups

HTTP request headers

    Content-Type: Not defined
    Accept: application/json

UmGroupsPost

1
var result Group = UmGroupsPost(ctx)
2
.Group(group)
3
.Pretty(pretty)
4
.Depth(depth)
5
.XContractNumber(xContractNumber)
6
.Execute()
Copied!
Create a Group

Example

1
package main
2
3
import (
4
"context"
5
"fmt"
6
"os"
7
openapiclient "./openapi"
8
)
9
10
func main() {
11
group := *openapiclient.NewGroup(*openapiclient.NewGroupProperties()) // Group | Group to be created
12
pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
13
depth := int32(56) // int32 | 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)
14
xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
15
16
configuration := openapiclient.NewConfiguration()
17
api_client := openapiclient.NewAPIClient(configuration)
18
resp, r, err := api_client.UserManagementApi.UmGroupsPost(context.Background()).Group(group).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
if err != nil {
20
fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsPost``: %v\n", err)
21
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
}
23
// response from `UmGroupsPost`: Group
24
fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsPost`: %v\n", resp)
25
}
Copied!

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsPostRequest struct via the builder pattern
Name
Type
Description
Notes
group
Group
Group to be created
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Group

HTTP request headers

    Content-Type: application/json
    Accept: application/json

UmGroupsPut

1
var result Group = UmGroupsPut(ctx, groupId)
2
.Group(group)
3
.Pretty(pretty)
4
.Depth(depth)
5
.XContractNumber(xContractNumber)
6
.Execute()
Copied!
Modify a group

Example

1
package main
2
3
import (
4
"context"
5
"fmt"
6
"os"
7
openapiclient "./openapi"
8
)
9
10
func main() {
11
groupId := "groupId_example" // string | The unique ID of the group
12
group := *openapiclient.NewGroup(*openapiclient.NewGroupProperties()) // Group | Modified properties of the Group
13
pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
14
depth := int32(56) // int32 | 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)
15
xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
16
17
configuration := openapiclient.NewConfiguration()
18
api_client := openapiclient.NewAPIClient(configuration)
19
resp, r, err := api_client.UserManagementApi.UmGroupsPut(context.Background(), groupId).Group(group).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
20
if err != nil {
21
fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsPut``: %v\n", err)
22
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
23
}
24
// response from `UmGroupsPut`: Group
25
fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsPut`: %v\n", resp)
26
}
Copied!

Path Parameters

Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsPutRequest struct via the builder pattern
Name
Type
Description
Notes
group
Group
Modified properties of the Group
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Group

HTTP request headers

    Content-Type: application/json
    Accept: application/json

UmGroupsResourcesGet

1
var result ResourceGroups = UmGroupsResourcesGet(ctx, groupId)
2
.Pretty(pretty)
3
.Depth(depth)
4
.XContractNumber(xContractNumber)
5
.Execute()
Copied!
Retrieve resources assigned to a group

Example

1
package main
2
3
import (
4
"context"
5
"fmt"
6
"os"
7
openapiclient "./openapi"
8
)
9
10
func main() {
11
groupId := "groupId_example" // string | The unique ID of the group
12
pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
13
depth := int32(56) // int32 | 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)
14
xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
15
16
configuration := openapiclient.NewConfiguration()
17
api_client := openapiclient.NewAPIClient(configuration)
18
resp, r, err := api_client.UserManagementApi.UmGroupsResourcesGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
19
if err != nil {
20
fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsResourcesGet``: %v\n", err)
21
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
22
}
23
// response from `UmGroupsResourcesGet`: ResourceGroups
24
fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsResourcesGet`: %v\n", resp)
25
}
Copied!

Path Parameters

Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsResourcesGetRequest struct via the builder pattern
Name
Type
Description
Notes
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

HTTP request headers

    Content-Type: Not defined
    Accept: application/json

UmGroupsSharesDelete

1
var result map[string]interface{} = UmGroupsSharesDelete(ctx, groupId, resourceId)
2
.Pretty(pretty)
3
.Depth(depth)
4
.XContractNumber(xContractNumber)
5
.Execute()
Copied!
Remove a resource from a group