POST Remove Hierarchy User

URL: /hierarchy/user

Accessible by: EMS, Utility accounts only.

Restrictions: User must have the security privilege on the set.

Removes one or more user privileges from a set. Only the privileges are removed from the specified set, the user remains in the hierarchy.

To completely delete a user, use the unregister operation.

See Getting Started with Management Set Hierarchy for additional information.

Request Properties

Property	Version	Type	Required	Description
operation	1	String	Yes	The type of request. Always "remove".
setPath	1	String	Yes	The path to the set to remove user privileges from.
users	1	HierarchyUser []	Yes	The users whose privileges to remove from the set.

Response Properties

Property	Version	Type	Description
status	1	Status	The api response code.

Example Request:

Request Body

NOTE: Request body is not encoded for example purposes.

HEADERS:
	Content-Type: application/json;charset=UTF-8
	Authorization: Bearer Rc7JE8P7XUgSCPogLOx2VLMfITqQQrjg
	
REQUEST:
	POST https://api.ecobee.com/1/hierarchy/user?format=json
	
POST BODY:
{
	"operation": "remove",
	"setPath": "/",
	"users": [
		{
			"userName": "todelete@hierarchy.com"
		},
		{
			"userName": "todelete2@hierarchy.com"
		}
	]
}
				

Sample API Call

curl -s --request POST --data-urlencode @json.txt -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Bearer ACCESS_TOKEN" "https://api.ecobee.com/1/hierarchy/user?format=json"  
				

					
$.get('json.txt', function(jsonData) {
	alert(JSON.stringify(jsonData));
   $.ajax({
   		beforeSend: function(request) {
        	request.setRequestHeader("Authorization", "Bearer ".concat(ACCESS_TOKEN));
    	},
		type: 'post',
		url: 'https://api.ecobee.com/1/hierarchy/user?format=json',
		dataType: 'json',
		contentType: 'application/json',
		data: JSON.stringify(jsonData),
		success: function (data) {
	   		var response = JSON.stringify(data, null, 4);
	    }
	});
});
				

Example Response:

{
    "status": {
        "code": 0,
        "message": ""
    }
}
    

Back To Top