Подключиться
Yandex Lockbox

SecretService

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

Вызов Описание
Get Возвращает указанный секрет.
List Возвращает список секретов в указанном каталоге.
Create Создает секрет в указанном каталоге.
Update Обновляет указанный секрет.
Delete Удаляет указанный секрет.
Activate Активирует указанный секрет.
Deactivate Деактивирует указанный секрет.
ListVersions Возвращает список версий указанного секрета.
AddVersion Добавляет новую версию на основе предыдущей.
ScheduleVersionDestruction Планирует уничтожение указанной версии ключа.
CancelVersionDestruction Отменяет запланированное уничтожение версии, если версия еще не была уничтожена.
ListOperations Возвращает список операций для указанного секрета.
ListAccessBindings Возвращает список привязок прав доступа для указанного сертификата.
SetAccessBindings Устанавливает привязки прав доступа для секрета.
UpdateAccessBindings Обновляет привязки прав доступа для секрета.

Вызовы SecretService

Get

Возвращает указанный секрет.
Чтобы получить список доступных секретов, выполните запрос List. Чтобы получить содержимое версии, используйте запрос PayloadService.Get.

rpc Get (GetSecretRequest) returns (Secret)

GetSecretRequest

Поле Описание
secret_id string
Обязательное поле. Идентификатор возвращаемого секрета.
Чтобы получить идентификатор секрета, выполните запрос List. Максимальная длина строки в символах — 50.

Secret

