Skip to content
Alban LEROUX edited this page Oct 3, 2011 · 3 revisions

API

auth.user.list

Retrieve all users.

  • require admin grant access *

Request example

{
	"method"  : "auth.user.list",
	"request" : {}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<method>auth.user.list</method>
	<request />
</xml>

Response example

{
	"status"   : "valid",
	"response" : 
	{
		"user" : 
		[ 
			{ "id" : 1, "name" : "willy" },
			{ "id" : 2, "name" : "jhon" },
			{ "id" : 3, "name" : "smith" },
			{ "id" : 4, "name" : "eric" },
		]
    }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<status>valid</status>
	<response>
		<user><id>1</id><name>willy</name></user>
		<user><id>2</id><name>jhon</name></user>
		<user><id>3</id><name>smith</name></user>
		<user><id>4</id><name>eric</name></user>
	</response>
</xml>

Arguments

No argument needed.

NOTE: Even if no argument needed in the request the field request still mandatory, keep it empty.

Return Value

user array of user with id for user id and name for user name.

Clone this wiki locally