user

User

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_user_get_users
• elements_user_create_user
• elements_user_get_user
• elements_user_deactivate_user
• elements_user_get_current_user
• elements_user_update_user
• elements_user_update_user_password

---

Back To Top

elements_user_get_users

Elements Operation: getUsers

This function searches all users in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_get_users(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real	The offset of the first result to return in the page.
_count	Real	The number of results to return in the page.
_search	String	The search filter to use.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsPaginationUser
_request	ElementsRequest

---

Back To Top

elements_user_create_user

Elements Operation: createUser

Supplying the user object, this function will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_create_user(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUserCreateRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsUserCreateResponse
_request	ElementsRequest

---

Back To Top

elements_user_get_user

Elements Operation: getUser

This function gets a specific user by name, email, or unique user ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_get_user(_name, _callback=undefined)

Argument	Type	Description
_name	String	The user's name, email, or unique user ID.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsUser
_request	ElementsRequest

---

Back To Top

elements_user_deactivate_user

Elements Operation: deactivateUser

This function deletes and permanently removes the user from the server. The server may keep some metadata as necessary to avoid data inconsistency. However, the user has been deleted from the client standpoint and will not be accessible through any of the existing APIs.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_deactivate_user(_name, _callback=undefined)

Argument	Type	Description
_name	String	The name of the user.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	Undefined
_request	ElementsRequest

---

Back To Top

elements_user_get_current_user

Elements Operation: getCurrentUser

This function accesses a special endpoint used to get the current user for the request. The current user is typically associated with the session but may be derived any other way. This is essentially an alias for using GET /user/myUserId (elements_user_get_current_user).

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_get_current_user(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsUser
_request	ElementsRequest

---

Back To Top

elements_user_update_user

Elements Operation: updateUser

Supplying the user object, this function will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_update_user(_user_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_user_id	String	The User ID.
_body	ElementsUserUpdateRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsUser
_request	ElementsRequest

---

Back To Top

elements_user_update_user_password

Elements Operation: updateUserPassword

Supplying the UserUpdatePasswordRequest, this function will attempt to update the user's password only if they supply the correct existing password.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_user_update_user_password(_user_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_user_id	String	The User ID.
_body	ElementsUserUpdatePasswordRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsSessionCreation
_request	ElementsRequest