paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
Vincenzo Scamporlino
2023-04-21 20:07:29 +02:00
parent 1e043555f3
commit 6ce580660a
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-templates/authorizing-parameters-steps-and-actions.md
+3 -3
View File
@@ -8,7 +8,7 @@ The scaffolder plugin integrates with the Backstage [permission framework](../..
### Authorizing parameters and steps
To mark specific parameters or steps as requiring permission, add the backstage:permissions property to the parameter or step with one or more tags. For example:
To mark specific parameters or steps as requiring permission, add the `backstage:permissions` property to the parameter or step with one or more tags. For example:
```yaml
apiVersion: scaffolder.backstage.io/v1beta3
@@ -92,7 +92,7 @@ By combining this feature with restricting the ingestion of templates in the Cat
### Authorizing actions
Similar to parameters and steps, the scaffolder plugin exposes permissions to restrict access to certain actions. This can be useful if you want to enforce security on your templates.
Similar to parameters and steps, the scaffolder plugin exposes permissions to restrict access to certain actions. This can be useful if you want to secure your templates.
To restrict access to a particular action, you can modify your permission policy as follows:
@@ -125,7 +125,7 @@ class ExamplePermissionPolicy implements PermissionPolicy {
}
```
With this permission policy, spiderman won't be able to execute the debug:log action.
With this permission policy, the user `spiderman` won't be able to execute the debug:log action.
You can also restrict the input provided to the action by combining multiple rules.
In the example below, spiderman won't be able to execute debug:log when passing `{ "message": "not-this!" }` as action input: