Function filterUsers

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

    Parameters

    • query: {
          fields?: string;
          limit?: number;
          next?: string;
          prev?: string;
          sort?: "name" | "-name" | "+name";
      }

      an object with query parameters

      • Optionalfields?: string

        A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.

      • Optionallimit?: number
      • Optionalnext?: string
      • Optionalprev?: string
      • Optionalsort?: "name" | "-name" | "+name"
    • body: Filter

      an object with the body content

    • Optionaloptions: ApiCallOptions

    Returns Promise<FilterUsersHttpResponse>

    FilterUsersHttpError