From 7d0486b20efdd7b492a5ec2bad8fda0b5898adb7 Mon Sep 17 00:00:00 2001 From: Joakim Bygdell Date: Thu, 21 Nov 2024 12:05:17 +0100 Subject: [PATCH] Fixup Readme --- sda/cmd/api/api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sda/cmd/api/api.md b/sda/cmd/api/api.md index aaad8985d..4d4946bc2 100644 --- a/sda/cmd/api/api.md +++ b/sda/cmd/api/api.md @@ -138,14 +138,14 @@ Admin endpoints are only available to a set of whitelisted users specified in th #### Configure RBAC -RBAC is configure according to the JSON schema below. +RBAC is configured according to the JSON schema below. The path to the JSON file containing the RBAC policies needs to be passed through the `api.rbacFile` config definition. -The `policy` section will configure access to the defined endpoints, unless specific rules are set, an endpoint will not be accessible +The `policy` section will configure access to the defined endpoints. Unless specific rules are set, an endpoint will not be accessible - `action`: can be single string value i,e `GET` or a regex string with `|` as separator i.e. `(GET)|(POST)|(PUT)`. In the later case all actions in the list are allowed. -- `paht`: have two different wildcard notations `*`, matches any value and `:` that matches a specifc named value -- `role`: is the role that will be able to access the path, `"*"` will match any role or user. +- `paht`: the endpoint. Should be a string value with two different wildcard notations: `*`, matches any value and `:` that matches a specific named value +- `role`: the role that will be able to access the path, `"*"` will match any role or user. The `roles` section defines the available roles