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

        The number of user entries to retrieve.

      • Optionalnext?: string

        Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with prev.

      • Optionalprev?: string

        Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with next.

      • Optionalsort?: "name" | "-name" | "+name"

        The field to sort by, with +/- prefix indicating sort order

    • body: Filter

      an object with the body content

    • Optionaloptions: ApiCallOptions

    Returns Promise<FilterUsersHttpResponse>

    FilterUsersHttpError