UserService

Набор методов для управления ресурсами User для MongoDB.

Вызов Описание
Get Возвращает указанный ресурс User для MongoDB.
List Получает список ресурсов User для указанного кластера MongoDB.
Create Создает пользователя MongoDB в указанном кластере.
Update Изменяет указанного пользователя MongoDB.
Delete Удаляет указанного пользователя MongoDB.
GrantPermission Предоставляет разрешение указанному пользователю MongoDB.
RevokePermission Отзывает разрешение у указанного пользователя MongoDB.

Вызовы UserService

Get

Возвращает указанный ресурс User для MongoDB.
Чтобы получить список доступных ресурсов User для MongoDB, отправьте запрос List.

rpc Get (GetUserRequest) returns (User)

GetUserRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
user_name string
Обязательное поле. Имя запрашиваемого ресурса User для MongoDB. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

User

Поле Описание
name string
Имя пользователя базы данных MongoDB.
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
permissions[] Permission
Набор разрешений, предоставленных пользователю.

Permission

Поле Описание
database_name string
Имя базы данных, к которой предоставляет доступ разрешение.
roles[] string
Роли MongoDB базы данных database_name, которые предоставляет разрешение.

List

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

rpc List (ListUsersRequest) returns (ListUsersResponse)

ListUsersRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера, для которого нужно получить список пользователей MongoDB. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
page_size int64
Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListUsersResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListUsersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

ListUsersResponse

Поле Описание
users[] User
Список ресурсов User для MongoDB.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListUsersRequest.page_size, используйте next_page_token в качестве значения параметра ListUsersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

User

Поле Описание
name string
Имя пользователя базы данных MongoDB.
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
permissions[] Permission
Набор разрешений, предоставленных пользователю.

Permission

Поле Описание
database_name string
Имя базы данных, к которой предоставляет доступ разрешение.
roles[] string
Роли MongoDB базы данных database_name, которые предоставляет разрешение.

Create

Создает пользователя MongoDB в указанном кластере.

rpc Create (CreateUserRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:CreateUserMetadata
    Operation.response:User

CreateUserRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, для которого следует создать пользователя. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
user_spec UserSpec
Свойства создаваемого пользователя.

UserSpec

Поле Описание
name string
Обязательное поле. Имя пользователя базы данных MongoDB. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
password string
Обязательное поле. Пароль пользователя MongoDB. Длина строки в символах должна быть от 8 до 128.
permissions[] Permission
Набор разрешений, которые следует предоставить пользователю.

Permission

Поле Описание
database_name string
Имя базы данных, к которой предоставляет доступ разрешение.
roles[] string
Роли MongoDB базы данных database_name, которые предоставляет разрешение.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<CreateUserMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<User>
в случае успешного выполнения операции.

CreateUserMetadata

Поле Описание
cluster_id string
Идентификатор кластера MongoDB, в котором создается пользователь.
user_name string
Имя создаваемого пользователя.

User

Поле Описание
name string
Имя пользователя базы данных MongoDB.
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
permissions[] Permission
Набор разрешений, предоставленных пользователю.

Update

Изменяет указанного пользователя MongoDB.

rpc Update (UpdateUserRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:UpdateUserMetadata
    Operation.response:User

UpdateUserRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
user_name string
Обязательное поле. Имя пользователя, которого следует изменить. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
update_mask google.protobuf.FieldMask
Маска, которая указывает, какие поля ресурса User для MongoDB должны быть обновлены.
password string
Новый пароль для пользователя. Длина строки в символах должна быть от 8 до 128.
permissions[] Permission
Новый набор разрешений для пользователя.

Permission

Поле Описание
database_name string
Имя базы данных, к которой предоставляет доступ разрешение.
roles[] string
Роли MongoDB базы данных database_name, которые предоставляет разрешение.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<UpdateUserMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<User>
в случае успешного выполнения операции.

UpdateUserMetadata

Поле Описание
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
user_name string
Имя изменяемого пользователя.

User

Поле Описание
name string
Имя пользователя базы данных MongoDB.
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
permissions[] Permission
Набор разрешений, предоставленных пользователю.

Delete

Удаляет указанного пользователя MongoDB.

rpc Delete (DeleteUserRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:DeleteUserMetadata
    Operation.response:google.protobuf.Empty

DeleteUserRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
user_name string
Обязательное поле. Имя удаляемого пользователя. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<DeleteUserMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<google.protobuf.Empty>
в случае успешного выполнения операции.

DeleteUserMetadata

Поле Описание
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
user_name string
Имя удаляемого пользователя.

GrantPermission

Предоставляет разрешение указанному пользователю MongoDB.

rpc GrantPermission (GrantUserPermissionRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:GrantUserPermissionMetadata
    Operation.response:User

GrantUserPermissionRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
user_name string
Обязательное поле. Имя пользователя, которому следует предоставить разрешение. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
permission Permission
Обязательное поле. Разрешение, которое должно быть предоставлено указанному пользователю.

Permission

Поле Описание
database_name string
Имя базы данных, к которой предоставляет доступ разрешение.
roles[] string
Роли MongoDB базы данных database_name, которые предоставляет разрешение.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<GrantUserPermissionMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<User>
в случае успешного выполнения операции.

GrantUserPermissionMetadata

Поле Описание
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List.
user_name string
Имя пользователя, которому предоставляется разрешение.

User

Поле Описание
name string
Имя пользователя базы данных MongoDB.
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
permissions[] Permission
Набор разрешений, предоставленных пользователю.

RevokePermission

Отзывает разрешение у указанного пользователя MongoDB.

rpc RevokePermission (RevokeUserPermissionRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:RevokeUserPermissionMetadata
    Operation.response:User

RevokeUserPermissionRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, к которому принадлежит пользователь. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
user_name string
Обязательное поле. Имя пользователя, у которого следует отозвать разрешение. Чтобы получить имя пользователя, используйте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
database_name string
Обязательное поле. Имя базы данных, к которой пользователь должен потерять доступ. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<RevokeUserPermissionMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<User>
в случае успешного выполнения операции.

RevokeUserPermissionMetadata

Поле Описание
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
user_name string
Имя пользователя, чье разрешение отзывается.

User

Поле Описание
name string
Имя пользователя базы данных MongoDB.
cluster_id string
Идентификатор кластера MongoDB, к которому принадлежит пользователь.
permissions[] Permission
Набор разрешений, предоставленных пользователю.