Managing access to DataLens

Access to Yandex DataLens is regulated by assigning permissions:

• To a DataLens instance at the enterprise level: using the organization's service.
• To a DataLens instance at the cloud folder level: via the Yandex Cloud console.

To grant a user access, assign them a DataLens role.

DataLens access control is implemented at the object and the folder level.
You can grant users permission to each object and directory. They determine which operations are allowed. If you created or copied a directory or object, they will have the same permissions as their new parent folder.

You can grant users access to a directory or any service object:

• Connection
• Datasets
• Charts
• Dashboards

Users can also request permissions on their own via the request form. For more information, see Request permissions.

User roles

Roles enable you define user permissions in a DataLens instance.

User roles are assigned:

• To a DataLens instance at the enterprise level: using the organization's service.
• To a DataLens instance at the cloud folder level: via the Yandex Cloud console.

datalens.creator

The datalens.creator role provides access to DataLens with a permission to create objects. The user can view or edit objects if they have the relevant roles.

The role does not provide the permission to view folders in the cloud.

After you assign a service role, you can grant the user permissions to objects and directories in DataLens.

datalens.admin

This datalens.admin role allows you to access DataLens as a DataLens instance administrator. Administrators are granted permissions to all objects and directories in DataLens.

The role does not provide the permission to view folders in the cloud.

After you assign a service role, you can grant the user permissions to objects and directories in DataLens.

datalens.instances.user

The datalens.instances.user role provides access to DataLens.

After you assign a service role, you can grant the user permissions to objects and directories in DataLens.
For more information about managing access to DataLens, see Managing access to DataLens.

Currently, this role can only be assigned for working with a folder or a cloud.

datalens.instances.admin

This datalens.instances.admin role allows you to access DataLens as a DataLens instance administrator. Administrators are granted permissions to all objects and directories in DataLens.

An administrator has datalens.instances.user permissions. They have access to DataLens settings.

After you assign a service role, you can grant the user permissions to objects and directories in DataLens.

Currently, this role can only be assigned for working with a folder or a cloud.

Adding a user

You can add users with a Yandex account as well as federated users.

Add a user with a Yandex account

To add a user and grant them access to DataLens:

Add federated users

To add federated users, you need to know the users' Name IDs returned by the Identity Provider (IdP) server with the successful authentication response. This is usually the user's primary email address. If you don't know what the server returns as the Name ID, contact the administrator who configured authentication for your federation.

Add federated users to an organization

To add federated users to an organization and grant them access to DataLens:

1. Add federated users:

   Management console

   CLI

   API

   1. Make sure you are authorized in Yandex Cloud as an administrator or owner of the organization (your user holds the admin or owner role for the organization). In the top left-hand corner, click and select Resources and management → Manage organization services or click the link.
   2. In the top-right corner, click the arrow next to the Add user button. Select Add federated users.
   3. Select the identity federation to add users from.
   4. List the Name IDs of users, separating them with line breaks.
   5. Click Add. This will give the users access to the organization.

   If you don't have the Yandex Cloud command line interface yet, install and initialize it.

   The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

   1. View a description of the add user command:

      yc organization-manager federation saml add-user-accounts --help
      

   2. Add users by listing their Name IDs separated by a comma:

      yc organization-manager federation saml add-user-accounts --name my-federation \
        --name-ids=alice@example.com,bob@example.com,charlie@example.com
      

   1. Create a file with the request body, e.g., body.json. In the request body, specify the array of Name IDs of users you want to add:

      {
        "nameIds": [
          "alice@example.com",
          "bob@example.com",
          "charlie@example.com"
        ]
      }
      

   2. Send the request by specifying the Federation ID in the parameters:

      $ curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer <IAM token>" \
        -d '@body.json' \
        https://organization-manager.api.cloud.yandex.net/organization-manager/v1/saml/federations/<federation ID>:addUserAccounts
      

