Returns a status object.
Example
(async () => {
const {data, res} = await userService.activateTotp();
})();
Returns a result object. During this action if preferred login mode is OAI_SECURE new jwt cookie will be set.
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);
})();
Returns promise object that is resolved with the ICurrenUser wrapped by IResult.
Example
(async () => {
const {data, res} = await userService.currentWithEffectiveRoles();
})();
Returns promise object that is resolved with the IResult of null.
Example
const userId: string = "uniqueUserId";
(async () => {
const {data, res} = await userService.delete(userGroupId);
})();
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.
Returns an object of ITotpStatus if it is active.
Example
(async () => {
const {data, res} = await userService.getActivityTotp();
console.log(data.isActive);
})();
Server response and data with email addresses as plain text.
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(...);
})();
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);
})();
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);
})();
Server response and data with updated current user object.
Returns a request result object.
Example
const email = 'user@example.com';
const tenantId = 't123456';
(async () => {
const { res, data } = await userService.sendPasswordResetMail(email, tenantId);
})();
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'.
Returns a status object.
Example
(async () => {
const {data, res} = await userService.verifyTFACode('123123');
})();
Returns a status object.
Example
(async () => {
const {data, res} = await userService.verifyTotpCode('123123');
})();
Generated using TypeDoc