Class UsersService

Users service

Hierarchy

  • UsersService

Constructors

constructor

Properties

httpClient namespace

Methods

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

Constructors

constructor

Properties

Private httpClient

httpClient: HttpClient

Private namespace

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

Methods

activateUser

  • Activate user by id.

    Parameters

    • id: number

      user id

    Returns Promise<AxiosResponse<IUser, any>>

    user data with active: true

deactivateUser

  • Deactivate user by id

    Parameters

    • id: number

      user id

    Returns Promise<AxiosResponse<IUser, any>>

    user data with active: false

disable2Fa

get2FaStatus

  • Get 2fa status by user id

    Parameters

    • id: number

      user id

    Returns Promise<AxiosResponse<I2FaStatus, any>>

    user portal settings

getPortalSettings

  • get portal ettings by user id

    Parameters

    • id: number

      user id

    Returns Promise<AxiosResponse<IPortalSettings, any>>

    user portal settings

getUserById

  • Get user by id

    Parameters

    • id: number

      user id

    Returns Promise<AxiosResponse<IUser, any>>

    user entity

getUsers

  • 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

  • Parameters

    • Optional page: number
    • Optional list: "all"
    • Optional show: "all"

    Returns Promise<AxiosResponse<IUser[], any>>

getUsersByFilers

getUsersByIds

hasRole

  • check if user has role

    Parameters

    • userRoles: string[]

      user roles

    • roles: string[]

      roles to check

    Returns boolean

    boolean

search

updatePortalSettings

  • update portal ettings by user id

    Parameters

    Returns Promise<AxiosResponse<IPortalSettings, any>>

    user portal settings

updatePosition

  • 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

  • Update user roles by id.

    Parameters

    • id: number

      user id

    • roles: string[]

    Returns Promise<AxiosResponse<IUser, any>>

    user data with new roles

updateUser

  • Update user data by id.

    Parameters

    Returns Promise<AxiosResponse<IUser, any>>

    updated user

uploadAvatar

  • Upload avatar

    Parameters

    Returns Promise<AxiosResponse<IUser, any>>

    user portal settings

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc