UsersApi

UsersApi

All URIs are relative to https://api.ionos.com/databases/mongodb

Method	HTTP request	Description
clusters_users_delete	DELETE /clusters/{clusterId}/users/{username}	Delete a MongoDB User by ID
clusters_users_find_by_id	GET /clusters/{clusterId}/users/{username}	Get a MongoDB User by ID
clusters_users_get	GET /clusters/{clusterId}/users	Get all Cluster Users
clusters_users_patch	PATCH /clusters/{clusterId}/users/{username}	Patch a MongoDB User by ID
clusters_users_post	POST /clusters/{clusterId}/users	Create MongoDB User

clusters_users_delete

User clusters_users_delete(cluster_id, username)

Delete a MongoDB User by ID

Deletes a MongoDB user specified by its ID.

Example

from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
    host = 'https://api.ionos.com/databases/mongodb',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_mongo.UsersApi(api_client)
    cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
    username = 'username_example' # str | The authentication username.
    try:
        # Delete a MongoDB User by ID
        api_response = api_instance.clusters_users_delete(cluster_id, username)
        print(api_response)
    except ApiException as e:
        print('Exception when calling UsersApi.clusters_users_delete: %s\n' % e)

Parameters

Name	Type	Description	Notes
cluster_id	str	The unique ID of the cluster.
username	str	The authentication username.

Return type

User

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined

• Accept: application/json

clusters_users_find_by_id

User clusters_users_find_by_id(cluster_id, username)

Get a MongoDB User by ID

Retrieves the MongoDB user identified by the username.

Example

from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
    host = 'https://api.ionos.com/databases/mongodb',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_mongo.UsersApi(api_client)
    cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
    username = 'username_example' # str | The authentication username.
    try:
        # Get a MongoDB User by ID
        api_response = api_instance.clusters_users_find_by_id(cluster_id, username)
        print(api_response)
    except ApiException as e:
        print('Exception when calling UsersApi.clusters_users_find_by_id: %s\n' % e)

Parameters

Name	Type	Description	Notes
cluster_id	str	The unique ID of the cluster.
username	str	The authentication username.

Return type

User

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined

• Accept: application/json

clusters_users_get

UsersList clusters_users_get(cluster_id, limit=limit, offset=offset)

Get all Cluster Users

Retrieves a list of MongoDB users.

Example

from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
    host = 'https://api.ionos.com/databases/mongodb',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_mongo.UsersApi(api_client)
    cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
    try:
        # Get all Cluster Users
        api_response = api_instance.clusters_users_get(cluster_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling UsersApi.clusters_users_get: %s\n' % e)

Parameters

Name	Type	Description	Notes
cluster_id	str	The unique ID of the cluster.
limit	int	The maximum number of elements to return. Use together with 'offset' for pagination.	[optional] [default to 100]
offset	int	The first element to return. Use together with 'limit' for pagination.	[optional] [default to 0]

Return type

UsersList

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined

• Accept: application/json

clusters_users_patch

User clusters_users_patch(cluster_id, username, patch_user_request)

Patch a MongoDB User by ID

Patches a MongoDB user specified by its ID.

Example

from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
    host = 'https://api.ionos.com/databases/mongodb',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_mongo.UsersApi(api_client)
    cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
    username = 'username_example' # str | The authentication username.
    patch_user_request = ionoscloud_dbaas_mongo.PatchUserRequest() # PatchUserRequest | Part of the MongoDB user which should be modified.
    try:
        # Patch a MongoDB User by ID
        api_response = api_instance.clusters_users_patch(cluster_id, username, patch_user_request)
        print(api_response)
    except ApiException as e:
        print('Exception when calling UsersApi.clusters_users_patch: %s\n' % e)

Parameters

Name	Type	Description	Notes
cluster_id	str	The unique ID of the cluster.
username	str	The authentication username.
patch_user_request	PatchUserRequest	Part of the MongoDB user which should be modified.

Return type

User

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: application/json

• Accept: application/json

clusters_users_post

User clusters_users_post(cluster_id, user)

Create MongoDB User

Creates a MongoDB user.

Example

from __future__ import print_function
import time
import ionoscloud_dbaas_mongo
from ionoscloud_dbaas_mongo.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/databases/mongodb
configuration = ionoscloud_dbaas_mongo.Configuration(
    host = 'https://api.ionos.com/databases/mongodb',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud_dbaas_mongo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_mongo.UsersApi(api_client)
    cluster_id = 'cluster_id_example' # str | The unique ID of the cluster.
    user = ionoscloud_dbaas_mongo.User() # User | The user to be created.
    try:
        # Create MongoDB User
        api_response = api_instance.clusters_users_post(cluster_id, user)
        print(api_response)
    except ApiException as e:
        print('Exception when calling UsersApi.clusters_users_post: %s\n' % e)

Parameters

Name	Type	Description	Notes
cluster_id	str	The unique ID of the cluster.
user	User	The user to be created.

Return type

User

Authorization

basicAuth, tokenAuth

HTTP request headers

• Content-Type: application/json

• Accept: application/json