Access management in Yandex Search API
In this section, you will learn:
Access management
Yandex Identity and Access Management checks all transactions in Yandex Cloud. If an entity does not have required permissions, this service returns an error.
To grant permissions for a resource, assign the appropriate resource roles to an entity performing operations, such as a Yandex account, service account, federated users, user group, system group, or public group. For more information, see How access management works in Yandex Cloud.
Which resources you can assign a role for
You can assign a role to an organization, cloud, or folder. The roles assigned to organizations, clouds, and folders also apply to their nested resources.
Which roles exist in the service
Service roles
search-api.executor
The search-api.executor
role enables using Yandex Search API and running search queries via API v1.
search-api.webSearch.user
The search-api.webSearch.user
role enables running search queries in Yandex Search API via API v2, as well as viewing info on the cloud, folder, and Yandex Search API quotas.
search-api.auditor
The search-api.auditor
role enables viewing info on the registered IP addresses and Yandex Search API quotas, as well as on the relevant clouds and folders.
search-api.viewer
The search-api.viewer
role enables viewing info on the registered IP addresses and Yandex Search API quotas, as well as on the relevant clouds and folders.
This role also includes the search-api.auditor
permissions.
search-api.editor
The search-api.editor
role enables managing registered IP addresses and running search queries in Yandex Search API via API v1 and API v2.
Users with this role can:
- View info on the registered IP addresses, edit and delete them, and register new IP addresses.
- Run search queries using API v1 and API v2.
- View info on Yandex Search API quotas.
- View info on the relevant clouds and folders.
This role also includes the search-api.viewer
, search-api.webSearch.user
, and search-api.executor
permissions.
search-api.admin
The search-api.admin
role enables managing registered IP addresses and running search queries in Yandex Search API via API v1 and API v2.
Users with this role can:
- View info on the registered IP addresses, edit and delete them, and register new IP addresses.
- Run search queries using API v1 and API v2.
- View info on Yandex Search API quotas.
- View info on the relevant clouds and folders.
This role also includes the search-api.editor
permissions.
Primitive roles
Primitive roles allow users to perform actions in all Yandex Cloud services.
auditor
The auditor
role grants a permission to read configuration and metadata of any Yandex Cloud resources without any access to data.
For instance, users with this role can:
- View info on a resource.
- View the resource metadata.
- View the list of operations with a resource.
auditor
is the most secure role that does not grant any access to the service data. This role suits the users who need minimum access to the Yandex Cloud resources.
viewer
The viewer
role grants the permissions to read the info on any Yandex Cloud resources.
This role also includes the auditor
permissions.
Unlike auditor
, the viewer
role provides access to service data in read mode.
editor
The editor
role provides permissions to manage any Yandex Cloud resources, except for assigning roles to other users, transferring organization ownership, removing an organization, and deleting Key Management Service encryption keys.
For instance, users with this role can create, modify, and delete resources.
This role also includes the viewer
permissions.
admin
The admin
role enables assigning any roles, except for resource-manager.clouds.owner
and organization-manager.organizations.owner
, and provides permissions to manage any Yandex Cloud resources (except for transferring organization ownership and removing an organization).
Prior to assigning the admin
role for an organization, cloud, or billing account, make sure to check out the information on protecting privileged accounts.
This role also includes the editor
permissions.
Instead of primitive roles, we recommend using service roles with more granular access control, allowing you to implement the least privilege principle.
For more information about primitive roles, see the Yandex Cloud role reference.