Метод list

HTTP-запрос
Path-параметры
Query-параметры
Ответ

Получает список ресурсов User для указанного кластера MongoDB.

HTTP-запрос

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

Path-параметры

Параметр	Описание
clusterId	Обязательное поле. Идентификатор кластера, для которого нужно получить список пользователей MongoDB. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр	Описание
pageSize	Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken	Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Параметр

Описание

pageSize

Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.

pageToken

Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

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

Поле	Описание
users[]	object Ресурс User для MongoDB. Подробнее см. в разделе Developer's Guide.
users[]. name	string Имя пользователя базы данных MongoDB.
users[]. clusterId	string Идентификатор кластера MongoDB, к которому принадлежит пользователь.
users[]. permissions[]	object Набор разрешений, предоставленных пользователю.
users[]. permissions[]. databaseName	string Имя базы данных, к которой предоставляет доступ разрешение.
users[]. permissions[]. roles[]	string Роли MongoDB базы данных `databaseName`, которые предоставляет разрешение.
nextPageToken	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.