api auth entity get

API

auth.entity.get

Retrieve entity data.

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.get/json/?entity=fa10c4d7b02a13e27a2ae5a5bbe8130b

{
	"method"  : "auth.entity.get",
	"request" :
	{
		"entity" : "fa10c4d7b02a13e27a2ae5a5bbe8130b"
	}
}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<method>auth.entity.get</method>
	<request>
		<entity>fa10c4d7b02a13e27a2ae5a5bbe8130b</entity>
	</refresh>
</xml>

Response example

{
	"status"   : "valid",
	"response" :
	{
		"name"       : "Lightroom Plugin",
		"user"       : "jhon",
		"public_key" : "fa10c4d7b02a13e27a2ae5a5bbe8130b"
    }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<status>valid</status>
	<response>
		<name>Lightroom Plugin</name>
		<user>jhon</user>
		<public_key>fa10c4d7b02a13e27a2ae5a5bbe8130b</public_key>
	</response>
</xml>

Arguments

• entity: the entity identifier

Return Value

• name: the entity name
• user: the user name
• public_key: the entity public key
• private_key: the entity private key (only if the authentication is made from the admin web interface).