Creating a service agent

Written by

Updated at April 11, 2025

With a service agent, you will be able to work with other services, e.g., refresh your authorization tokens for DataSphere notebooks.

A service agent is a special service account under which DataSphere projects will perform actions in other Yandex Cloud services. Once enabled in a community, a service agent will be available for all the projects in that community.

You can also manage a service agent from DataSphere Jobs.

Note

To enable a service agent in a DataSphere community, you need the datasphere.communities.editor role or higher.

You need the admin or owner role for the cloud to manage service access to resources.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

To allow a service agent to operate in DataSphere, ask your cloud admin or owner to run the following command in the Yandex Cloud CLI:
```
yc iam service-control enable datasphere --cloud-id <cloud_ID>
```
Where --cloud-id is the ID of the cloud you are going to use in the DataSphere community.
Create a service account and assign to it the roles required to use the selected service. For more information about the required roles, see Access management for the service in question.

To send requests to nodes from a notebook, assign the datasphere.user role to the service account.
Open the DataSphere home page. In the left-hand panel, select Communities.
Select the community you want to create a service agent for.
Go to the Settings tab.
Under Service agent, click Add service account.
In the window that opens, select the service account and click Add.

Note

To manage a community via the API, add the service account to the community member list. To send requests to a node from a notebook or access a project via the API, add the service account to the community and project member lists.

Creating a service agent

Was the article helpful?