Page last modified 00:11, 19 Mar 2009 by MaxM
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
Overview
public. Retrieve list of groups.
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| authprovider | int? | Return groups belonging to given authentication service id |
| groupnamefilter | string? | Search for groups by name or part of a name |
| limit | int? | Number of entries to retrieve. Default: 100 |
| offset | int? | Number of entries to skip. Default: 0 |
| sortby | {id, name, role, service}? | Sort field. Prefix value with '-' to sort descending. default: No sorting |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Read access is required |
| Ok | 200 | Request completed successfully |
Message Format
Output:
<groups count="{int}" href="{uri}">
<group id="{int}" href="{uri}">
<groupname>{text}</groupname>
<service.authentication id="{int}" href="{uri}" />
<users count="{int}" href="{uri}" />
<permissions.group>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions.group>
</group>
</groups>
Implementation Notes
Groups provide the ability to associate a collection of users with a predefined role. Use GET:site/roles to retrieve a list of all roles currently defined on the site.
Use POST:groups to add or modify a group and DELETE:groups/{groupid} to remove a specified group.
Code Samples
The following code example retrieves all groups defined for the site:
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("groups").Get();
Sample response indicating that there is one group. This group is associated with the local authentication service, contains one user, and has the Contributor role:
<groups count="1" href="http://deki-hayes/@api/deki/groups">
<group id="1" href="http://deki-hayes/@api/deki/groups/1">
<groupname>My Contributors Group</groupname>
<service.authentication id="1" href="http://deki-hayes/@api/deki/site/services/1" />
<users count="1" href="http://deki-hayes/@api/deki/groups/1/users" />
<permissions.group>
<operations mask="1343">LOGIN,BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS</operations>
<role id="4" href="http://deki-hayes/@api/deki/site/roles/4">Contributor</role>
</permissions.group>
</group>
</groups>
- Tag page
- What links here
Images 0
You must login to post a comment.