Access management in Yandex StoreDoc
In this section, you will learn about:
- Resources you can assign a role for.
- What roles this service has.
- Roles required for specific actions.
Access management
Yandex Identity and Access Management checks all operations in Yandex Cloud. If an entity does not have required permissions, IAM returns an error.
To grant permissions for a resource, assign the relevant resource roles to an entity performing operations. You can assign roles to a Yandex account, service account, local user, federated user, user group, system group, or public group. For more information, see How access management works in Yandex Cloud.
To assign a role for a resource, a user should have the mdb.admin role, managed-mongodb.admin role, or one of the following roles for that resource:
adminresource-manager.adminorganization-manager.adminresource-manager.clouds.ownerorganization-manager.organizations.owner
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.
To allow access to service resources (DB clusters and hosts, cluster backups, databases and their users), assign the user the appropriate roles for the folder, cloud, or organization containing these resources.
Roles existing in this service
The chart below shows the roles existing in the service and their permission inheritance. For example, editor inherits all the viewer permissions. You can find the role descriptions below the chart.
Service roles
managed-mongodb.auditor
The managed-mongodb.auditor role allows you to view information about Yandex StoreDoc hosts and clusters, as well as quotas and resource operations for Yandex StoreDoc.
managed-mongodb.viewer
The managed-mongodb.viewer role allows you to view information about clusters, hosts, shards, databases, Yandex StoreDoc users, cluster logs, as well as about quotas and service resource operations.
Users with this role can:
- View information about Yandex StoreDoc clusters.
- View information about Yandex StoreDoc cluster hosts.
- View information about Yandex StoreDoc cluster shards.
- View information about Yandex StoreDoc databases.
- View information about Yandex StoreDoc users.
- View information about Yandex StoreDoc cluster backups.
- View information about Yandex StoreDoc alerts.
- View Yandex StoreDoc cluster logs.
- View information about the results of Yandex StoreDoc cluster performance diagnostics.
- View information about quotas of Yandex StoreDoc.
- View information about resource operations for Yandex StoreDoc.
This role includes the managed-mongodb.auditor permissions.
managed-mongodb.restorer
The managed-mongodb.restorer role allows you to restore Yandex StoreDoc clusters from backups, view information about clusters, hosts, shards, databases, Yandex StoreDoc users, cluster logs, as well as about quotas and service resource operations.
Users with this role can:
- View information about Yandex StoreDoc cluster backups and restore clusters from backups.
- View information about Yandex StoreDoc clusters.
- View information about Yandex StoreDoc cluster hosts.
- View information about Yandex StoreDoc cluster shards.
- View information about Yandex StoreDoc databases.
- View information about Yandex StoreDoc users.
- View information about Yandex StoreDoc alerts.
- View Yandex StoreDoc cluster logs.
- View information about the results of Yandex StoreDoc cluster performance diagnostics.
- View information about quotas of Yandex StoreDoc.
- View information about resource operations for Yandex StoreDoc.
This role includes the managed-mongodb.viewer permissions.
managed-mongodb.editor
The managed-mongodb.editor role allows you to manage Yandex StoreDoc clusters and view their logs, as well as get information about quotas and service resource operations.
Users with this role can:
- Create, modify, delete, run and stop Yandex StoreDoc clusters and view information about them.
- Create, modify, and delete Yandex StoreDoc cluster hosts and view information about them.
- Create and delete Yandex StoreDoc cluster shards and view information about them.
- Create and delete Yandex StoreDoc databases and view information about them.
- Create, modify, and delete Yandex StoreDoc users and view information about them.
- Create Yandex StoreDoc cluster backups, view information about such backups, as well as restore clusters from backups.
- Create, modify, and delete Yandex StoreDoc alerts and view information about them.
- View Yandex StoreDoc cluster logs.
- View information about the results of Yandex StoreDoc cluster performance diagnostics.
- View information about quotas of Yandex StoreDoc.
- View information about resource operations for Yandex StoreDoc.
This role includes the managed-mongodb.viewer and managed-mongodb.restorer permissions.
To create Yandex StoreDoc clusters, you also need the vpc.user role.
managed-mongodb.admin
The managed-mongodb.admin role allows you to manage Yandex StoreDoc clusters and view their logs, as well as get information about quotas and service resource operations.
Users with this role can:
- Manage access to Yandex StoreDoc clusters.
- Create, modify, delete, run, and stop Yandex StoreDoc clusters and view information about them.
- Create, modify, and delete Yandex StoreDoc cluster hosts and view information about them.
- Create and delete Yandex StoreDoc cluster shards and view information about them.
- Create and delete Yandex StoreDoc databases and view information about them.
- Create, modify, and delete Yandex StoreDoc users and view information about them.
- Create Yandex StoreDoc cluster backups, view information about such backups, as well as restore clusters from backups.
- Create, modify, and delete Yandex StoreDoc alerts and view information about them.
- View Yandex StoreDoc cluster logs.
- View information about the results of Yandex StoreDoc cluster performance diagnostics.
- View information about quotas of Yandex StoreDoc.
- View information about resource operations for Yandex StoreDoc.
This role includes the managed-mongodb.editor permissions.
To create Yandex StoreDoc clusters, you also need the vpc.user role.
mdb.auditor
The mdb.auditor role grants the minimum permissions required to view information about managed database clusters (without access to data or runtime logs).
Users with this role can view information about managed database clusters, quotas, and folders.
This role includes the managed-opensearch.auditor, managed-kafka.auditor, managed-mysql.auditor, managed-sqlserver.auditor, managed-postgresql.auditor, managed-greenplum.auditor, managed-clickhouse.auditor, managed-redis.auditor, and managed-mongodb.auditor permissions.
mdb.viewer
The mdb.viewer role grants read access to managed database clusters and cluster runtime logs.
Users with this role can read from databases, inspect the logs of managed database clusters, and view information about clusters, quotas, and folders.
This role includes the mdb.auditor, managed-opensearch.viewer, managed-kafka.viewer, managed-mysql.viewer, managed-sqlserver.viewer, managed-postgresql.viewer, managed-greenplum.viewer, managed-clickhouse.viewer, managed-redis.viewer, managed-mongodb.viewer, and dataproc.viewer permissions.
mdb.admin
The mdb.admin role grants full access to managed database clusters.
Users with this role can create, edit, delete, run, and stop managed database clusters, manage cluster access, create cluster backups and restore clusters from such backups, read and write to databases, and view information about clusters, runtime logs, quotas, and folders.
This role includes the mdb.viewer, vpc.user, managed-opensearch.admin, managed-kafka.admin, managed-mysql.admin, managed-sqlserver.admin, managed-postgresql.admin, managed-greenplum.admin, managed-clickhouse.admin, managed-redis.admin, managed-mongodb.admin, and dataproc.admin permissions.
mdb.restorer
The mdb.restorer role enables restoring managed database clusters from backups and grants read access to clusters and cluster runtime logs.
Users with this role can restore managed database clusters from backups, read from databases, inspect cluster logs, and view information about clusters, quotas, and folders.
This role includes the mdb.viewer, managed-elasticsearch.restorer, managed-opensearch.restorer, managed-kafka.restorer, managed-mysql.restorer, managed-sqlserver.restorer, managed-postgresql.restorer, managed-spqr.restorer, managed-greenplum.restorer, managed-clickhouse.restorer, managed-redis.restorer, and managed-mongodb.restorer permissions.
vpc.publicAdmin
The vpc.publicAdmin role allows you to manage NAT gateways, public IP addresses, and external network connectivity, as well as view information on the quotas, resources, and resource operations. This role grants administrator privileges for multi-interface instances that provide connectivity between multiple networks.
Users with this role can:
- View the list of cloud networks and info on them, as well as set up external access to them.
- Manage connectivity of multiple cloud networks.
- Manage multi-interface instances that provide connectivity between multiple networks.
- View the list of subnets and info on them, as well as modify them.
- View information on NAT gateways, as well as create, modify, and delete them.
- View the list of cloud resource addresses and info on them, as well as create, update, and delete public IP addresses.
- View the list of route tables and info on them, as well as link them to subnets.
- View the list of security groups and the info on them.
- View information on the IP addresses used in subnets.
- View information on Virtual Private Cloud quotas.
- View information on resource operations for Virtual Private Cloud.
- View information on resource operations for Compute Cloud.
- View information on the relevant cloud.
- View info on the relevant folder.
This role includes the vpc.viewer permissions.
You can assign a role for a cloud or folder.
Warning
If a network and subnet are in different folders, the vpc.publicAdmin role is checked for the folder where the network is located.
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 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 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 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.
What roles are required
To use Managed Service for Apache Airflow™, you need the managed-mongodb.editor role or higher for the folder to house the new cluster. The managed-mongodb.viewer role only allows you to view the list of clusters.
To create a Yandex StoreDoc cluster, you need the vpc.user role and the managed-mongodb.editor role or higher.
You can always assign a role with more permissions. For example, you can assign the managed-mongodb.admin role instead of managed-mongodb.editor.