Google Search Appliance Policy ACL API Developers Guide - Manual (Page 17)

Google Search Appliance: Policy ACL API Developer’s Guide Policy ACL API Developer’s Guide 17
A set of ACL rules can be specified for a URL pattern. The following parameters are used in the name=
attribute:
The following are the properties:
Creating an ACL Rule
To create an ACL rule, send an authenticated POST request to the following URL:
http://Search_Appliance:8000/feeds/policyAcls
Parameters Description
urlPattern The URL pattern for which the ACL rules apply.
acl The ACLs. The following example shows the format of the ACLs:
group:engineer user:polly user:ji
aclProto The ACLs in protocol buffer format. The following example shows the format of
the ACL:
entries <
gsa_entry <
access: 1
principal <
scope: 2
name: "testGroup"
name_space: "Default"
case_sensitive: 0
>
>
>
protoAcls Set to true if acl is in protocol buffer format.
Property Description
query A query string to perform a URL pattern search. The matched ACL rules should
contain a URL pattern and the matching mode, which depends on the matchMode
parameter.
matchMode The matching mode for the URL patterns. The possible values are:
• all—Match any rules.
• url—The input query is a URL and only the ACL rules could apply to the URL
that is returned, for example, the rule with URL pattern "example.com"
matches the "http://example.com/test/index.html" input query.
• document—Only return document-level ACL rules. For example, the rule with
the URL pattern "example.doc$" matches the "example" input query.
• coarseGrain—Only return non-document-level ACL rules. For example, the
rule with URL pattern "example.com" matches the input query "example" but
the rule with URL pattern "example.doc$" does not.
startLine The starting line number of a result, the default value is 0 results.
maxLines The number of result lines in a response, the default value is 100 lines of results.