> For the complete documentation index, see [llms.txt](https://docs.ionos.com/sdk-go-bundle/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/sdk-go-bundle/sdks/mongo/api/usersapi.md). # UsersApi All URIs are relative to ** | Method | HTTP request | Description | | --------------------------------------------------- | ------------------------------------------------- | --------------------------- | | [**ClustersUsersDelete**](#ClustersUsersDelete) | **Delete** /clusters/{clusterId}/users/{username} | Delete a MongoDB User by ID | | [**ClustersUsersFindById**](#ClustersUsersFindById) | **Get** /clusters/{clusterId}/users/{username} | Get a MongoDB User by ID | | [**ClustersUsersGet**](#ClustersUsersGet) | **Get** /clusters/{clusterId}/users | Get all Cluster Users | | [**ClustersUsersPatch**](#ClustersUsersPatch) | **Patch** /clusters/{clusterId}/users/{username} | Patch a MongoDB User by ID | | [**ClustersUsersPost**](#ClustersUsersPost) | **Post** /clusters/{clusterId}/users | Create MongoDB User | ## ClustersUsersDelete ```go var result User = ClustersUsersDelete(ctx, clusterId, username) .Execute() ``` Delete a MongoDB User by ID ### Example ```go package main import ( "context" "fmt" "os" mongo "github.com/ionos-cloud/sdk-go-bundle/products/mongo" "github.com/ionos-cloud/sdk-go-bundle/shared" ) func main() { clusterId := "clusterId_example" // string | The unique ID of the cluster. username := "username_example" // string | The authentication username. configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := mongo.NewAPIClient(configuration) resp, err := apiClient.UsersApi.ClustersUsersDelete(context.Background(), clusterId, username).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.ClustersUsersDelete``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp) } // response from `ClustersUsersDelete`: User fmt.Fprintf(os.Stdout, "Response from `UsersApi.ClustersUsersDelete`: %v\n", resource) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The unique ID of the cluster. | | | **username** | **string** | The authentication username. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersUsersDeleteRequest struct via the builder pattern | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | ### Return type [**User**](/sdk-go-bundle/sdks/mongo/models/user.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## ClustersUsersFindById ```go var result User = ClustersUsersFindById(ctx, clusterId, username) .Execute() ``` Get a MongoDB User by ID ### Example ```go package main import ( "context" "fmt" "os" mongo "github.com/ionos-cloud/sdk-go-bundle/products/mongo" "github.com/ionos-cloud/sdk-go-bundle/shared" ) func main() { clusterId := "clusterId_example" // string | The unique ID of the cluster. username := "username_example" // string | The authentication username. configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := mongo.NewAPIClient(configuration) resource, resp, err := apiClient.UsersApi.ClustersUsersFindById(context.Background(), clusterId, username).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.ClustersUsersFindById``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp) } // response from `ClustersUsersFindById`: User fmt.Fprintf(os.Stdout, "Response from `UsersApi.ClustersUsersFindById`: %v\n", resource) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The unique ID of the cluster. | | | **username** | **string** | The authentication username. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersUsersFindByIdRequest struct via the builder pattern | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | ### Return type [**User**](/sdk-go-bundle/sdks/mongo/models/user.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## ClustersUsersGet ```go var result UsersList = ClustersUsersGet(ctx, clusterId) .Limit(limit) .Offset(offset) .Execute() ``` Get all Cluster Users ### Example ```go package main import ( "context" "fmt" "os" mongo "github.com/ionos-cloud/sdk-go-bundle/products/mongo" "github.com/ionos-cloud/sdk-go-bundle/shared" ) func main() { clusterId := "clusterId_example" // string | The unique ID of the cluster. limit := int32(100) // int32 | The maximum number of elements to return. Use together with 'offset' for pagination. (optional) (default to 100) offset := int32(200) // int32 | The first element to return. Use together with 'limit' for pagination. (optional) (default to 0) configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := mongo.NewAPIClient(configuration) resource, resp, err := apiClient.UsersApi.ClustersUsersGet(context.Background(), clusterId).Limit(limit).Offset(offset).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.ClustersUsersGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp) } // response from `ClustersUsersGet`: UsersList fmt.Fprintf(os.Stdout, "Response from `UsersApi.ClustersUsersGet`: %v\n", resource) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The unique ID of the cluster. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersUsersGetRequest struct via the builder pattern | Name | Type | Description | Notes | | ---------- | --------- | ------------------------------------------------------------------------------------ | ----------------- | | **limit** | **int32** | The maximum number of elements to return. Use together with 'offset' for pagination. | \[default to 100] | | **offset** | **int32** | The first element to return. Use together with 'limit' for pagination. | \[default to 0] | ### Return type [**UsersList**](/sdk-go-bundle/sdks/mongo/models/userslist.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## ClustersUsersPatch ```go var result User = ClustersUsersPatch(ctx, clusterId, username) .PatchUserRequest(patchUserRequest) .Execute() ``` Patch a MongoDB User by ID ### Example ```go package main import ( "context" "fmt" "os" mongo "github.com/ionos-cloud/sdk-go-bundle/products/mongo" "github.com/ionos-cloud/sdk-go-bundle/shared" ) func main() { clusterId := "clusterId_example" // string | The unique ID of the cluster. username := "username_example" // string | The authentication username. patchUserRequest := *openapiclient.NewPatchUserRequest() // PatchUserRequest | Part of the MongoDB user which should be modified. configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := mongo.NewAPIClient(configuration) resource, resp, err := apiClient.UsersApi.ClustersUsersPatch(context.Background(), clusterId, username).PatchUserRequest(patchUserRequest).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.ClustersUsersPatch``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp) } // response from `ClustersUsersPatch`: User fmt.Fprintf(os.Stdout, "Response from `UsersApi.ClustersUsersPatch`: %v\n", resource) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The unique ID of the cluster. | | | **username** | **string** | The authentication username. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersUsersPatchRequest struct via the builder pattern | Name | Type | Description | Notes | | -------------------- | ---------------------------------------------------------------------------- | -------------------------------------------------- | ----- | | **patchUserRequest** | [**PatchUserRequest**](/sdk-go-bundle/sdks/mongo/models/patchuserrequest.md) | Part of the MongoDB user which should be modified. | | ### Return type [**User**](/sdk-go-bundle/sdks/mongo/models/user.md) ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ## ClustersUsersPost ```go var result User = ClustersUsersPost(ctx, clusterId) .User(user) .Execute() ``` Create MongoDB User ### Example ```go package main import ( "context" "fmt" "os" mongo "github.com/ionos-cloud/sdk-go-bundle/products/mongo" "github.com/ionos-cloud/sdk-go-bundle/shared" ) func main() { clusterId := "clusterId_example" // string | The unique ID of the cluster. user := *openapiclient.NewUser() // User | The user to be created. configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL") apiClient := mongo.NewAPIClient(configuration) resource, resp, err := apiClient.UsersApi.ClustersUsersPost(context.Background(), clusterId).User(user).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.ClustersUsersPost``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp) } // response from `ClustersUsersPost`: User fmt.Fprintf(os.Stdout, "Response from `UsersApi.ClustersUsersPost`: %v\n", resource) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **clusterId** | **string** | The unique ID of the cluster. | | ### Other Parameters Other parameters are passed through a pointer to an apiClustersUsersPostRequest struct via the builder pattern | Name | Type | Description | Notes | | -------- | ---------------------------------------------------- | ----------------------- | ----- | | **user** | [**User**](/sdk-go-bundle/sdks/mongo/models/user.md) | The user to be created. | | ### Return type [**User**](/sdk-go-bundle/sdks/mongo/models/user.md) ### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ionos.com/sdk-go-bundle/sdks/mongo/api/usersapi.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.