Skip to content

Commit 53d4768

Browse files
committed
docs: Add example for resources header
1 parent 4c4567d commit 53d4768

File tree

2 files changed

+50
-6
lines changed

2 files changed

+50
-6
lines changed

conf/config-example.yaml

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ targets:
276276
# - path: /
277277
# # Whitelist
278278
# whiteList: true
279-
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
279+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
280280
# - path: /specific_doc/*
281281
# # HTTP Methods authorized (Must be in GET, PUT or DELETE)
282282
# methods:
@@ -290,7 +290,7 @@ targets:
290290
# # NOTE: This list can be empty ([]) for authentication only and no group filter
291291
# authorizationAccesses: # Authorization accesses : groups or email or regexp
292292
# - group: specific_users
293-
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
293+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
294294
# - path: /directory1/*
295295
# # HTTP Methods authorized (Must be in GET, PUT or DELETE)
296296
# methods:
@@ -305,14 +305,36 @@ targets:
305305
# - user: user1
306306
# password:
307307
# path: password1-in-file
308-
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
308+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
309309
# - path: /opa-protected/*
310310
# # OIDC section for access filter
311311
# oidc:
312312
# # Authorization through OPA server configuration
313313
# authorizationOPAServer:
314314
# # OPA server url with data path
315315
# url: http://localhost:8181/v1/data/example/authz/allowed
316+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
317+
# - path: /specific_doc/*
318+
# # HTTP Methods authorized (Must be in GET, PUT or DELETE)
319+
# methods:
320+
# - GET
321+
# - PUT
322+
# - DELETE
323+
# # A authentication provider declared in section before, here is the key name
324+
# provider: provider1
325+
# # Header section for access filter
326+
# header:
327+
# # NOTE: This list can be empty ([]) for authentication only and no group filter
328+
# authorizationAccesses: # Authorization accesses : groups or email or regexp
329+
# - group: specific_users
330+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
331+
# - path: /opa-protected/*
332+
# # Header section for access filter
333+
# header:
334+
# # Authorization through OPA server configuration
335+
# authorizationOPAServer:
336+
# # OPA server url with data path
337+
# url: http://localhost:8181/v1/data/example/authz/allowed
316338
# ## Actions
317339
# actions:
318340
# # Action for GET requests on target

docs/configuration/example.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ targets:
286286
# - path: /
287287
# # Whitelist
288288
# whiteList: true
289-
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
289+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
290290
# - path: /specific_doc/*
291291
# # HTTP Methods authorized (Must be in GET, PUT or DELETE)
292292
# methods:
@@ -300,7 +300,7 @@ targets:
300300
# # NOTE: This list can be empty ([]) for authentication only and no group filter
301301
# authorizationAccesses: # Authorization accesses : groups or email or regexp
302302
# - group: specific_users
303-
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
303+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
304304
# - path: /directory1/*
305305
# # HTTP Methods authorized (Must be in GET, PUT or DELETE)
306306
# methods:
@@ -315,14 +315,36 @@ targets:
315315
# - user: user1
316316
# password:
317317
# path: password1-in-file
318-
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
318+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
319319
# - path: /opa-protected/*
320320
# # OIDC section for access filter
321321
# oidc:
322322
# # Authorization through OPA server configuration
323323
# authorizationOPAServer:
324324
# # OPA server url with data path
325325
# url: http://localhost:8181/v1/data/example/authz/allowed
326+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
327+
# - path: /specific_doc/*
328+
# # HTTP Methods authorized (Must be in GET, PUT or DELETE)
329+
# methods:
330+
# - GET
331+
# - PUT
332+
# - DELETE
333+
# # A authentication provider declared in section before, here is the key name
334+
# provider: provider1
335+
# # Header section for access filter
336+
# header:
337+
# # NOTE: This list can be empty ([]) for authentication only and no group filter
338+
# authorizationAccesses: # Authorization accesses : groups or email or regexp
339+
# - group: specific_users
340+
# # A Path must be declared for a resource filtering (a wildcard can be added to match every sub path)
341+
# - path: /opa-protected/*
342+
# # Header section for access filter
343+
# header:
344+
# # Authorization through OPA server configuration
345+
# authorizationOPAServer:
346+
# # OPA server url with data path
347+
# url: http://localhost:8181/v1/data/example/authz/allowed
326348
# ## Actions
327349
# actions:
328350
# # Action for GET requests on target

0 commit comments

Comments
 (0)