Page last modified 00:49, 28 Jan 2010 by melder
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
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other 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.
- Tag page (Edit tags)
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.