This plugin is to have persistent permissions in different environments regarding api interaction.
- Install using
npm install @gravitybv/strapi-plugin-permissions
in the root of your Strapi project.
If you dont have access to the @gravitybv
scope you need to do the following:
- First you will need a personal access token (PAT)
- Create a toke with
repo
andread:packages
scopes selected. Make sure to store this somehwere - Run
npm login --registry=https://npm.pkg.github.com --scope=gravitybv
- Login with your github username and use the PAT as password
- Now you should be able to install this package in other projects
Enable in config/plugins.js
:
{
"permissions": {
"enabled": true
}
}
The plugin will automatically create a file in the config/
directory of your Strapi installation. This newly created file is named config/permissions.js
and will contain default permissions upon first install.
The permissions in this file will automatically be set upon Strapi bootstrap.
Please use the prefix plugin::
to target a specific plugin.
Use api::
to target one of your own controllers.
When only specifying the prefix and entity name, without targeting a controller (e.g. api::restaurant
or plugin::users-permissions
), the plugin will set the permissions for all of the controllers in that entity.
To target a specific controller, please use: api::restaurant.restaurant
, or plugin::users-permissions.auth
.
When using in a typescript project add a config to the plugin config:
config/plugins.js
{
"permissions": {
"enabled": true,
"config": {
"typescript": true
}
}
}