POST Unregister Hierarchy User
URL: /hierarchy/user
Accessible by: EMS, Utility accounts only.
Restrictions: User must have the security privilege on the set.
Unregisters the user completely from the hierarchy and deletes the account. All set privileges are revoked.
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 "unregister". |
users | 1 | HierarchyUser [] | Yes | The users whose privileges to unregister. |
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": "unregister", "users": [ { "userName": "todelete@hierarchy.com" }, { "userName": "todelete2@hierarchy.com" } ] }
Sample API Call
Show code sample in:
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"
Example Response:
{ "status": { "code": 0, "message": "" } }