Class Users

constructor

• new Users(saasClient): Users

• Parameters

  • saasClient: QlikSaaSClient

  Returns Users

_actions

create

• create(arg): Promise<User>

• Creates an invited user

  Parameters

  • arg: IUserCreate

  Returns Promise<User>

get

• get(arg): Promise<User[]>

• Info about the tenant accessing the endpoint

  Parameters

  • arg: {
        id: string;
    }

    • id: string

  Returns Promise<User[]>

getAll

• getAll(): Promise<User[]>

• Returns a list of users. Each element of the list is an instance of the User class

  Returns Promise<User[]>

getFilter

• getFilter(arg): Promise<User[]>

• Parameters

  • arg: {
        filter: string;
    }

    • filter: string

  Returns Promise<User[]>

getFilterNative

• getFilterNative(arg): Promise<IUser[]>

• Retrieves a list of users matching the filter using an advanced query string

  Parameters

  • arg: {
        filter: string;
        sort?: string;
    }

    • filter: string

    • Optional sort?: string

  Returns Promise<IUser[]>

me

• me(): Promise<User>

• Redirects to retrieve the user resource associated with the JWT claims

  Returns Promise<User>

metadata

• metadata(): Promise<{
      valid_roles: string[];
  }>

• Returns Promise<{
      valid_roles: string[];
  }>

  Deprecated

  Returns the metadata with regard to the user configuration.

  Use GET /v1/roles instead

  It will no longer be available after 01/11/2022. The role names can now be retrieved from the list roles endpoint.

removeFilter

• removeFilter(arg): Promise<{
      id: string;
      status: number;
  }[]>

• Parameters

  • arg: {
        filter: string;
    }

    • filter: string

  Returns Promise<{
      id: string;
      status: number;
  }[]>