Class UsersService

Users service

Hierarchy

UsersService

Index

Constructors

Properties

httpClient namespace

Methods

activateUser deactivateUser disable2Fa get2FaStatus getPortalSettings getUserById getUsers getUsersByIds hasRole search updatePortalSettings updatePosition updateRoles updateUser uploadAvatar

Constructors

constructor

new UsersService(httpClient): UsersService
Parameters
- httpClient: HttpClient
Returns UsersService

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/company/v1/users'

Methods

activateUser

activateUser(id): Promise<AxiosResponse<IUser, any>>
Activate user by id.
Parameters
- id: number
  
  user id
Returns Promise<AxiosResponse<IUser, any>>
user data with active: true

deactivateUser

deactivateUser(id): Promise<AxiosResponse<IUser, any>>
Deactivate user by id
Parameters
- id: number
  
  user id
Returns Promise<AxiosResponse<IUser, any>>
user data with active: false

disable2Fa

disable2Fa(id): Promise<AxiosResponse<IResponseWithMessage, any>>
disable 2fa by user id
Parameters
- id: number
  
  user id
Returns Promise<AxiosResponse<IResponseWithMessage, any>>
user portal settings

get2FaStatus

get2FaStatus(id): Promise<AxiosResponse<I2FaStatus, any>>
Get 2fa status by user id
Parameters
- id: number
  
  user id
Returns Promise<AxiosResponse<I2FaStatus, any>>
user portal settings

getPortalSettings

getPortalSettings(id): Promise<AxiosResponse<IPortalSettings, any>>
get portal ettings by user id
Parameters
- id: number
  
  user id
Returns Promise<AxiosResponse<IPortalSettings, any>>
user portal settings

getUserById

getUserById(id): Promise<AxiosResponse<IUser, any>>
Get user by id
Parameters
- id: number
  
  user id
Returns Promise<AxiosResponse<IUser, any>>
user entity

getUsers

getUsers(page?, list?, show?): Promise<AxiosResponse<IResponseWithMeta<IUser>, any>>
Get users list
Parameters
- Optional page: number
  
  page number
- Optional list: number
  
  elements count
- Optional show: "all"
  
  get list of with unactive users (available only for admin or owner)
Returns Promise<AxiosResponse<IResponseWithMeta<IUser>, any>>
Array users entity
getUsers(page?, list?, show?): Promise<AxiosResponse<IUser[], any>>
Parameters
- Optional page: number
- Optional list: "all"
- Optional show: "all"
Returns Promise<AxiosResponse<IUser[], any>>

getUsersByIds

getUsersByIds(ids): Promise<AxiosResponse<IResponseWithMeta<IUser>, any>>
Upload avatar
Parameters
- ids: Pick<IUser, "id">[]
Returns Promise<AxiosResponse<IResponseWithMeta<IUser>, any>>
user portal settings

hasRole

hasRole(userRoles, roles): boolean
check if user has role
Parameters
- userRoles: string[]
  
  user roles
- roles: string[]
  
  roles to check
Returns boolean
boolean

search

search(body): Promise<AxiosResponse<IResponseWithMeta<IUser>, any>>
Search users
Parameters
- body: ISearchUsersDto
Returns Promise<AxiosResponse<IResponseWithMeta<IUser>, any>>
user portal settings

updatePortalSettings

updatePortalSettings(id, settings): Promise<AxiosResponse<IPortalSettings, any>>
update portal ettings by user id
Parameters
- id: number
- settings: IPortalSettings
Returns Promise<AxiosResponse<IPortalSettings, any>>
user portal settings

updatePosition

updatePosition(id, position): Promise<AxiosResponse<IUser, any>>
Update user position by id
Parameters
- id: number
  
  user id
- position: string
  
  user position
Returns Promise<AxiosResponse<IUser, any>>
user data with new position

updateRoles

updateRoles(id, roles): Promise<AxiosResponse<IUser, any>>
Update user roles by id.
Parameters
- id: number
  
  user id
- roles: string[]
Returns Promise<AxiosResponse<IUser, any>>
user data with new roles

updateUser

updateUser(id, body): Promise<AxiosResponse<IUser, any>>
Update user data by id.
Parameters
- id: number
  
  user id
- body: IUpdateUserDto
Returns Promise<AxiosResponse<IUser, any>>
updated user

uploadAvatar

uploadAvatar(body): Promise<AxiosResponse<IUser, any>>
Upload avatar
Parameters
- body: IUploadAvatar
Returns Promise<AxiosResponse<IUser, any>>
user portal settings

Generated using TypeDoc