@frontegg/rest-api 3.0.126 → 3.0.127

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.126
+/** @license Frontegg v3.0.127
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.126
+/** @license Frontegg v3.0.127
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/users/index.js

@@ -9,6 +9,7 @@ exports.GetUserJwt = GetUserJwt;
 exports.getCurrentUserTenantsV3 = getCurrentUserTenantsV3;
 exports.getUsersGroups = getUsersGroups;
 exports.getUsersRoles = getUsersRoles;
+exports.getUsersV2 = getUsersV2;
 exports.getUsersV3 = getUsersV3;
 
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
@@ -21,6 +22,12 @@ async function GetUserJwt(body) {
   return (0, _fetch.Post)(`${_constants.urls.identity.users.v3}/me/token`, body);
 }
 
+async function getUsersV2(queryParams, options) {
+  return (0, _fetch.Get)(_constants.urls.identity.users.v2, queryParams, {
+    headers: (0, _fetch.extractHeadersFromOptions)(options)
+  });
+}
+
 async function getUsersV3(queryParams, options) {
   return (0, _fetch.Get)(_constants.urls.identity.users.v3, queryParams, {
     headers: (0, _fetch.extractHeadersFromOptions)(options)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.0.126",
+  "version": "3.0.127",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {

package/users/index.d.ts

@@ -1,6 +1,7 @@
-import { GetCurrentUserTenantsResponse, GetUserGroupsParams, GetUserGroupsResponse, GetUserJwtRequestDto, GetUserJwtResponseDto, GetUserRolesResponse, GetUsersRolesParams, ISearchUserQueryParamsV3, IUsersV3Data } from "./interfaces";
-import { FronteggPaginationWrapper, UserJwtOptions } from "../interfaces";
+import { GetCurrentUserTenantsResponse, GetUserGroupsParams, GetUserGroupsResponse, GetUserJwtRequestDto, GetUserJwtResponseDto, GetUserRolesResponse, GetUsersRolesParams, IGetUsersV2Response, ISearchUserQueryParamsV2, ISearchUserQueryParamsV3, IUsersV3Data } from './interfaces';
+import { FronteggPaginationWrapper, UserJwtOptions } from '../interfaces';
 export declare function GetUserJwt(body: GetUserJwtRequestDto): Promise<GetUserJwtResponseDto>;
+export declare function getUsersV2(queryParams: ISearchUserQueryParamsV2, options?: UserJwtOptions): Promise<FronteggPaginationWrapper<IGetUsersV2Response>>;
 export declare function getUsersV3(queryParams: ISearchUserQueryParamsV3, options?: UserJwtOptions): Promise<FronteggPaginationWrapper<IUsersV3Data>>;
 export declare function getUsersRoles(queryParams: GetUsersRolesParams, options?: UserJwtOptions): Promise<GetUserRolesResponse[]>;
 export declare function getUsersGroups(queryParams: GetUserGroupsParams, options?: UserJwtOptions): Promise<GetUserGroupsResponse[]>;

package/users/index.js

@@ -1,9 +1,14 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-import { extractHeadersFromOptions, Get, Post } from "../fetch";
-import { urls } from "../constants";
+import { extractHeadersFromOptions, Get, Post } from '../fetch';
+import { urls } from '../constants';
 export async function GetUserJwt(body) {
   return Post(`${urls.identity.users.v3}/me/token`, body);
 }
+export async function getUsersV2(queryParams, options) {
+  return Get(urls.identity.users.v2, queryParams, {
+    headers: extractHeadersFromOptions(options)
+  });
+}
 export async function getUsersV3(queryParams, options) {
   return Get(urls.identity.users.v3, queryParams, {
     headers: extractHeadersFromOptions(options)

package/users/interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationOrderEnum } from '../interfaces';
 import { ITenantsResponse } from '../tenants/interfaces';
+import { IRole } from '../roles/interfaces';
+import { ITeamUserPermission, UserManagedByEnum } from '../teams/interfaces';
+import { IGroupResponse } from '../groups/interfaces';
 export declare enum SortByEnum {
     createdAt = "createdAt",
     name = "name",
@@ -18,14 +21,21 @@ export interface GetUserJwtResponseDto {
     expires: string;
     expiresIn: number;
 }
-export interface ISearchUserQueryParamsV3 {
+export interface IGetUserQueryParams {
     _limit?: number;
     _offset?: number;
-    _email?: string;
-    _tenantId?: string;
     ids?: string;
     _sortBy?: SortByEnum;
     _order?: PaginationOrderEnum;
+}
+export interface ISearchUserQueryParamsV2 extends IGetUserQueryParams {
+    _filter?: string;
+    metadata?: string;
+    _includeSubTenants?: boolean;
+}
+export interface ISearchUserQueryParamsV3 extends IGetUserQueryParams {
+    _email?: string;
+    _tenantId?: string;
     _includeSubTenants?: boolean;
 }
 export interface IBaseUserData {
@@ -34,10 +44,14 @@ export interface IBaseUserData {
     name?: string;
     profilePictureUrl?: string;
 }
-export interface IUsersV3Data extends IBaseUserData {
-    sub?: string;
-    verified?: boolean;
-    mfaEnrolled?: boolean;
+export interface IUserTenantData {
+    tenantId: string;
+    roles: IRole[];
+}
+export interface IBaseGetUserResponse extends IBaseUserData {
+    sub: string;
+    verified: boolean;
+    mfaEnrolled: boolean;
     mfaBypass?: boolean;
     phoneNumber?: string;
     provider?: string;
@@ -45,13 +59,21 @@ export interface IUsersV3Data extends IBaseUserData {
     tenantIds?: string[];
     activatedForTenant?: boolean;
     isLocked?: boolean;
-    invisible?: boolean;
-    superUser?: boolean;
+    tenants: IUserTenantData[];
+    managedBy?: UserManagedByEnum;
+    invisible?: true;
+    superUser?: true;
     metadata?: string;
     createdAt?: Date;
     lastLogin?: Date;
     subAccountAccessAllowed?: boolean;
 }
+export interface IGetUsersV2Response extends IBaseGetUserResponse {
+    roles: IRole[];
+    permissions: ITeamUserPermission[];
+    groups?: Pick<IGroupResponse, 'id' | 'roles'>[];
+}
+export declare type IUsersV3Data = IBaseGetUserResponse;
 export interface GetUsersRolesParams {
     ids: string[];
 }