access control

Get access rule

get/{collection}/access/rules/{id}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

collectionstring required

Name of a collection

idinteger required

Response

OK

idinteger

Unique identifier for this rule. Generated if omitted.

policyIdinteger required

Access policy to apply to captures this rule matches

publicMessagestring

Access denied message to be shown to users

privateCommentstring

Private notes for curators managing this rule

surtsstring[] required

Matches captures with URLs that fit any of the given patterns

Example response

{
  "id": 42,
  "policyId": 2,
  "publicMessage": "Access restricted",
  "privateComment": "See correspondence",
  "surts": [
    "org,example)/"
  ]
}

Changes

No recorded changes to this operation across all 10 revisions of this API.