Sample groupentry request, Sample groupentry response, Sample groupfeed response – Google Search Appliance Policy ACL API Developers Guide User Manual

Page 20

Advertising
background image

Google Search Appliance: Policy ACL API Developer’s Guide

Policy ACL API Developer’s Guide

20

Sample GroupEntry Request

The following XML sample shows a sample request to create a group. The sample uses the groupName
to specify the name of the group. For the search appliance, the groupName and groupId are the same.

<atom:entry xmlns:atom="http://www.w3.org/2005/Atom"

xmlns:apps="http://schemas.google.com/apps/2006"
xmlns:gd="http://schemas.google.com/g/2005">
<apps:property name="groupId" value="us-sales"></apps:property>
<apps:property name="groupName" value="us-sales"></apps:property>
<apps:property name="description" value=""></apps:property>
<apps:property name="emailPermission" value=""></apps:property>

</atom:entry>

A newly created group does not have subscribers. The emailPermission and description properties
are not supported by the search appliance.

Sample GroupEntry Response

When you submit a request to create, retrieve, or update a group, the Provisioning API returns an XML
response that identifies the group.

The XML code that follows shows a sample API response for a request to create a group.

<atom:entry>

<atom:id>http://gsa.example.com:8000/a/feeds/group/2.0/domain/us-sales</

atom:id>

<atom:link rel="self" type="application/atom+xml"

href="http://gsa.example.com:8000/a/feeds/group/2.0/domain/us-sales"/>

<atom:link rel="edit" type="application/atom+xml"

href="http://gsa.example.com:8000/a/feeds/group/2.0/domain/us-sales"/>

<apps:property name="groupId" value="us-sales"></apps:property>
<apps:property name="groupName" value="us-sales"></apps:property>
<apps:property name="description" value=""></apps:property>
<apps:property name="emailPermission" value=""></apps:property>

</atom:entry>

Sample GroupFeed Response

When you submit a request to retrieve all groups for a domain or all groups to which a particular user
subscribes, the Provisioning API returns an Atom XML feed containing a list of groups, each of which is
identified in an <atom:entry> XML block the Administrative API Developer’s Guide: Protocol.

Advertising