Skip to content
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

Jump to bottom

docs: for remote_json authorizer, add headers #1604

Merged
merged 1 commit into from
Feb 28, 2024
Merged

docs: for remote_json authorizer, add headers #1604

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
11 changes: 11 additions & 0 deletions docs/oathkeeper/pipeline/authz.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,10 @@ response code, the access is denied.
[`text/template`](https://golang.org/pkg/text/template/) package and applied to an
[`AuthenticationSession`](https://github.com/ory/oathkeeper/blob/master/pipeline/authn/authenticator.go#L40) object. See
[Session](../pipeline.md#session) for more details.
- `headers` (map of strings, optional) - The HTTP headers sent to the remote authorizer. The values will be parsed by the Go
[`text/template`](https://golang.org/pkg/text/template/) package and applied to an
[`AuthenticationSession`](https://github.com/ory/oathkeeper/blob/master/pipeline/authn/authenticator.go#L40) object. See
[Session](../pipeline.md#session) for more details.
- `forward_response_headers_to_upstream` (slice of strings, optional) - The HTTP headers that will be allowed from remote
authorizer responses. If returned, headers on this list will be forward to upstream services.
- `retry` (object, optional) - Configures timeout and delay settings for the request against the token endpoint
Expand All @@ -379,6 +383,8 @@ authorizers:

config:
remote: http://my-remote-authorizer/authorize
headers:
Y-Api-Key: '{{ .MatchContext.Header.Get "X-Api-Key" }}'
payload: |
{
"subject": "{{ print .Subject }}",
Expand All @@ -395,6 +401,8 @@ authorizers:
- handler: remote_json
config:
remote: http://my-remote-authorizer/authorize
headers:
Y-Api-Key: '{{ .MatchContext.Header.Get "X-Api-Key" }}'
payload: |
{
"subject": "{{ print .Subject }}",
Expand Down Expand Up @@ -422,6 +430,9 @@ authorizers:
"authorizer": {
"handler": "remote_json",
"config": {
"headers": {
"Y-Api-Key": "{{ .MatchContext.Header.Get \"X-Api-Key\" }}"
},
"remote": "http://my-remote-authorizer/authorize",
"payload": "{\"subject\": \"{{ print .Subject }}\", \"resource\": \"{{ printIndex .MatchContext.RegexpCaptureGroups 0 }}\"}"
},
Expand Down
Loading