Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Managed Service for Elasticsearch
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к кластеру
    • Остановка и запуск кластера
    • Изменение настроек кластера
    • Изменение версии и редакции Elasticsearch
    • Настройка SAML-аутентификации
    • Настройка доступа к Object Storage
    • Управление хостами Elasticsearch
    • Управление плагинами Elasticsearch
    • Управление расширениями Elasticsearch
    • Управление пользователями Elasticsearch
    • Управление резервными копиями
    • Просмотр логов кластера
    • Удаление кластера
    • Мониторинг состояния кластера и хостов
  • Практические руководства
    • Все руководства
    • Миграция в Managed Service for Elasticsearch с помощью снапшотов
    • Миграция данных из стороннего кластера Elasticsearch с помощью Reindex API
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Роли хостов
    • Редакции Elasticsearch
    • Индексы
    • Поиск с помощью Elasticsearch
    • Классы хостов
    • Сеть в Managed Service for Elasticsearch
    • Квоты и лимиты
    • Типы дисков
    • Резервные копии
    • Шардирование и репликация
    • Поддержка словарей
    • Политика управления версиями Elasticsearch
    • Настройки Elasticsearch
    • Техническое обслуживание
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • AuthService
      • BackupService
      • ClusterService
      • ExtensionService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST (англ.)
      • Overview
      • Auth
        • Overview
        • addProviders
        • deleteProvider
        • deleteProviders
        • getProvider
        • listProviders
        • updateProvider
        • updateProviders
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • backup
        • create
        • delete
        • deleteHosts
        • get
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • move
        • rescheduleMaintenance
        • restore
        • start
        • stop
        • streamLogs
        • update
      • Extension
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • Operation
        • Overview
        • get
  • История изменений
  • Вопросы и ответы
    • Общие вопросы
  1. Справочник API
  2. REST (англ.)
  3. Auth
  4. updateProviders

Managed Service for Elasticsearch API, REST: Auth.updateProviders

Статья создана
Yandex Cloud
  • HTTP request
  • Path parameters
  • Body parameters
  • Response

Replase the list of auth providers.

HTTP request

PUT https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/auth/providers

Path parameters

Parameter Description
clusterId

Required. Required. ID of the ElasticSearch cluster.

The maximum string length in characters is 50.

Body parameters

{
  "providers": [
    {
      "type": "string",
      "name": "string",
      "order": "string",
      "enabled": true,
      "hidden": true,
      "description": "string",
      "hint": "string",
      "icon": "string",
      "saml": {
        "idpEntityId": "string",
        "idpMetadataFile": "string",
        "spEntityId": "string",
        "kibanaUrl": "string",
        "attributePrincipal": "string",
        "attributeGroups": "string",
        "attributeName": "string",
        "attributeEmail": "string",
        "attributeDn": "string"
      }
    }
  ]
}
Field Description
providers[] object

Required. List of providers to set.

The maximum number of elements is 10.

providers[].
type
string
providers[].
name
string

The maximum string length in characters is 50. Value must match the regular expression [a-z][a-z0-9_-]*.

providers[].
order
string (int64)
providers[].
enabled
boolean (boolean)
providers[].
hidden
boolean (boolean)

selector ui settings

providers[].
description
string

The maximum string length in characters is 50.

providers[].
hint
string

The maximum string length in characters is 250.

providers[].
icon
string

The maximum string length in characters is 250.

providers[].
saml
object
providers[].
saml.
idpEntityId
string

The maximum string length in characters is 250.

providers[].
saml.
idpMetadataFile
string (byte)

The maximum string length in characters is 10000.

providers[].
saml.
spEntityId
string

The maximum string length in characters is 250.

providers[].
saml.
kibanaUrl
string

The maximum string length in characters is 250.

providers[].
saml.
attributePrincipal
string

The maximum string length in characters is 50.

providers[].
saml.
attributeGroups
string

The maximum string length in characters is 50.

providers[].
saml.
attributeName
string

The maximum string length in characters is 50.

providers[].
saml.
attributeEmail
string

The maximum string length in characters is 50.

providers[].
saml.
attributeDn
string

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.

description string

Description of the operation. 0-256 characters long.

createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy string

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

modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done boolean (boolean)

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

metadata object

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

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

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

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

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Path parameters
  • Body parameters
  • Response