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

Метод setAccessBindings

Задает список привязок прав доступа для указанного API-шлюза.

HTTP-запрос

POST https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways/{resourceId}:setAccessBindings

Path-параметры

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

Параметры в теле запроса

{
  "accessBindings": [
    {
      "roleId": "string",
      "subject": {
        "id": "string",
        "type": "string"
      }
    }
  ]
}
Поле Описание
accessBindings[] object

Обязательное поле. Привязки прав доступа, которые будут установлены. Дополнительные сведения см. в разделе Привязка прав доступа.
accessBindings[].
roleId		 string

Обязательное поле. Идентификатор ресурса Role который назначен для субъекта, указанного в параметре subject.

Максимальная длина строки в символах — 50.
accessBindings[].
subject		 object

Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.
accessBindings[].
subject.
id		 string

Обязательное поле. Идентификатор субъекта.

Может иметь одно из значений:

  • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
  • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
  • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount, federatedUser или serviceAccount.

Максимальная длина строки в символах — 50.
accessBindings[].
subject.
type		 string

Обязательное поле. Тип субъекта.

Может иметь одно из значений:

  • userAccount — аккаунт на Яндексе или Яндекс.Коннекте, добавленный в Яндекс.Облако.
  • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс ServiceAccount.
  • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
  • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.

Дополнительные сведения см. в разделе Субъект, которому назначается роль.

Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

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

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле Описание
id string

Идентификатор операции.
description string

Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

Строка в формате RFC3339.
createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.
done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.
error.
code		 integer (int32)

Код ошибки. Значение из списка google.rpc.Code.
error.
message		 string

Текст ошибки.
error.
details[]		 object

Список сообщений с подробными сведениями об ошибке.
response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье: