api auth entity set

API

auth.entity.set

Update an entity name.

require admin or self grant access

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

Request example

GET http://example.com/api/get/auth.entity.set/json/?entity=fa10c4d7b02a13e27a2ae5a5bbe8130b&name=LR+a

{
	"method"  : "auth.entity.set",
	"request" :
	{
		"entity" : "fa10c4d7b02a13e27a2ae5a5bbe8130b",
		"name"   : "LR addon"
	}
}

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

Response example

{
	"status"   : "valid",
	"response" :
	{
		"entity" : "fa10c4d7b02a13e27a2ae5a5bbe8130b"
    }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<xml>
	<status>valid</status>
	<response>
		<entity>fa10c4d7b02a13e27a2ae5a5bbe8130b</entity>
	</response>
</xml>

Arguments

• entity: the entity identifier
• name: the new entity name

Return value

• entity: the entity identifier