api auth user list

API

auth.user.list

Retrieve all users if grant is not provided.
Retrieve all users with the grant access grant if grant is provided.

require admin grant access

Request example

GET http://example.com/api/get/auth.user.list/json/?grant=write

{
	"method"  : "auth.user.list",
	"request" : { "grant" : "write" }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<method>auth.user.list</method>
	<request>
		<grant>write</grant>
	</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

• [grant]: the grant access

Return Value

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