User¶
- Portal module
- User extension¶
- User/Get¶
Gets a single user or all users in a group
Authentication: - Logged in – You need to be logged in to use this feature
- UserManager permission – Requires the SystemPermissons.UserManager permission
Parameters: - guid – GUID of the user to get
- groupGuid – GUID of the group whose users to get
Returns: The a list of users
Return type: UserInfo
- User/GetCurrent¶
Gets the current user.
Authentication: - Logged in – You need to be logged in to use this feature
Returns: The current (logged in) user
Return type: UserInfo
- User/Create¶
Authentication: - Logged in – You need to be logged in to use this feature
- UserManager permission – Requires the SystemPermissons.UserManager permission
Parameters: - guid (optional) – GUID for the new user
- email – Email for the new user
Returns: The new user
If no GUID is supplied CHAOS will generate one for you.
- User/Update¶
Change email or permissions for a user.
Authentication: - Logged in – You need to be logged in to use this feature
Optional authentication: - UserManager permission – May require the SystemPermissons.UserManager permission
Parameters: - guid – GUID of the user to update
- email – (new) email for the user
- permissons (optional, integer) – New permissions for the user (an integer from the SystemPermissons struct)
Returns: The updated user
If your user has the SystemPermissons.UserManager permission, all users can be edited. If your user doesn’t have this permission, you can edit your own users email, but not your own permissions.
Note
The parameter is called permissons not permissions.
- User/Delete¶
Deletes a user
Authentication: - Logged in – You need to be logged in to use this feature
- UserManager permission – Requires the SystemPermissons.UserManager permission
Parameters: guid – GUID of the user to update
Returns: The number of affected rows in the database
Throws an exception if no user was deleted.