Access this instance at HomeyAPIV3Cloud.users.
Extends
- HomeyAPIV3.ManagerUsers
Classes
Instance Methods
acceptSharingInvite
(async) acceptSharingInvite(opts): Promise.<any>Scopes
-
HTTP
POST /api/manager/users/accept
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
secret
|
string | |
athomId
|
string | |
inviteToken
|
string | |
name
|
string | |
|
|
Returns
Promise.<any>
createUser
(async) createUser(opts): Promise.<HomeyAPIV3Cloud.ManagerUsers.User>Scopes
homey.user
HTTP
POST /api/manager/users/user
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
user
|
object | |
role
|
string | |
|
|
||
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerUsers.User>
deleteUser
(async) deleteUser(opts)Scopes
homey.user
HTTP
DELETE /api/manager/users/user/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
|
|
deleteUserMe
(async) deleteUserMe(): Promise.<any>Scopes
homey.user.self
HTTP
DELETE /api/manager/users/user/me
Returns
Promise.<any>
deleteUserMeProperties
(async) deleteUserMeProperties(opts): Promise.<any>Scopes
homey.user.self
HTTP
DELETE /api/manager/users/user/me/properties/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
|
|
Returns
Promise.<any>
getState
(async) getState(): Promise.<any>Scopes
homey.system.readonly
HTTP
GET /api/manager/users/state
Returns
Promise.<any>
getUser
(async) getUser(opts): Promise.<HomeyAPIV3Cloud.ManagerUsers.User>Scopes
homey.user.readonly
HTTP
GET /api/manager/users/user/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerUsers.User>
getUserMe
(async) getUserMe(): Promise.<any>Scopes
homey.user.self
HTTP
GET /api/manager/users/user/me
Returns
Promise.<any>
getUsers
(async) getUsers(): Promise.<Object.<string, HomeyAPIV3Cloud.ManagerUsers.User>>Scopes
homey.user.readonly
HTTP
GET /api/manager/users/user
Returns
Promise.<Object.<string, HomeyAPIV3Cloud.ManagerUsers.User>>
login
(async) login(opts): Promise.<any>Scopes
-
HTTP
POST /api/manager/users/login
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
token
|
string | |
|
|
Returns
Promise.<any>
updateUser
(async) updateUser(opts): Promise.<HomeyAPIV3Cloud.ManagerUsers.User>Scopes
homey.user
HTTP
PUT /api/manager/users/user/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
user
|
object | |
role
|
string
<optional> |
|
enabled
|
boolean
<optional> |
|
|
|
||
|
|
Returns
Promise.<HomeyAPIV3Cloud.ManagerUsers.User>
updateUserMe
(async) updateUserMe(opts): Promise.<any>Scopes
homey.user.self
HTTP
PUT /api/manager/users/user/me
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
name
|
string
<optional> |
|
|
|
Returns
Promise.<any>
updateUserMeProperties
(async) updateUserMeProperties(opts): Promise.<any>Scopes
homey.user.self
HTTP
PUT /api/manager/users/user/me/properties/:id
Parameters
| Name | Type | Description |
|---|---|---|
opts
|
object | |
id
|
string | |
value
|
object | |
|
|
Returns
Promise.<any>
Events
user.create
.on('user.create')Parameters
| Name | Type | Description |
|---|---|---|
user
|
HomeyAPIV3Cloud.ManagerUsers.User |
user.delete
.on('user.delete')Parameters
| Name | Type | Description |
|---|---|---|
user
|
HomeyAPIV3Cloud.ManagerUsers.User |
user.update
.on('user.update')Parameters
| Name | Type | Description |
|---|---|---|
user
|
HomeyAPIV3Cloud.ManagerUsers.User |