Skip to content

chore: add field-policies to README #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2025
Merged

chore: add field-policies to README #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/templates/README.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Check out the official [Documentation](https://codeshelldev.github.io/secured-si
- [Configuration](#configuration)
- [Endpoints](#endpoints)
- [Variables](#variables)
- [Field Policies](#field-policies)
- [Field Mappings](#field-mappings)
- [Message Templates](#message-templates)
- [Integrations](https://codeshelldev.github.io/secured-signal-api/docs/integrations/compatibility)
Expand Down Expand Up @@ -284,6 +285,23 @@ settings:
Message Templates support [Standard Golang Templating](#templating).
Use `@data.key` to reference Body Keys, `#Content_Type` for Headers and `.KEY` for Variables.

### Field Policies

**Field Policies** allow for blocking or specifically allowing certain fields with set values from being used in the requests body or headers.

Configure them by using `access.fieldPolicies` like so:

```yaml
settings:
access:
fieldPolicies:
"@number": { value: "+123400002", action: block }
```

Set the wanted action on encounter, available options are `block` and `allow`.

Use `@` for Body Keys and `#` for Headers.

### Field Mappings

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