Поле Описание
id string
Идентификатор секрета.
folder_id string
Идентификатор каталога, которому принадлежит секрет.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя секрета.
description string
(опционально) Описание секрета.
labels map<string,string>
Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
kms_key_id string
(опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
status enum Status
Статус секрета.
  • CREATING: Секрет создается.
  • ACTIVE: Секрет активен и к нему можно получить доступ.
    Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
  • INACTIVE: Секрет неактивен и не может быть использован.
    Можно установить в ACTIVE с помощью метода SecretService.Activate.
    current_version Version
    Текущая версия секрета.
    deletion_protection bool
    Флаг, запрещающий удаление секрета.

    Version

    Поле Описание
    id string
    Идентификатор версии.
    secret_id string
    Идентификатор секрета, которому принадлежит версия.
    created_at google.protobuf.Timestamp
    Время создания версии ключа.
    destroy_at google.protobuf.Timestamp
    Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
    description string
    (опционально) Описание версии.
    status enum Status
    Статус секрета.
    • ACTIVE: Секрет активен и к нему можно получить доступ.
    • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
    • DESTROYED: Версия уничтожена и не может быть восстановлена.
      payload_entry_keys[] string
      Ключи содержимого версии.

      List

      Возвращает список секретов в указанном каталоге.

      rpc List (ListSecretsRequest) returns (ListSecretsResponse)

      ListSecretsRequest

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

      ListSecretsResponse

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

      Secret

      Поле Описание
      id string
      Идентификатор секрета.
      folder_id string
      Идентификатор каталога, которому принадлежит секрет.
      created_at google.protobuf.Timestamp
      Время создания.
      name string
      Имя секрета.
      description string
      (опционально) Описание секрета.
      labels map<string,string>
      Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
      kms_key_id string
      (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
      status enum Status
      Статус секрета.
      • CREATING: Секрет создается.
      • ACTIVE: Секрет активен и к нему можно получить доступ.
        Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
      • INACTIVE: Секрет неактивен и не может быть использован.
        Можно установить в ACTIVE с помощью метода SecretService.Activate.
        current_version Version
        Текущая версия секрета.
        deletion_protection bool
        Флаг, запрещающий удаление секрета.

        Version

        Поле Описание
        id string
        Идентификатор версии.
        secret_id string
        Идентификатор секрета, которому принадлежит версия.
        created_at google.protobuf.Timestamp
        Время создания версии ключа.
        destroy_at google.protobuf.Timestamp
        Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
        description string
        (опционально) Описание версии.
        status enum Status
        Статус секрета.
        • ACTIVE: Секрет активен и к нему можно получить доступ.
        • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
        • DESTROYED: Версия уничтожена и не может быть восстановлена.
          payload_entry_keys[] string
          Ключи содержимого версии.

          Create

          Создает секрет в указанном каталоге.

          rpc Create (CreateSecretRequest) returns (operation.Operation)

          Метаданные и результат операции:

              Operation.metadata:CreateSecretMetadata

              Operation.response:Secret

          CreateSecretRequest

          Поле Описание
          folder_id string
          Обязательное поле. Идентификатор каталога, в котором создается секрет. Максимальная длина строки в символах — 50.
          name string
          Имя секрета. Максимальная длина строки в символах — 100.
          description string
          Описание секрета. Максимальная длина строки в символах — 1024.
          labels map<string,string>
          Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
          kms_key_id string
          (опционально) Идентификатор ключа KMS. Используется для шифрования и расшифровки секрета. Максимальная длина строки в символах — 50.
          version_description string
          Описание первой версии. Максимальная длина строки в символах — 256.
          version_payload_entries[] PayloadEntryChange
          Содержимое первой версии секрета. Максимальное количество элементов — 32.
          deletion_protection bool
          Флаг, запрещающий удаление секрета.

          PayloadEntryChange

          Поле Описание
          key string
          Обязательное поле. Неконфиденциальный ключ содержимого версии. Максимальная длина строки в символах — 256. Значение должно соответствовать регулярному выражению [.-_0-9a-zA-Z]+.
          value oneof: text_value или binary_value
          Конфиденциальная часть содержимого версии.
            text_value string
          Используйте это поле для задания текстового значения. Максимальная длина строки в символах — 65536.
            binary_value bytes
          Используйте это поле для установки двоичного значения. Максимальная длина строки в символах — 65536.

          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<CreateSecretMetadata>
          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Secret>
          в случае успешного выполнения операции.

          CreateSecretMetadata

          Поле Описание
          secret_id string
          Идентификатор создаваемого секрета.
          version_id string
          Идентификатор текущей версии создаваемого секрета.

          Secret

          Поле Описание
          id string
          Идентификатор секрета.
          folder_id string
          Идентификатор каталога, которому принадлежит секрет.
          created_at google.protobuf.Timestamp
          Время создания.
          name string
          Имя секрета.
          description string
          (опционально) Описание секрета.
          labels map<string,string>
          Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
          kms_key_id string
          (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
          status enum Status
          Статус секрета.
          • CREATING: Секрет создается.
          • ACTIVE: Секрет активен и к нему можно получить доступ.
            Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
          • INACTIVE: Секрет неактивен и не может быть использован.
            Можно установить в ACTIVE с помощью метода SecretService.Activate.
            current_version Version
            Текущая версия секрета.
            deletion_protection bool
            Флаг, запрещающий удаление секрета.

            Version

            Поле Описание
            id string
            Идентификатор версии.
            secret_id string
            Идентификатор секрета, которому принадлежит версия.
            created_at google.protobuf.Timestamp
            Время создания версии ключа.
            destroy_at google.protobuf.Timestamp
            Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
            description string
            (опционально) Описание версии.
            status enum Status
            Статус секрета.
            • ACTIVE: Секрет активен и к нему можно получить доступ.
            • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
            • DESTROYED: Версия уничтожена и не может быть восстановлена.
              payload_entry_keys[] string
              Ключи содержимого версии.

              Update

              Обновляет указанный секрет.

              rpc Update (UpdateSecretRequest) returns (operation.Operation)

              Метаданные и результат операции:

                  Operation.metadata:UpdateSecretMetadata

                  Operation.response:Secret

              UpdateSecretRequest

              Поле Описание
              secret_id string
              Обязательное поле. Идентификатор секрета для обновления. Максимальная длина строки в символах — 50.
              update_mask google.protobuf.FieldMask
              Обязательное поле. Маска, определяющая, какие поля указанного сертификата будут обновлены.
              name string
              Новое имя секрета. Максимальная длина строки в символах — 100.
              description string
              Новое описание секрета. Максимальная длина строки в символах — 1024.
              labels map<string,string>
              Пользовательские метки для секрета в виде пар @b "key:value". Максимум 64 на ключ. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
              deletion_protection bool
              Флаг, запрещающий удаление секрета.

              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<UpdateSecretMetadata>
              Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Secret>
              в случае успешного выполнения операции.

              UpdateSecretMetadata

              Поле Описание
              secret_id string
              Обязательное поле. Идентификатор обновляемого секрета. Максимальная длина строки в символах — 50.

              Secret

              Поле Описание
              id string
              Идентификатор секрета.
              folder_id string
              Идентификатор каталога, которому принадлежит секрет.
              created_at google.protobuf.Timestamp
              Время создания.
              name string
              Имя секрета.
              description string
              (опционально) Описание секрета.
              labels map<string,string>
              Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
              kms_key_id string
              (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
              status enum Status
              Статус секрета.
              • CREATING: Секрет создается.
              • ACTIVE: Секрет активен и к нему можно получить доступ.
                Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
              • INACTIVE: Секрет неактивен и не может быть использован.
                Можно установить в ACTIVE с помощью метода SecretService.Activate.
                current_version Version
                Текущая версия секрета.
                deletion_protection bool
                Флаг, запрещающий удаление секрета.

                Version

                Поле Описание
                id string
                Идентификатор версии.
                secret_id string
                Идентификатор секрета, которому принадлежит версия.
                created_at google.protobuf.Timestamp
                Время создания версии ключа.
                destroy_at google.protobuf.Timestamp
                Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                description string
                (опционально) Описание версии.
                status enum Status
                Статус секрета.
                • ACTIVE: Секрет активен и к нему можно получить доступ.
                • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                • DESTROYED: Версия уничтожена и не может быть восстановлена.
                  payload_entry_keys[] string
                  Ключи содержимого версии.

                  Delete

                  Удаляет указанный секрет.

                  rpc Delete (DeleteSecretRequest) returns (operation.Operation)

                  Метаданные и результат операции:

                      Operation.metadata:DeleteSecretMetadata

                      Operation.response:Secret

                  DeleteSecretRequest

                  Поле Описание
                  secret_id string
                  Обязательное поле. Идентификатор секрета, подлежащего удалению. Максимальная длина строки в символах — 50.

                  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<DeleteSecretMetadata>
                  Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Secret>
                  в случае успешного выполнения операции.

                  DeleteSecretMetadata

                  Поле Описание
                  secret_id string
                  Идентификатор удаляемого секрета.

                  Secret

                  Поле Описание
                  id string
                  Идентификатор секрета.
                  folder_id string
                  Идентификатор каталога, которому принадлежит секрет.
                  created_at google.protobuf.Timestamp
                  Время создания.
                  name string
                  Имя секрета.
                  description string
                  (опционально) Описание секрета.
                  labels map<string,string>
                  Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
                  kms_key_id string
                  (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
                  status enum Status
                  Статус секрета.
                  • CREATING: Секрет создается.
                  • ACTIVE: Секрет активен и к нему можно получить доступ.
                    Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
                  • INACTIVE: Секрет неактивен и не может быть использован.
                    Можно установить в ACTIVE с помощью метода SecretService.Activate.
                    current_version Version
                    Текущая версия секрета.
                    deletion_protection bool
                    Флаг, запрещающий удаление секрета.

                    Version

                    Поле Описание
                    id string
                    Идентификатор версии.
                    secret_id string
                    Идентификатор секрета, которому принадлежит версия.
                    created_at google.protobuf.Timestamp
                    Время создания версии ключа.
                    destroy_at google.protobuf.Timestamp
                    Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                    description string
                    (опционально) Описание версии.
                    status enum Status
                    Статус секрета.
                    • ACTIVE: Секрет активен и к нему можно получить доступ.
                    • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                    • DESTROYED: Версия уничтожена и не может быть восстановлена.
                      payload_entry_keys[] string
                      Ключи содержимого версии.

                      Activate

                      Активирует указанный секрет.

                      rpc Activate (ActivateSecretRequest) returns (operation.Operation)

                      Метаданные и результат операции:

                          Operation.metadata:ActivateSecretMetadata

                          Operation.response:Secret

                      ActivateSecretRequest

                      Поле Описание
                      secret_id string
                      Обязательное поле. Идентификатор секрета для активации. Максимальная длина строки в символах — 50.

                      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<ActivateSecretMetadata>
                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Secret>
                      в случае успешного выполнения операции.

                      ActivateSecretMetadata

                      Поле Описание
                      secret_id string
                      Идентификатор активируемого секрета.

                      Secret

                      Поле Описание
                      id string
                      Идентификатор секрета.
                      folder_id string
                      Идентификатор каталога, которому принадлежит секрет.
                      created_at google.protobuf.Timestamp
                      Время создания.
                      name string
                      Имя секрета.
                      description string
                      (опционально) Описание секрета.
                      labels map<string,string>
                      Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
                      kms_key_id string
                      (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
                      status enum Status
                      Статус секрета.
                      • CREATING: Секрет создается.
                      • ACTIVE: Секрет активен и к нему можно получить доступ.
                        Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
                      • INACTIVE: Секрет неактивен и не может быть использован.
                        Можно установить в ACTIVE с помощью метода SecretService.Activate.
                        current_version Version
                        Текущая версия секрета.
                        deletion_protection bool
                        Флаг, запрещающий удаление секрета.

                        Version

                        Поле Описание
                        id string
                        Идентификатор версии.
                        secret_id string
                        Идентификатор секрета, которому принадлежит версия.
                        created_at google.protobuf.Timestamp
                        Время создания версии ключа.
                        destroy_at google.protobuf.Timestamp
                        Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                        description string
                        (опционально) Описание версии.
                        status enum Status
                        Статус секрета.
                        • ACTIVE: Секрет активен и к нему можно получить доступ.
                        • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                        • DESTROYED: Версия уничтожена и не может быть восстановлена.
                          payload_entry_keys[] string
                          Ключи содержимого версии.

                          Deactivate

                          Деактивирует указанный секрет.

                          rpc Deactivate (DeactivateSecretRequest) returns (operation.Operation)

                          Метаданные и результат операции:

                              Operation.metadata:DeactivateSecretMetadata

                              Operation.response:Secret

                          DeactivateSecretRequest

                          Поле Описание
                          secret_id string
                          Обязательное поле. Идентификатор секрета для деактивации. Максимальная длина строки в символах — 50.

                          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<DeactivateSecretMetadata>
                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Secret>
                          в случае успешного выполнения операции.

                          DeactivateSecretMetadata

                          Поле Описание
                          secret_id string
                          Идентификатор деактивируемого секрета.

                          Secret

                          Поле Описание
                          id string
                          Идентификатор секрета.
                          folder_id string
                          Идентификатор каталога, которому принадлежит секрет.
                          created_at google.protobuf.Timestamp
                          Время создания.
                          name string
                          Имя секрета.
                          description string
                          (опционально) Описание секрета.
                          labels map<string,string>
                          Пользовательские метки для секрета в виде пар key:value. Максимум 64 на ключ.
                          kms_key_id string
                          (опционально) Идентификатор пользовательского ключа KMS. Если пользовательский ключ не указан, для шифрования и расшифровки используется системный ключ.
                          status enum Status
                          Статус секрета.
                          • CREATING: Секрет создается.
                          • ACTIVE: Секрет активен и к нему можно получить доступ.
                            Можно установить в INACTIVE с помощью метода SecretService.Deactivate.
                          • INACTIVE: Секрет неактивен и не может быть использован.
                            Можно установить в ACTIVE с помощью метода SecretService.Activate.
                            current_version Version
                            Текущая версия секрета.
                            deletion_protection bool
                            Флаг, запрещающий удаление секрета.

                            Version

                            Поле Описание
                            id string
                            Идентификатор версии.
                            secret_id string
                            Идентификатор секрета, которому принадлежит версия.
                            created_at google.protobuf.Timestamp
                            Время создания версии ключа.
                            destroy_at google.protobuf.Timestamp
                            Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                            description string
                            (опционально) Описание версии.
                            status enum Status
                            Статус секрета.
                            • ACTIVE: Секрет активен и к нему можно получить доступ.
                            • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                            • DESTROYED: Версия уничтожена и не может быть восстановлена.
                              payload_entry_keys[] string
                              Ключи содержимого версии.

                              ListVersions

                              Возвращает список версий указанного секрета.

                              rpc ListVersions (ListVersionsRequest) returns (ListVersionsResponse)

                              ListVersionsRequest

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

                              ListVersionsResponse

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

                              Version

                              Поле Описание
                              id string
                              Идентификатор версии.
                              secret_id string
                              Идентификатор секрета, которому принадлежит версия.
                              created_at google.protobuf.Timestamp
                              Время создания версии ключа.
                              destroy_at google.protobuf.Timestamp
                              Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                              description string
                              (опционально) Описание версии.
                              status enum Status
                              Статус секрета.
                              • ACTIVE: Секрет активен и к нему можно получить доступ.
                              • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                              • DESTROYED: Версия уничтожена и не может быть восстановлена.
                                payload_entry_keys[] string
                                Ключи содержимого версии.

                                AddVersion

                                Добавляет новую версию на основе предыдущей.

                                rpc AddVersion (AddVersionRequest) returns (operation.Operation)

                                Метаданные и результат операции:

                                    Operation.metadata:AddVersionMetadata

                                    Operation.response:Version

                                AddVersionRequest

                                Поле Описание
                                secret_id string
                                Обязательное поле. Идентификатор секрета. Максимальная длина строки в символах — 50.
                                description string
                                Описание версии. Максимальная длина строки в символах — 1024.
                                payload_entries[] PayloadEntryChange
                                Описание изменения содержимого базовой версии в новой версии. Максимальное количество элементов — 32.
                                base_version_id string
                                (опционально) Идентификатор базовой версии. Если параметр не указан, по умолчанию используется текущая версия. Максимальная длина строки в символах — 50.

                                PayloadEntryChange

                                Поле Описание
                                key string
                                Обязательное поле. Неконфиденциальный ключ содержимого версии. Максимальная длина строки в символах — 256. Значение должно соответствовать регулярному выражению [.-_0-9a-zA-Z]+.
                                value oneof: text_value или binary_value
                                Конфиденциальная часть содержимого версии.
                                  text_value string
                                Используйте это поле для задания текстового значения. Максимальная длина строки в символах — 65536.
                                  binary_value bytes
                                Используйте это поле для установки двоичного значения. Максимальная длина строки в символах — 65536.

                                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<AddVersionMetadata>
                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Version>
                                в случае успешного выполнения операции.

                                AddVersionMetadata

                                Поле Описание
                                secret_id string
                                Идентификатор секрета.
                                version_id string
                                Идентификатор добавленной версии.

                                Version

                                Поле Описание
                                id string
                                Идентификатор версии.
                                secret_id string
                                Идентификатор секрета, которому принадлежит версия.
                                created_at google.protobuf.Timestamp
                                Время создания версии ключа.
                                destroy_at google.protobuf.Timestamp
                                Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                                description string
                                (опционально) Описание версии.
                                status enum Status
                                Статус секрета.
                                • ACTIVE: Секрет активен и к нему можно получить доступ.
                                • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                                • DESTROYED: Версия уничтожена и не может быть восстановлена.
                                  payload_entry_keys[] string
                                  Ключи содержимого версии.

                                  ScheduleVersionDestruction

                                  Планирует уничтожение указанной версии ключа.
                                  Запланированное уничтожение может быть отменено с помощью запроса SecretService.CancelVersionDestruction.

                                  rpc ScheduleVersionDestruction (ScheduleVersionDestructionRequest) returns (operation.Operation)

                                  Метаданные и результат операции:

                                      Operation.metadata:ScheduleVersionDestructionMetadata

                                      Operation.response:Version

                                  ScheduleVersionDestructionRequest

                                  Поле Описание
                                  secret_id string
                                  Обязательное поле. Идентификатор ключа, для которого следует запланировать уничтожение версии. Максимальная длина строки в символах — 50.
                                  version_id string
                                  Обязательное поле. Идентификатор версии, которую следует уничтожить. Максимальная длина строки в символах — 50.
                                  pending_period google.protobuf.Duration
                                  Интервал времени между запросом на уничтожение версии и ее фактическим уничтожением. Значение по умолчанию: 7 дней.

                                  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<ScheduleVersionDestructionMetadata>
                                  Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Version>
                                  в случае успешного выполнения операции.

                                  ScheduleVersionDestructionMetadata

                                  Поле Описание
                                  secret_id string
                                  Идентификатор ключа, версия которого планируется к уничтожению.
                                  version_id string
                                  Идентификатор версии, которую планируется уничтожить.
                                  destroy_at google.protobuf.Timestamp
                                  Время уничтожения.

                                  Version

                                  Поле Описание
                                  id string
                                  Идентификатор версии.
                                  secret_id string
                                  Идентификатор секрета, которому принадлежит версия.
                                  created_at google.protobuf.Timestamp
                                  Время создания версии ключа.
                                  destroy_at google.protobuf.Timestamp
                                  Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                                  description string
                                  (опционально) Описание версии.
                                  status enum Status
                                  Статус секрета.
                                  • ACTIVE: Секрет активен и к нему можно получить доступ.
                                  • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                                  • DESTROYED: Версия уничтожена и не может быть восстановлена.
                                    payload_entry_keys[] string
                                    Ключи содержимого версии.

                                    CancelVersionDestruction

                                    Отменяет запланированное уничтожение версии, если версия еще не была уничтожена.

                                    rpc CancelVersionDestruction (CancelVersionDestructionRequest) returns (operation.Operation)

                                    Метаданные и результат операции:

                                        Operation.metadata:CancelVersionDestructionMetadata

                                        Operation.response:Version

                                    CancelVersionDestructionRequest

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

                                    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<CancelVersionDestructionMetadata>
                                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Version>
                                    в случае успешного выполнения операции.

                                    CancelVersionDestructionMetadata

                                    Поле Описание
                                    secret_id string
                                    Идентификатор секрета, уничтожение версии которого отменяется.
                                    version_id string
                                    Идентификатор версии, запланированное уничтожение которой отменяется.

                                    Version

                                    Поле Описание
                                    id string
                                    Идентификатор версии.
                                    secret_id string
                                    Идентификатор секрета, которому принадлежит версия.
                                    created_at google.protobuf.Timestamp
                                    Время создания версии ключа.
                                    destroy_at google.protobuf.Timestamp
                                    Время, когда версия ключа будет уничтожена. Пустой, если статус ACTIVE.
                                    description string
                                    (опционально) Описание версии.
                                    status enum Status
                                    Статус секрета.
                                    • ACTIVE: Секрет активен и к нему можно получить доступ.
                                    • SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению. Время, когда она будет уничтожена, указано в поле Version.destroy_at.
                                    • DESTROYED: Версия уничтожена и не может быть восстановлена.
                                      payload_entry_keys[] string
                                      Ключи содержимого версии.

                                      ListOperations

                                      Возвращает список операций для указанного секрета.

                                      rpc ListOperations (ListSecretOperationsRequest) returns (ListSecretOperationsResponse)

                                      ListSecretOperationsRequest

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

                                      ListSecretOperationsResponse

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

                                      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
                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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
                                      Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

                                      ListAccessBindings

                                      Возвращает список привязок прав доступа для указанного сертификата.

                                      rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

                                      ListAccessBindingsRequest

                                      Поле Описание
                                      resource_id string
                                      Обязательное поле. Идентификатор ресурса, для которого запрашивается список привязок прав доступа.
                                      Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Например, используйте запрос yandex.cloud.resourcemanager.v1.CloudService.List для получения идентификатора ресурса Cloud. Максимальная длина строки в символах — 50.
                                      page_size int64
                                      Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size, сервис вернет значение ListAccessBindingsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
                                      page_token string
                                      Токен страницы. Установите значение page_token равным значению поля ListAccessBindingsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                      ListAccessBindingsResponse

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

                                      AccessBinding

                                      Поле Описание
                                      role_id string
                                      Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject. Максимальная длина строки в символах — 50.
                                      subject Subject
                                      Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.

                                      Subject

                                      Поле Описание
                                      id string
                                      Обязательное поле.
                                      • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
                                      • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
                                      • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount, federatedUser или serviceAccount.
                                      Максимальная длина строки в символах — 50.
                                      type string
                                      Обязательное поле.
                                      • userAccount — аккаунт на Яндексе или Яндекс.Коннекте, добавленный в Яндекс.Облако.
                                      • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс yandex.cloud.iam.v1.ServiceAccount.
                                      • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
                                      • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.
                                      Максимальная длина строки в символах — 100.

                                      SetAccessBindings

                                      Устанавливает привязки прав доступа для секрета.

                                      rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

                                      Метаданные и результат операции:

                                          Operation.metadata:SetAccessBindingsMetadata

                                          Operation.response:google.protobuf.Empty

                                      SetAccessBindingsRequest

                                      Поле Описание
                                      resource_id string
                                      Обязательное поле. Идентификатор ресурса, для которого задается список привязок прав доступа.
                                      Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Максимальная длина строки в символах — 50.
                                      access_bindings[] AccessBinding
                                      Обязательное поле. Привязки прав доступа, которые будут установлены. Дополнительные сведения см. в разделе Привязка прав доступа.

                                      AccessBinding

                                      Поле Описание
                                      role_id string
                                      Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject. Максимальная длина строки в символах — 50.
                                      subject Subject
                                      Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.

                                      Subject

                                      Поле Описание
                                      id string
                                      Обязательное поле.
                                      • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
                                      • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
                                      • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount, federatedUser или serviceAccount.
                                      Максимальная длина строки в символах — 50.
                                      type string
                                      Обязательное поле.
                                      • userAccount — аккаунт на Яндексе или Яндекс.Коннекте, добавленный в Яндекс.Облако.
                                      • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс yandex.cloud.iam.v1.ServiceAccount.
                                      • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
                                      • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.
                                      Максимальная длина строки в символах — 100.

                                      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<SetAccessBindingsMetadata>
                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                      в случае успешного выполнения операции.

                                      SetAccessBindingsMetadata

                                      Поле Описание
                                      resource_id string
                                      Идентификатор ресурса, для которого задается список привязок прав доступа.

                                      UpdateAccessBindings

                                      Обновляет привязки прав доступа для секрета.

                                      rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

                                      Метаданные и результат операции:

                                          Operation.metadata:UpdateAccessBindingsMetadata

                                          Operation.response:google.protobuf.Empty

                                      UpdateAccessBindingsRequest

                                      Поле Описание
                                      resource_id string
                                      Обязательное поле. Идентификатор ресурса, для которого обновляется список привязок прав доступа. Максимальная длина строки в символах — 50.
                                      access_binding_deltas[] AccessBindingDelta
                                      Обязательное поле. Изменения в список привязок прав доступа. Количество элементов должно быть больше 0.

                                      AccessBindingDelta

                                      Поле Описание
                                      action enum AccessBindingAction
                                      Обязательное поле. Действие, которое надо выполнить с привязкой прав доступа.
                                      • ADD: Добавление новой привязки прав доступа.
                                      • REMOVE: Удаление привязки прав доступа.
                                        access_binding AccessBinding
                                        Обязательное поле. Привязка прав доступа. Дополнительные сведения см. в разделе Привязка прав доступа.

                                        AccessBinding

                                        Поле Описание
                                        role_id string
                                        Обязательное поле. Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject. Максимальная длина строки в символах — 50.
                                        subject Subject
                                        Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.

                                        Subject

                                        Поле Описание
                                        id string
                                        Обязательное поле.
                                        • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
                                        • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
                                        • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount, federatedUser или serviceAccount.
                                        Максимальная длина строки в символах — 50.
                                        type string
                                        Обязательное поле.
                                        • userAccount — аккаунт на Яндексе или Яндекс.Коннекте, добавленный в Яндекс.Облако.
                                        • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс yandex.cloud.iam.v1.ServiceAccount.
                                        • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
                                        • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.
                                        Максимальная длина строки в символах — 100.

                                        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<UpdateAccessBindingsMetadata>
                                        Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
                                        в случае успешного выполнения операции.

                                        UpdateAccessBindingsMetadata

                                        Поле Описание
                                        resource_id string
                                        Идентификатор ресурса, для которого обновляется список привязок прав доступа.
                                        В этой статье: