Управление доступом в API Gateway

Пользователь Yandex Cloud может выполнять только те операции над ресурсами, которые разрешены назначенными ему ролями. Пока у пользователя нет никаких ролей, почти все операции ему запрещены.

Чтобы разрешить доступ к ресурсам сервиса API Gateway (API-шлюзам), назначьте аккаунту на Яндексе, сервисному аккаунту, федеративным пользователям, группе пользователей, системной группе или публичной группе нужные роли из приведенного ниже списка. На данный момент роль может быть назначена на родительский ресурс (каталог или облако) и на организацию.

Об управлении доступомОб управлении доступом

Все операции в Yandex Cloud проверяются в сервисе Yandex Identity and Access Management. Если у субъекта нет необходимых разрешений, сервис вернет ошибку.

Чтобы выдать разрешения к ресурсу, назначьте роли на этот ресурс субъекту, который будет выполнять операции. Роли можно назначить аккаунту на Яндексе, сервисному аккаунту, федеративным пользователям, группе пользователей, системной группе или публичной группе. Подробнее читайте в разделе Как устроено управление доступом в Yandex Cloud.

Назначать роли на ресурс могут пользователи, у которых на этот ресурс есть роль api-gateway.admin или одна из следующих ролей:

• admin;
• resource-manager.admin;
• organization-manager.admin;
• resource-manager.clouds.owner;
• organization-manager.organizations.owner.

Назначение ролейНазначение ролей

Чтобы назначить пользователю роль на облако:

1. При необходимости добавьте нужного пользователя.
2. В консоли управления слева выберите облако.
3. Перейдите на вкладку Права доступа.
4. Нажмите кнопку Настроить доступ.
5. В открывшемся окне выберите раздел Пользовательские аккаунты.
6. Выберите пользователя из списка или воспользуйтесь поиском.
7. Нажмите кнопку Добавить роль и выберите роль в облаке.
8. Нажмите кнопку Сохранить.

Подробнее о назначении ролей см. в документации сервиса Yandex Identity and Access Management.

На какие ресурсы можно назначить рольНа какие ресурсы можно назначить роль

Роль можно назначить на организацию, облако и каталог. Роли, назначенные на организацию, облако или каталог, действуют и на вложенные ресурсы.

На API-шлюз роль можно назначить через Yandex Cloud CLI или API.

Какие роли действуют в сервисеКакие роли действуют в сервисе

Ниже перечислены все роли, которые учитываются при проверке прав доступа в сервисе API Gateway.

Сервисные ролиСервисные роли

api-gateway.auditorapi-gateway.auditor

Роль api-gateway.auditor позволяет просматривать список API-шлюзов и информацию о назначенных правах доступа к ним, а также метаинформацию каталога.

api-gateway.viewerapi-gateway.viewer

Роль api-gateway.viewer позволяет просматривать список API-шлюзов, информацию о них и о назначенных правах доступа к ним, а также информацию о каталоге.

Включает разрешения, предоставляемые ролью api-gateway.auditor.

api-gateway.editorapi-gateway.editor

Роль api-gateway.editor позволяет просматривать информацию об API-шлюзах и управлять ими, а также работать с API WebSocket.

Пользователи с этой ролью могут:

• просматривать список API-шлюзов, информацию о них и о назначенных правах доступа к ним, а также создавать, изменять и удалять API-шлюзы;
• использовать ограничение скорости обработки запросов;
• просматривать информацию о соединениях WebSocket и закрывать их, а также отправлять данные через такие соединения;
• просматривать информацию о каталоге.

Включает разрешения, предоставляемые ролью api-gateway.websocketWriter.

api-gateway.websocketWriterapi-gateway.websocketWriter

Роль api-gateway.websocketWriter позволяет работать с API WebSocket, а также просматривать список API-шлюзов, информацию о них и о назначенных правах доступа к ним.

Пользователи с этой ролью могут:

• просматривать информацию о соединениях WebSocket и закрывать их, а также отправлять данные через такие соединения;
• просматривать список API-шлюзов, информацию о них и о назначенных правах доступа к ним;
• просматривать информацию о каталоге.

Включает разрешения, предоставляемые ролью api-gateway.viewer.

api-gateway.websocketBroadcasterapi-gateway.websocketBroadcaster

Роль api-gateway.websocketBroadcaster позволяет отправлять данные через соединения WebSocket, в том числе одновременно нескольким клиентам, а также просматривать список API-шлюзов, информацию о них и о назначенных правах доступа к ним.

Пользователи с этой ролью могут:

• просматривать информацию о соединениях WebSocket и закрывать их, а также отправлять данные через соединения WebSocket, в том числе одновременно нескольким клиентам;
• просматривать список API-шлюзов, информацию о них и о назначенных правах доступа к ним;
• просматривать информацию о каталоге.

Включает разрешения, предоставляемые ролью api-gateway.websocketWriter.

api-gateway.adminapi-gateway.admin

Роль api-gateway.admin позволяет управлять API-шлюзами и доступом к ним, просматривать информацию об API-шлюзах, а также работать с API WebSocket.

Пользователи с этой ролью могут:

• просматривать информацию о назначенных правах доступа к API-шлюзам и изменять такие права доступа;
• просматривать список API-шлюзов и информацию о них, а также создавать, изменять и удалять API-шлюзы;
• просматривать информацию о соединениях WebSocket и закрывать их, а также отправлять данные через такие соединения;
• использовать ограничение скорости обработки запросов;
• просматривать информацию о каталоге.

Включает разрешения, предоставляемые ролью api-gateway.editor.

Примитивные ролиПримитивные роли

Примитивные роли позволяют пользователям совершать действия во всех сервисах Yandex Cloud.

auditorauditor

Роль auditor предоставляет разрешения на чтение конфигурации и метаданных любых ресурсов Yandex Cloud без возможности доступа к данным.

Например, пользователи с этой ролью могут:

• просматривать информацию о ресурсе;
• просматривать метаданные ресурса;
• просматривать список операций с ресурсом.

Роль auditor — наиболее безопасная роль, исключающая доступ к данным сервисов. Роль подходит для пользователей, которым необходим минимальный уровень доступа к ресурсам Yandex Cloud.

viewerviewer

Роль viewer предоставляет разрешения на чтение информации о любых ресурсах Yandex Cloud.

Включает разрешения, предоставляемые ролью auditor.

В отличие от роли auditor, роль viewer предоставляет доступ к данным сервисов в режиме чтения.

editoreditor

Роль editor предоставляет разрешения на управление любыми ресурсами Yandex Cloud, кроме назначения ролей другим пользователям, передачи прав владения организацией и ее удаления, а также удаления ключей шифрования Key Management Service.

Например, пользователи с этой ролью могут создавать, изменять и удалять ресурсы.

Включает разрешения, предоставляемые ролью viewer.

adminadmin

Роль admin позволяет назначать любые роли, кроме resource-manager.clouds.owner и organization-manager.organizations.owner, а также предоставляет разрешения на управление любыми ресурсами Yandex Cloud, кроме передачи прав владения организацией и ее удаления.

Прежде чем назначить роль admin на организацию, облако или платежный аккаунт, ознакомьтесь с информацией о защите привилегированных аккаунтов.

Включает разрешения, предоставляемые ролью editor.

Вместо примитивных ролей мы рекомендуем использовать роли сервисов. Такой подход позволит более гранулярно управлять доступом и обеспечить соблюдение принципа минимальных привилегий.

Подробнее о примитивных ролях см. в справочнике ролей Yandex Cloud.