api auth entity list

API

auth.entity.list

Retrieve all entities of user, if not provided, connected user is used.
Filter with the grant access grant if grant is provided.

require admin or self grant access

NOTE:
self grant is not a real grant, it means that a authenticated user can act on its data.

Request example

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

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

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<method>auth.entity.list</method>
	<request>
		<grant>write</grant>
	</request>
</xml>

Response example

{
	"status"   : "valid",
	"response" :
	{
		"list" :
		[
			{
				"entity"     : "fa10c4d7b02a13e27a2ae5a5bbe8130b",
				"name"       : "LR addon",
				"public_key" : "fa10c4d7b02a13e27a2ae5a5bbe8130b"
			},
			{
				"entity"     : "8b863651d51f3000226aa9a628df4ee8",
				"name"       : "Aperture addon",
				"public_key" : "8b863651d51f3000226aa9a628df4ee8"
			}
		]
    }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<status>valid</status>
	<response>
		<list>
			<entity>fa10c4d7b02a13e27a2ae5a5bbe8130b</entity>
			<name>LR addon</name>
			<public_key>fa10c4d7b02a13e27a2ae5a5bbe8130b</public_key>
		</list>
		<list>
			<entity>8b863651d51f3000226aa9a628df4ee8</entity>
			<name>Aperture addon</name>
			<public_key>8b863651d51f3000226aa9a628df4ee8</public_key>
		</list>
	</response>
</xml>

Arguments

• [grant]: the grant access

Return Value

• list: array of entity with:
  • entity: entity identifier.
  • name: entity name.
  • public_key: the entity public key
  • private_key: the entity private key (only if the authentication is made from the admin web interface).