2. Assign roles to users for DataLens access:

   1. Open the list of user roles:

      1. On the left-hand panel, select a cloud.
      2. Go to Access rights.
      3. Find the required user in the list. Assigned roles are specified in the Roles column.

   2. In the Configure access rights window, click Add role. Choose the datalens.instances.user role from the list.

   3. Click Save. The user will gain access to DataLens.

Add federated users to a cloud

To add federated users to a cloud and grant them access to DataLens:

1. Add federated users:

   Management console

   CLI

   API

   To add identity federation users to the cloud:

   1. Open the Users and roles page for the selected cloud. If necessary, switch to another cloud.

   2. Click the arrow next to the Add user button.
   3. Select Add federated users.
   4. Select the identity federation to add users from.
   5. List the Name IDs of users, separating them with line breaks.

   If you don't have the Yandex Cloud command line interface yet, install and initialize it.

   The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

   1. View a description of the add user command:

      yc iam federation add-user-accounts --help
      

   2. Add users by listing their Name IDs separated by a comma:

      yc iam federation add-user-accounts --name my-federation \
        --name-ids=alice@example.com,bob@example.com,charlie@example.com
      

   To add identity federation users to the cloud:

   1. Create a file with the request body (for example, body.json). In the request body, specify the array of Name IDs of users you want to add:

      {
        "nameIds": [
          "alice@example.com",
          "bob@example.com",
          "charlie@example.com"
        ]
      }
      

   2. Send the request by specifying the Federation ID in the parameters:

      curl -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer <IAM token>" \
        -d '@body.json' \
        https://iam.api.cloud.yandex.net/iam/v1/saml/federations/<federation ID>:addUserAccounts
      

2. Open the list of user roles:

   1. On the left-hand panel, select a cloud.
   2. Go to Access rights.
   3. Find the required user in the list. Assigned roles are specified in the Roles column.

3. To add a cloud role, click in the Roles for cloud section.

   To add a role for a folder, select the folder and click Assign role in the Roles for folders section.

4. Choose datalens.instances.user from the list.

For more information about assigning roles in Yandex Cloud, see Roles.

Object permissions

Permissions can be assigned to individual users or the All group that includes users who passed authentication.

You can assign the following permissions to objects and directories in DataLens:

• Execute
• Read
• Write
• Admin

Execute

A user with the Execute permission for a connection can make requests to it, but can't create datasets. Regardless of dataset permissions, the user can't access a list of tables in a dataset or view the SQL subquery that the dataset is based on.

A user with Execute access to a dataset can run queries against the dataset but is unable to create or edit charts or view the dataset.

Granting users the Execute permission lets you:

• Reduce the number of requests to the source, thereby reducing the load on the connection source.

• Better control what data can be shown from a dataset. You can hide some source fields so that users can't view all fields.

• Restrict the creation of subqueries to the source database. A user with the Execute permission can't write subqueries.

Read

A user with the Read permission can view dashboards, widgets, datasets, and directories.

Write

A user with the Write permission can edit dashboards, widgets, connections, datasets, and directories.

The Write permission includes everything included in the Read permission.

Admin

A user with the Admin permission can edit available objects and directories, as well as change permissions.

The Admin permission includes everything included in the Write permission.

Table of permissions

Access object Action	Execute	Read	Write	Admin
Directory
View directories	N/A
Edit a directory	N/A
Delete directories	N/A
Edit permissions	N/A
Connection
Make requests to a connection
Create a dataset over a connection
View connection parameters
Edit connections
Delete connections
Edit permissions
Datasets
Make requests to a dataset
Create a chart on a dataset
View a dataset
Edit a dataset
Deleting datasets
Edit permissions
Chart
View charts	N/A
Editing charts	N/A
Delete charts	N/A
Edit permissions	N/A
Grant public access	N/A
Dashboard
View dashboards	N/A
Editing dashboards	N/A
Deleting dashboards	N/A
Edit permissions	N/A
Grant public access	N/A

Object access audit

A DataLens user can get access logs for DataLens objects (view, edit, delete).
To retrieve logs, please contact technical support.

What's next

• Granting permissions in DataLens
• Deleting permissions
• Request permissions
• Managing access to data rows in a dataset