Method get

Returns the specified MongoDB User resource.

To get the list of available MongoDB User resources, make a list request.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/users/{userName}

Path parameters

Parameter Description
clusterId Required. ID of the MongoDB cluster the user belongs to. To get the cluster ID, use a list request. The maximum string length in characters is 50.
userName Required. Name of the MongoDB User resource to return. To get the name of the user, use a list request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.

Response

HTTP Code: 200 - OK

 {
  "name": "string",
  "clusterId": "string",
  "permissions": [
    {
      "databaseName": "string",
      "roles": [
        "string"
      ]
    }
  ]
}

A MongoDB User resource. For more information, see the Developer's Guide.

Field Description
name string

Name of the MongoDB user.

clusterId string

ID of the MongoDB cluster the user belongs to.

permissions[] object

Set of permissions granted to the user.

permissions[].
databaseName
string

Name of the database that the permission grants access to.

permissions[].
roles[]
string

MongoDB roles for the databaseName database that the permission grants.