Skip to content

Commit be59215

Browse files
authored
chore: add field-policies to README (#99)
1 parent 49e7318 commit be59215

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

.github/templates/README.template.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Check out the official [Documentation](https://codeshelldev.github.io/secured-si
5454
- [Configuration](#configuration)
5555
- [Endpoints](#endpoints)
5656
- [Variables](#variables)
57+
- [Field Policies](#field-policies)
5758
- [Field Mappings](#field-mappings)
5859
- [Message Templates](#message-templates)
5960
- [Integrations](https://codeshelldev.github.io/secured-signal-api/docs/integrations/compatibility)
@@ -284,6 +285,23 @@ settings:
284285
Message Templates support [Standard Golang Templating](#templating).
285286
Use `@data.key` to reference Body Keys, `#Content_Type` for Headers and `.KEY` for Variables.
286287

288+
### Field Policies
289+
290+
**Field Policies** allow for blocking or specifically allowing certain fields with set values from being used in the requests body or headers.
291+
292+
Configure them by using `access.fieldPolicies` like so:
293+
294+
```yaml
295+
settings:
296+
access:
297+
fieldPolicies:
298+
"@number": { value: "+123400002", action: block }
299+
```
300+
301+
Set the wanted action on encounter, available options are `block` and `allow`.
302+
303+
Use `@` for Body Keys and `#` for Headers.
304+
287305
### Field Mappings
288306

289307
To improve compatibility with other services Secured Signal API provides **Field Mappings** and a built-in `message` Mapping.

0 commit comments

Comments
 (0)