Skip to content

Commit

Permalink
Fixup Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jbygdell committed Nov 21, 2024
1 parent fa01d4a commit 7d0486b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions sda/cmd/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 7d0486b

Please sign in to comment.