Namespace: user

Namespaces

Methods

acceptDeviceInvitation(params)
createDeletionRequest(userId)
get(params)

get(userId)
getChangelog()
getDeviceInvitations(userId)

list(params)
setCognitoIdentityId(params)
update(params)

Namespaces

device

licence

notifications

preview

pusher

Methods

async static

acceptDeviceInvitation(params) → Promise containing ApiResponse

accepts the device invitation

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
userId	string
params	Object
params.invitationId	string

Returns: Promise containing ApiResponse

async static

createDeletionRequest(userId) → Promise containing ApiResponse

creates a deletion request for a user

Parameter

Name	Type	Optional	Description
userId	string

Returns: Promise containing ApiResponse

async static

get(params) → Promise containing ApiResponse

returns a device a user has access to

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string
userId	string

Returns: Promise containing ApiResponse

async static

get(userId) → Promise containing ApiResponse

returns a user

Parameter

Name	Type	Optional	Description
userId	string

Returns: Promise containing ApiResponse

async static

getChangelog() → Promise containing ApiResponse

returns a web app changelog

Returns: Promise containing ApiResponse

async static

getDeviceInvitations(userId) → Promise containing ApiResponse

returns all device invitations for a user

Parameter

Name	Type	Optional	Description
userId	string

Returns: Promise containing ApiResponse

async static

list(params) → Promise containing ApiResponse

queries the users collection

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
deviceId	string
processId	string
textQuery	string
textQueryField	string
sortBy	string
sortOrder	string
embedDevices	boolean
skip	number
limit	number

Returns: Promise containing ApiResponse

async static

setCognitoIdentityId(params) → Promise containing ApiResponse

sets the cognitoIdentityId of a user

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
userId	string

Returns: Promise containing ApiResponse

async static

update(params) → Promise containing ApiResponse

updates a user

Parameters

Name Type Optional Description

params

Object

Values in params have the following properties:

Name	Type	Optional	Description
id	string
params	Object

Returns: Promise containing ApiResponse