Yandex Cloud
Документация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex StoreDoc
RU
  • Начало работы
  • Управление доступом
  • Инспекции и рекомендации
  • Правила тарификации
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • GrantPermission
        • RevokePermission
  • Справочник метрик
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  • Обучающие курсы

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

  • gRPC request
  • CreateUserRequest
  • UserSpec
  • Permission
  • operation.Operation
  1. Справочник API
  2. gRPC (англ.)
  3. User
  4. Create

Managed Service for MongoDB API, gRPC: UserService.Create

Статья создана
Yandex Cloud
Обновлена 7 октября 2026 г.
Открыть в Markdown
  • gRPC request
  • CreateUserRequest
  • UserSpec
  • Permission
  • operation.Operation

Creates a StoreDoc user in the specified cluster.

gRPC requestgRPC request

rpc Create (CreateUserRequest) returns (operation.Operation)

CreateUserRequestCreateUserRequest

{
  "cluster_id": "string",
  "user_spec": {
    "name": "string",
    "password": "string",
    "permissions": [
      {
        "database_name": "string",
        "roles": [
          "string"
        ]
      }
    ],
    "generate_password": "google.protobuf.BoolValue",
    "auth_type": "AuthType",
    "deletion_protection": "google.protobuf.BoolValue"
  }
}

Field

Description

cluster_id

string

Required field. ID of the StoreDoc cluster to create a user in.
To get the cluster ID, use a ClusterService.List request.

The maximum string length in characters is 50.

user_spec

UserSpec

Required field. Properties of the user to be created.

UserSpecUserSpec

Field

Description

name

string

Required field. Name of the StoreDoc user.

The maximum string length in characters is 63. Value must match the regular expression ^[a-zA-Z0-9_][a-zA-Z0-9_@.-]*$.

password

string

Password of the StoreDoc user.
Must not be set for users with the AuthType.AUTH_TYPE_IAM authentication type.

The maximum string length in characters is 128.

permissions[]

Permission

Set of permissions to grant to the user.

generate_password

google.protobuf.BoolValue

Generate password using Connection Manager

auth_type

enum AuthType

Authentication type for the user. Defaults to AUTH_TYPE_PASSWORD.

  • AUTH_TYPE_PASSWORD: Password-based authentication (SCRAM).
  • AUTH_TYPE_IAM: IAM-based authentication via iam-auth-proxy (SASL/PLAIN, $external).

deletion_protection

google.protobuf.BoolValue

Deletion Protection inhibits deletion of the user

PermissionPermission

Field

Description

database_name

string

Name of the database that the permission grants access to.

roles[]

string

StoreDoc roles for the database_name database that the permission grants.

operation.Operationoperation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

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

Предыдущая
List
Следующая
Update
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»