Page last modified 19:49, 2 Feb 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 users.
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| activatedfilter | bool? | Search for users by their active status |
| authenticate | bool? | Force authentication for request (default: false) |
| authprovider | int? | Return users belonging to given authentication service id |
| limit | int? | Number of entries to retrieve. Default: 100 |
| offset | int? | Number of entries to skip. Default: 0 |
| rolefilter | string? | Search for users by a role name |
| sortby | {id, username, nick, email, fullname, date.lastlogin, status, role, service, date.created}? | Sort field. Prefix value with '-' to sort descending. default: No sorting |
| usernameemailfilter | string? | Search for users by name and email or part of a name and email |
| usernamefilter | string? | Search for users by name or part of a name |
Return Codes
| Name | Value | Description |
| Forbidden | 403 | Read access is required |
| Ok | 200 | The request completed successfully |
Message Format
Output:
<users count="{int}" href="{uri}">
<user id="{int}" href="{uri}">
<nick>{text}</nick>
<username>{text}</username>
<email>{text}</email>
<page.home id="{int}" href="{int}">
<title>{text}</title>
<path>{text}</path>
</page.home>
<fullname />
<status>{active|inactive}</status>
<date.lastlogin>{date}</date.lastlogin>
<service.authentication id="{int}" href="{uri]" />
<permissions.user>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions.user>
<permissions.effective>
<operations mask="{int}">{text}</operations>
</permissions.effective>
<groups count="{int}" href="{uri}">
<group id="{int}" href="{uri}">
<name>{text}</name>
<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>
</user>
...
</users>
Implementation Notes
User POST:users to add or modify users.
Code Samples
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Tag page (Edit tags)
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
Viewing 1 of 1 comments: view all
#1
neilw says:
There seems to be somewhat more to this API call than is documented. When I call it on my own wiki, I get two separate <users> blocks, apparently one each for local and single sign-on authentication. There are also additional fields in the <users> tag not documented here. My second one is for the single sign-on users, and it has count="0", and then assorted permissions and group info before the next <user>.
Posted 21:23, 20 Jun 2008
Viewing 1 of 1 comments: view all
You must login to post a comment.