Skip to content

Commit bdab853

Browse files
committed
Add docs
1 parent 3a2c5d2 commit bdab853

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

docs/manual/access-control.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ An .aclj file may look as follows::
9595

9696
Each JSON entry contains an ``access`` field and the original ``url`` field that was used to convert to the SURT (if any).
9797

98-
The JSON entry may also contain a ``user`` field, as explained below.
98+
The JSON entry may also contain ``user``, ``before``, and ``after`` fields, as explained below.
9999

100100
The prefix consists of a SURT key and a ``-`` (currently reserved for a timestamp/date range field to be added later).
101101

@@ -166,6 +166,23 @@ Further examples of how to set this header will be provided in the deployments s
166166
See the :ref:`config-acl-header` section in Usage for examples on how to configure this header.
167167

168168

169+
Date-Based Access Controls
170+
^^^^^^^^^^^^^^^^^^^^^^^^^^
171+
172+
The access control rules can further be customized be specifying different permissions based on capture timestamp, using ``before`` and ``after`` fields that operate in the same manner as their embargo counterparts for a specific URL or domain.
173+
174+
For example, the following access control settings restrict access to ``https://example.com/restricted/`` by default, but allow access for captures prior to December 1, 2010::
175+
176+
com,example)/restricted - {"access": "allow", "before": "20101201"}
177+
com,example)/restricted - {"access": "block"}
178+
179+
180+
Combined with the embargo settings, this can also be used to override the embargo for captures that fall within a particular time period, while keeping the embargo for general access::
181+
182+
com,example)/restricted - {"access": "allow_ignore_embargo", "before": "2010"}
183+
com,example)/restricted - {"access": "allow"}
184+
185+
169186
Access Error Messages
170187
^^^^^^^^^^^^^^^^^^^^^
171188

0 commit comments

Comments
 (0)