Users

How to manage users of a database cluster.

Get all Cluster Users

get

Retrieves a list of MongoDB users.

Authorizations

basicAuthtokenAuth

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

Query parameters

limitinteger · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with 'offset' for pagination.

Default: 100Example: 100

offsetintegerOptional

The first element to return. Use together with 'limit' for pagination.

Default: 0Example: 200

Responses

200

Successful operation.

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance)

application/json

get

HTTPcURLJavaScriptPython

GET /databases/mongodb/clusters/{clusterId}/users HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "type": "collection",
  "id": "498ae72f-411f-11eb-9d07-046c59cc737e",
  "items": [
    {
      "type": "user",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "[email protected]",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
      },
      "properties": {
        "username": "text",
        "roles": [
          {
            "role": "read",
            "database": "text"
          }
        ]
      }
    }
  ]
}

Create MongoDB User

post

Creates a MongoDB user.

Authorizations

basicAuthtokenAuth

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

Body

MongoDB database user post request.

propertiesall ofOptional

MongoDB database user post request properties.

and

Responses

200

The created user is returned with metadata indicating when the user was created and by whom.

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance)

application/json

post

HTTPcURLJavaScriptPython

POST /databases/mongodb/clusters/{clusterId}/users HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
  },
  "properties": {
    "username": "text",
    "roles": [
      {
        "role": "read",
        "database": "text"
      }
    ],
    "password": "text"
  }
}

{
  "type": "user",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
  },
  "properties": {
    "username": "text",
    "roles": [
      {
        "role": "read",
        "database": "text"
      }
    ]
  }
}

Get a MongoDB User by ID

get

Retrieves the MongoDB user identified by the username.

Authorizations

basicAuthtokenAuth

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

usernamestringRequired

The authentication username.

Responses

200

The user identified by the username and database parameters is returned.

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance)

application/json

get

HTTPcURLJavaScriptPython

GET /databases/mongodb/clusters/{clusterId}/users/{username} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "type": "user",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
  },
  "properties": {
    "username": "text",
    "roles": [
      {
        "role": "read",
        "database": "text"
      }
    ]
  }
}

Delete a MongoDB User by ID

delete

Deletes a MongoDB user specified by its ID.

Authorizations

basicAuthtokenAuth

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

usernamestringRequired

The authentication username.

Responses

200

The user identified by the username and database parameters will be deleted from the cluster.

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance)

application/json

delete

HTTPcURLJavaScriptPython

DELETE /databases/mongodb/clusters/{clusterId}/users/{username} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "type": "user",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
  },
  "properties": {
    "username": "text",
    "roles": [
      {
        "role": "read",
        "database": "text"
      }
    ]
  }
}

Patch a MongoDB User by ID

patch

Patches a MongoDB user specified by its ID.

Authorizations

basicAuthtokenAuth

Path parameters

clusterIdstringRequired

The unique ID of the cluster.

usernamestringRequired

The authentication username.

Body

MongoDB database user patch request.

Responses

200

The user identified by the username and database parameters will be patched.

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient permissions), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 429 (request rate limit exceeded), 500 (server error), 503 (maintenance)

application/json

patch

HTTPcURLJavaScriptPython

PATCH /databases/mongodb/clusters/{clusterId}/users/{username} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
  },
  "properties": {
    "password": "text",
    "roles": [
      {
        "role": "read",
        "database": "text"
      }
    ]
  }
}

{
  "type": "user",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "[email protected]",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3"
  },
  "properties": {
    "username": "text",
    "roles": [
      {
        "role": "read",
        "database": "text"
      }
    ]
  }
}