User
The User service, introduced in 4.3, can be used to iterate through the users of an app. It can also be used to create new users. Note that this service is only available via cloud-code.
API Summary
Create Users
- SysCreateUserEmailPassword - Create a user with an email identity
- SysCreateUserUniversalId - Create a user with a univeralId identity
- SysCreateUserExternalAuth - Create a user with an external auth identity
Retreive Users Info
- SysGetUserInfo - Retrieves user information for a single profile ID
Delete Users
- SysDeleteUser - Delete a user
Paging
- SysGetPage - Get a page of users
- SysGetPageOffset - Get the next/prev page of users
Reset Password
- SysSendPasswordResetEmailWith - Reset the password associated with the users email login
- SysSendPasswordResetEmailAdvanced - Reset the password associated with the users email login
- SysSendPasswordResetEmailWithExpiry - Reset the password associated with the users email login
- SysSendPasswordResetEmailAdvancedWithExpiry - Reset the password associated with the users email login using a custom email template
- SysSendPasswordResetUniversalId - Reset users password
- SysSendPasswordResetUniversalIdAdvanced - Reset users password using templates
- SysSendPasswordResetUniversalIdWithExpiry - Reset the password associated with the users universalId login
- SysSendPasswordResetUniversalIdAdvancedWithExpiry - Reset the password associated with the users universalId login using a custom email template
- SysSetPasswordUniversalId - Set the password associated with the universal id of the given profile.
📄️ SysCreateUserEmailPassword
Manually creates a new user for the current app. Note that this API is normally used for in an admin app for pre-creating users. Standard, dynamic, on-the-fly authentication is done via the Authentication service.
📄️ SysCreateUserExternalAuth
Manually creates a new user for the current app. Note that this API is normally used for in an admin app for pre-creating users. Standard, dynamic, on-the-fly authentication is done via the Authentication service.
📄️ SysCreateUserUniversalId
Manually creates a new user for the current app. Note that this API is normally used for in an admin app for pre-creating users. Standard, dynamic, on-the-fly authentication is done via the Authentication service.
📄️ SysDeleteUser
Delete user with option to also delete user's children.
📄️ SysGetPage
Retrieves first page of users from server based on the specified query context.
📄️ SysGetPageOffset
Retrieves next/prev page of users from server based on the specified query context.
📄️ SysGetUserExport
Exports user information for a single profile ID.
📄️ SysGetUserInfo
Retrieves user information for a single profile ID.
📄️ SysSendPasswordResetEmail
Triggers the sending of a password reset email to the specified user. Note that the user must have an email identity attached to their profile.
📄️ SysSendPasswordResetEmailAdvanced
Reset users password using templates.
📄️ SysSendPasswordResetEmailAdvancedWithExpiry
Triggers the sending of a password reset email to the specified user - but allows the dev to override the email template that will be used. Note that the user must have an email identity attached to their profile.
📄️ SysSendPasswordResetEmailWithExpiry
Triggers the sending of a password reset email to the specified user. Note that the user must have an email identity attached to their profile.
📄️ SysSendPasswordResetUniversalId
Reset users password.
📄️ SysSendPasswordResetUniversalIdAdvanced
Reset users password using templates.
📄️ SysSendPasswordResetUniversalIdAdvancedWithExpiry
Triggers the sending of a password reset email to the specified user - but allows the dev to override the email template that will be used. Note that the user must have a universalId identity attached to their profile, and an email address in their contact info.
📄️ SysSendPasswordResetUniversalIdWithExpiry
Triggers the sending of a password reset email to the specified user. Note that the user must have a universalId identity attached to their profile, and an email address in their contact info.
📄️ SysSetPasswordUniversalId
Set the password associated with the universal id of the given profile.