api auth user list

API

auth.user.list

Retrieve all users.
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" :
	{
		"list" :
		[
			{ "user" : "willy", "name" : "willy" },
			{ "user" : "jhon",  "name" : "jhon" },
			{ "user" : "smith", "name" : "smith" },
			{ "user" : "eric",  "name" : "eric" }
		]
    }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<status>valid</status>
	<response>
		<list><user>willy</user><name>willy</name></list>
		<list><user>jhon</user><name>jhon</name></list>
		<list><user>smith</user><name>smith</name></list>
		<list><user>eric</user><name>eric</name></list>
	</response>
</xml>

Arguments

• [grant]: the grant access

Return Value

• list: array of user with:
  • user: user identifier.
  • name: user name.