For Dashboard Designers Reference UserManagement
Monday, December 14, 2020 5:32 PMUserManagement
Label: :IA_Function
Property: type: UserManagement
Inherits from: Function
Bundles actions related to managing users.
Function parameters
Key | Description | Default value | Possible values |
---|---|---|---|
action |
The action to perform. | string; see below | |
params |
The parameters for the given action. See below for possible values. | object; see below |
Each action
requires specific parameters. Below are the possibilities.
action |
Description | params |
---|---|---|
create |
Create a user. | User node to create |
delete |
Delete a user. Only id , properties.uuid or properties.iaName are used. |
User node to delete |
read |
Find a user. Only id , properties.uuid or properties.iaName are used. |
User node to read |
reset-password |
Send a password-reset email | email the user's email address to send to. |
set-password |
Change a user's password | id : user id newPassword : the new password oldPassword : (optional) the user's current password token : (optional) a password token, as sent to the user's email address. Either token or oldPassword must be provided. |
update |
Update a user. | User node to update |
Outgoing triggers
Type: success
Occurrence: When the requested action was performed successfully.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
response |
The response from the performed action. | See below |
For each action
, the response
can be different. Below are the possibilities:
action |
response |
---|---|
create |
Created user node |
delete |
(empty) |
read |
Requested user node |
reset-password |
(empty) |
set-password |
Updated user node |
update |
Updated user node |