Some methods and properties available within the hooks require special permissions to be accessed, as they may cause security issues.

If a plugin wants to access these additional features, it must request specific permissions. When installing the plugin, the user must explicitly grant these permissions, otherwise the installation process will be aborted:

Available permissions

At the moment, only one special permit is available, but in the future more may be added.

currentUserAccessToken

This permission makes the ctx.currentUserAccessToken property available. This token represents the currently logged in user, and you can use it to make API calls to the Content Management API on behalf of that user.

1
import { SiteClient } from 'datocms-client';
2
import { useMemo, useEffect } from 'react';
3

4
connect({
5
  renderPage(pageId, { ctx }) {
6
    const client = useMemo(() => {
7
      return new SiteClient(
8
        ctx.currentUserAccessToken,
9
        { environment: ctx.environment },
10
      );
11
    }, [ctx.currentUserAccessToken]);
12

13
    useEffect(async () => {
14
      const someRecords = await client.items.all();
15
    }, []);
16

17
    // ...
18
  },
19
});

Specifying additional permissions

Private plugins

During the creation of a plugin, it is possible to specify the additional permissions the plugin requires:

Marketplace plugins

Public plugins must declare their additional permissions inside the datocmsPlugin.permission key in their package.json file:

1
{
2
  "name": "datocms-plugin-foobar",
3
  "version": "0.1.0",
4
  "dependencies": {
5
    // ...
6
  },
7
  "datoCmsPlugin": {
8
    "title": "Foobar",
9
    // ...
10
    "permissions": ["currentUserAccessToken"]
11
  }
12
}

For more information regarding how to publish a plugin in the Marketplace, see here.