Optionalrealtime: RealtimeChanges password for current user.
New password for current user.
The password of the currently logged user.
Returns a result object. During this action if preferred login mode is OAI_SECURE new jwt cookie will be set.
Changes password for user.
User's id or user object.
New user password.
The password of the currently logged user.
Returns a result object.
Creates a new user.
User object.
Returns promise object that is resolved with the details of newly created user.
Example
const userObject: IUser = {
userName: "newUser",
password: "userPassword12!@"
};
(async () => {
const {data, res} = await userService.create(userObject);
})();
Gets user that is currently logged in with the list of all roles assigned.
Returns promise object that is resolved with the ICurrenUser wrapped by IResult.
Example
(async () => {
const {data, res} = await userService.currentWithEffectiveRoles();
})();
Removes user.
User's id or user object.
Returns promise object that is resolved with the IResult of null.
Example
const userId: string = "uniqueUserId";
(async () => {
const {data, res} = await userService.delete(userGroupId);
})();
Gets the details of given user.
User's id or user object.
Additional query params.
Returns promise object that is resolved with the IUser wrapped by IResult.
Example
const userId: number = 1;
(async () => {
const {data, res} = await userService.detail(userId);
})();
User password is never returned in GET response. Authentication mechanism is provided by another interface.
Generates a secret which can be used to setup two-factor authentication with TOTP.
Returns the secret and an URL to a QR Code.
Example
(async () => {
const {data, res} = await userService.generateTotpSecret();
console.log(secret);
})();
Checks if TOTP is activated and enforced.
Returns an object of ITotpStatus if it is active.
Example
(async () => {
const {data, res} = await userService.getActivityTotp();
console.log(data.isActive);
})();
Create instance of User Inventory Role Service related with given User.
User's id or user object.
Returns UserInventoryRoleService object that is related with given User.
Example
const userId: string = "uniqueUserId";
const userInventoryRoleService = userService.inventoryAssignment(userGroupId);
(async () => {
const {data, res} = await userInventoryRoleService.create(...);
})();
Gets the list of users filtered by parameters.
Object containing filters for querying users.
Returns promise object that is resolved with the IUser wrapped by IResultList.
Example
const filter: object = {
pageSize: 100,
withTotalPages: true
};
(async () => {
const {data, res, paging} = await userService.list(filter);
})();
Resets user's password to a new one.
Object with token, user's email, new password and its strength indicator.
OptionaltenantId: stringThe id of user's tenant (if cannot be inferred from URL).
Returns a request result object.
Example
const newPassword: IResetPassword = {
token: '123123ASDAWERER@#!WEDS$@#!WADA#A#EA#EA#EA',
email: 'user@example.com',
newPassword: 'myNewPassword',
passwordStrength: PasswordStrength.GREEN
};
const tenantId = 't123456';
(async () => {
const { res, data } = await userService.resetPassword(newPassword, tenantId);
})();
Saves phone number for the current user.
Phone number to save.
Server response and data with updated current user object.
Sends an email message with a link allowing user to reset their password.
The email address to send the message to.
OptionaltenantId: stringThe id of user's tenant (if cannot be inferred from URL).
Returns a request result object.
Example
const email = 'user@example.com';
const tenantId = 't123456';
(async () => {
const { res, data } = await userService.sendPasswordResetMail(email, tenantId);
})();
Updates user data.
User is partially updatable.
Returns promise object that is resolved with the saved user object.
Example
const partialUpdateObject: Partial<IUser> = {
"id" : "myuser",
"userName" : "newUserName",
"email": "newUserEmail@example.com"
...
}
(async () => {
const {data, res} = await userService.update(partialUpdateObject);
})();
When user is updated with changed permissions or groups, suitable audit record is created with type 'User' and activity 'User updated'.
Verifies TFA code which is sent via SMS. If invoked with string '0', new TFA code will be sent.
The code to verify.
Returns a status object.
Example
(async () => {
const {data, res} = await userService.verifyTFACode('123123');
})();
Description
This service allows for managing users.