Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Managed Service for MongoDB
  • Начало работы
  • Управление доступом
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • GrantPermission
        • RevokePermission
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Обучающие курсы

В этой статье:

  • gRPC request
  • ListUsersRequest
  • ListUsersResponse
  • User
  • Permission
  1. Справочник API
  2. gRPC (англ.)
  3. User
  4. List

Managed Service for MongoDB API, gRPC: UserService.List

Статья создана
Yandex Cloud
Обновлена 26 ноября 2024 г.
  • gRPC request
  • ListUsersRequest
  • ListUsersResponse
  • User
  • Permission

Retrieves the list of MongoDB User resources in the specified cluster.

gRPC requestgRPC request

rpc List (ListUsersRequest) returns (ListUsersResponse)

ListUsersRequestListUsersRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

cluster_id

string

Required field. ID of the cluster to list MongoDB users in.
To get the cluster ID, use a ClusterService.List request.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListUsersResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results, set page_token to the
ListUsersResponse.next_page_token returned by the previous list request.

ListUsersResponseListUsersResponse

{
  "users": [
    {
      "name": "string",
      "cluster_id": "string",
      "permissions": [
        {
          "database_name": "string",
          "roles": [
            "string"
          ]
        }
      ]
    }
  ],
  "next_page_token": "string"
}

Field

Description

users[]

User

List of MongoDB User resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListUsersRequest.page_size, use the next_page_token as the value
for the ListUsersRequest.page_token parameter in the next list request. Each subsequent
list request will have its own next_page_token to continue paging through the results.

UserUser

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

Field

Description

name

string

Name of the MongoDB user.

cluster_id

string

ID of the MongoDB cluster the user belongs to.

permissions[]

Permission

Set of permissions granted to the user.

PermissionPermission

Field

Description

database_name

string

Name of the database that the permission grants access to.

roles[]

string

MongoDB roles for the database_name database that the permission grants.

Была ли статья полезна?

Предыдущая
Get
Следующая
Create
Проект Яндекса
© 2025 ООО «Яндекс.Облако»