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
var result map[string]interface{} =UmGroupsDelete(ctx, groupId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Delete a Group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | The unique ID of the group pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsDelete(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsDelete`: map[string]interface{} fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsDelete`: %v\n", resp)}
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
var result Group=UmGroupsFindById(ctx, groupId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a Group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | The unique ID of the group pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsFindById(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsFindById``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsFindById`: Group fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsFindById`: %v\n", resp)}
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
var result Groups=UmGroupsGet(ctx) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
List All Groups.
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsGet`: Groups fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsGet`: %v\n", resp)}
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
var result Group=UmGroupsPost(ctx) .Group(group) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Create a Group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { group :=*openapiclient.NewGroup(*openapiclient.NewGroupProperties()) // Group | Group to be created pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsPost(context.Background()).Group(group).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsPost`: Group fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsPost`: %v\n", resp)}
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 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
var result Group=UmGroupsPut(ctx, groupId) .Group(group) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Modify a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | The unique ID of the group group :=*openapiclient.NewGroup(*openapiclient.NewGroupProperties()) // Group | Modified properties of the Group pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsPut(context.Background(), groupId).Group(group).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsPut``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsPut`: Group fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsPut`: %v\n", resp)}
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
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
var result ResourceGroups=UmGroupsResourcesGet(ctx, groupId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve resources assigned to a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | The unique ID of the group pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsResourcesGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsResourcesGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsResourcesGet`: ResourceGroups fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsResourcesGet`: %v\n", resp)}
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
var result map[string]interface{} =UmGroupsSharesDelete(ctx, groupId, resourceId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Remove a resource from a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | resourceId :="resourceId_example"// string | pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsSharesDelete(context.Background(), groupId, resourceId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsSharesDelete`: map[string]interface{} fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesDelete`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
resourceId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsSharesDeleteRequest 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
UmGroupsSharesFindByResourceId
var result GroupShare=UmGroupsSharesFindByResourceId(ctx, groupId, resourceId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a group share
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | resourceId :="resourceId_example"// string | pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsSharesFindByResourceId(context.Background(), groupId, resourceId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesFindByResourceId``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsSharesFindByResourceId`: GroupShare fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesFindByResourceId`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
resourceId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsSharesFindByResourceIdRequest 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
var result GroupShares=UmGroupsSharesGet(ctx, groupId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
List Group Shares
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsSharesGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsSharesGet`: GroupShares fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesGet`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsSharesGetRequest 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
var result GroupShare=UmGroupsSharesPost(ctx, groupId, resourceId) .Resource(resource) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Add a resource to a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | resourceId :="resourceId_example"// string | resource :=*openapiclient.NewGroupShare(*openapiclient.NewGroupShareProperties()) // GroupShare | Resource to be added pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsSharesPost(context.Background(), groupId, resourceId).Resource(resource).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsSharesPost`: GroupShare fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesPost`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
resourceId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsSharesPostRequest struct via the builder pattern
Name
Type
Description
Notes
resource
Resource to be added
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
var result GroupShare=UmGroupsSharesPut(ctx, groupId, resourceId) .Resource(resource) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Modify resource permissions of a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | resourceId :="resourceId_example"// string | resource :=*openapiclient.NewGroupShare(*openapiclient.NewGroupShareProperties()) // GroupShare | Modified Resource pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsSharesPut(context.Background(), groupId, resourceId).Resource(resource).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesPut``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsSharesPut`: GroupShare fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesPut`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
resourceId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsSharesPutRequest struct via the builder pattern
Name
Type
Description
Notes
resource
Modified Resource
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
var result map[string]interface{} =UmGroupsUsersDelete(ctx, groupId, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Remove a user from a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | userId :="userId_example"// string | pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsUsersDelete(context.Background(), groupId, userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsUsersDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsUsersDelete`: map[string]interface{} fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsUsersDelete`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
userId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsUsersDeleteRequest 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
UmGroupsUsersGet
var result GroupMembers=UmGroupsUsersGet(ctx, groupId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
List Group Members
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsUsersGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsUsersGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsUsersGet`: GroupMembers fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsUsersGet`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsUsersGetRequest 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
var result User=UmGroupsUsersPost(ctx, groupId) .User(user) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Add a user to a group
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { groupId :="groupId_example"// string | user :=*openapiclient.NewUser(*openapiclient.NewUserProperties()) // User | User to be added pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmGroupsUsersPost(context.Background(), groupId).User(user).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsUsersPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmGroupsUsersPost`: User fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsUsersPost`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmGroupsUsersPostRequest struct via the builder pattern
Name
Type
Description
Notes
user
User to be added
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
var result Resources=UmResourcesFindByType(ctx, resourceType) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a list of Resources by type.
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { resourceType :="resourceType_example"// string | The resource Type pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmResourcesFindByType(context.Background(), resourceType).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmResourcesFindByType``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmResourcesFindByType`: Resources fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmResourcesFindByType`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
resourceType
string
The resource Type
Other Parameters
Other parameters are passed through a pointer to a apiUmResourcesFindByTypeRequest 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
var result Resource=UmResourcesFindByTypeAndId(ctx, resourceType, resourceId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a Resource by type.
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { resourceType :="resourceType_example"// string | The resource Type resourceId :="resourceId_example"// string | The resource Uuid pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmResourcesFindByTypeAndId(context.Background(), resourceType, resourceId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmResourcesFindByTypeAndId``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmResourcesFindByTypeAndId`: Resource fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmResourcesFindByTypeAndId`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
resourceType
string
The resource Type
resourceId
string
The resource Uuid
Other Parameters
Other parameters are passed through a pointer to a apiUmResourcesFindByTypeAndIdRequest 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
var result Resources=UmResourcesGet(ctx) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
List All Resources.
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmResourcesGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmResourcesGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmResourcesGet`: Resources fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmResourcesGet`: %v\n", resp)}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiUmResourcesGetRequest 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
var result map[string]interface{} =UmUsersDelete(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Delete a User
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersDelete(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersDelete`: map[string]interface{} fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersDelete`: %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 apiUmUsersDeleteRequest 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
UmUsersFindById
var result User=UmUsersFindById(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a User
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersFindById(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersFindById``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersFindById`: User fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersFindById`: %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 apiUmUsersFindByIdRequest 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
var result Users=UmUsersGet(ctx) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Offset(offset) .Limit(limit) .Execute()
List all Users
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) offset :=int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0) limit :=int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 100) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersGet`: Users fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersGet`: %v\n", resp)}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiUmUsersGetRequest 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
offset
int32
the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
[default to 0]
limit
int32
the maximum number of elements to return (use together with <code>offset</code> for pagination)
var result ResourceGroups=UmUsersGroupsGet(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a User's group resources
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersGroupsGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersGroupsGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersGroupsGet`: ResourceGroups fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersGroupsGet`: %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 apiUmUsersGroupsGetRequest 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
var result ResourcesUsers=UmUsersOwnsGet(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a User's own resources
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersOwnsGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersOwnsGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersOwnsGet`: ResourcesUsers fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersOwnsGet`: %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 apiUmUsersOwnsGetRequest 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
var result User=UmUsersPost(ctx) .User(user) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Create a user
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { user :=*openapiclient.NewUserPost(*openapiclient.NewUserPropertiesPost()) // UserPost | User to be created pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersPost(context.Background()).User(user).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersPost`: User fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersPost`: %v\n", resp)}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to a apiUmUsersPostRequest struct via the builder pattern
Name
Type
Description
Notes
user
User 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
var result User=UmUsersPut(ctx, userId) .User(user) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Modify a user
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | user :=*openapiclient.NewUserPut(*openapiclient.NewUserPropertiesPut()) // UserPut | Modified user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersPut(context.Background(), userId).User(user).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersPut``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersPut`: User fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersPut`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
Other Parameters
Other parameters are passed through a pointer to a apiUmUsersPutRequest struct via the builder pattern
Name
Type
Description
Notes
user
Modified user
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
var result map[string]interface{} =UmUsersS3keysDelete(ctx, userId, keyId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Delete a S3 key
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user keyId :="keyId_example"// string | The unique access key ID of the S3 key pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersS3keysDelete(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersS3keysDelete`: map[string]interface{} fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysDelete`: %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 access key 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 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
UmUsersS3keysFindByKeyId
var result S3Key=UmUsersS3keysFindByKeyId(ctx, userId, keyId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve given S3 key belonging to the given User
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user keyId :="keyId_example"// string | The unique access key ID of the S3 key pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersS3keysFindByKeyId(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysFindByKeyId``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersS3keysFindByKeyId`: S3Key fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.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 access key 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 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
var result S3Keys=UmUsersS3keysGet(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Retrieve a User's S3 keys
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersS3keysGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersS3keysGet`: S3Keys fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.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 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
var result S3Key=UmUsersS3keysPost(ctx, userId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Create a S3 key for the given user
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersS3keysPost(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersS3keysPost`: S3Key fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.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 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
var result S3Key=UmUsersS3keysPut(ctx, userId, keyId) .S3Key(s3Key) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute()
Modify a S3 key having the given key id
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | keyId :="keyId_example"// string | The unique access key ID of the S3 key s3Key :=*openapiclient.NewS3Key(*openapiclient.NewS3KeyProperties()) // S3Key | Modified S3 key pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) 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)
xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersS3keysPut(context.Background(), userId, keyId).S3Key(s3Key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysPut``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersS3keysPut`: S3Key fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysPut`: %v\n", resp)}
Path Parameters
Name
Type
Description
Notes
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
userId
string
keyId
string
The unique access key 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
Modified S3 key
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
var result S3ObjectStorageSSO=UmUsersS3ssourlGet(ctx, userId) .Pretty(pretty) .XContractNumber(xContractNumber) .Execute()
Retrieve S3 object storage single signon URL for the given user
Example
packagemainimport ("context""fmt""os" openapiclient "./openapi")funcmain() { userId :="userId_example"// string | The unique ID of the user pretty :=true// bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true) xContractNumber :=int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.UserManagementApi.UmUsersS3ssourlGet(context.Background(), userId).Pretty(pretty).XContractNumber(xContractNumber).Execute()if err !=nil { fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3ssourlGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) }// response from `UmUsersS3ssourlGet`: S3ObjectStorageSSO fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.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 response is pretty-printed (with indentation and new lines)
[default to true]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed