3.2.5 • Published 9 months ago

@frontegg/rest-api v3.2.5

Weekly downloads
3,963
License
MIT
Repository
-
Last release
9 months ago

Usage

The APIs and states are available by using the using the frontegg rest-api are exposed via promises and interfaces such as the below:

import { someApi } from "@frontegg/rest-api";

await someApi();

Authentication APIs

Pre-login

import { preLogin } from '@frontegg/rest-api';

const redirectUrl = await preLogin({ email: 'john@doe.com' });
if (redirectUrl) {
  // Redirect to SSO
}

Returns if the user needs to be redirected to SSO based on email domain

Login

import { login } from '@frontegg/rest-api';

const loginResponse: {
  accessToken: string;
  refreshToken: string;
  expires: string;
  expiresIn: number;

  mfaRequired: boolean;
  mfaToken?: string; // for multi-factor authentication

  emailVerified?: boolean;
} = await login({ email, password });

Logs in the user using email and password and returns the JWT and refresh token.In case MFA is required the MFA token will be returned

Login with MFA

import { loginWithMfa } from '@frontegg/rest-api';

const loginResponse: {
  accessToken: string;
  refreshToken: string;
  expires: string;
  expiresIn: number;

  mfaRequired: boolean;
  mfaToken?: string; // for multi-factor authentication

  emailVerified?: boolean;
} = await loginWithMfa({ mfaToken, value });

Verifies the login using MFA token and value and gets the JWT token and the refresh token back

Activate account

import { activateAccount } from '@frontegg/rest-api';

await activateAccount({ userId, token, password });

Activates the users' account using the user ID, the token and the users' new password

Accept invitation to tenant

import { acceptInvitation } from '@frontegg/rest-api';

await acceptInvitation({ userId, token });

Accepts invitation of user to a new tenant and makes the user as active on that tenant

Refresh token

import { refreshToken } from '@frontegg/rest-api';

const loginResponse: {
  accessToken: string;
  refreshToken: string;
  expires: string;
  expiresIn: number;

  mfaRequired: boolean;
  mfaToken?: string; // for multi-factor authentication

  emailVerified?: boolean;
} = await refreshToken();

Refresh the current user authentication

Logout

import { logout } from '@frontegg/rest-api';

await logout();

Logs out the user and clears the refresh token

Forgot password

import { logout } from '@frontegg/rest-api';

await logout();

Logs out the user and clears the refresh token

Reset password

import { resetPassword } from '@frontegg/rest-api';

await logout({
  token,
  userId,
  password
});

Resets password based on token received from the forgot password flow

Recover MFA token

Allows the user to recover the MFA token

import { recoverMfaToken } from '@frontegg/rest-api';

await recoverMfaToken({
  email,
  recoveryCode
});
@babel/runtime@frontegg/entitlements-javascript-commons
@everything-registry/sub-chunk-343@frontegg/vue-core@frontegg/ionic-capacitor@frontegg/redux-store@infinitebrahmanuniverse/nolb-_fro@zalastax/nolb-_fro
3.2.2

9 months ago

3.2.5

9 months ago

3.2.4

9 months ago

3.2.3

9 months ago

3.2.2-alpha.11551682009

9 months ago

3.2.1

12 months ago

3.2.0

12 months ago

3.1.78

1 year ago

3.1.74

1 year ago

3.1.76

1 year ago

3.1.75

1 year ago

3.1.74-alpha.9437859720

1 year ago

3.1.74-alpha.9437937621

1 year ago

3.1.79-alpha.10029056154

1 year ago

3.1.74-alpha.9436935127

1 year ago

3.1.76-alpha.9794353373

1 year ago

3.1.76-alpha.9762981322

1 year ago

3.1.79-alpha.9987430273

1 year ago

3.1.76-alpha.9502349697

1 year ago

3.1.74-alpha.9446418922

1 year ago

3.1.74-alpha.9436511986

1 year ago

3.1.78-alpha.9957739104

1 year ago

3.1.74-alpha.9446693332

1 year ago

3.1.73

1 year ago

3.1.72

1 year ago

3.1.71

1 year ago

3.1.70

1 year ago

3.1.69

1 year ago

3.1.68

1 year ago

3.1.67

1 year ago

3.1.66

1 year ago

3.1.65

1 year ago

3.1.64

1 year ago

3.1.63

1 year ago

3.1.62

1 year ago

3.1.61

1 year ago

3.1.60

1 year ago

3.1.59

2 years ago

3.1.58

2 years ago

3.1.57

2 years ago

3.1.56

2 years ago

3.1.55

2 years ago

3.1.54

2 years ago

3.1.53

2 years ago

3.1.52

2 years ago

3.1.51

2 years ago

3.1.50

2 years ago

3.1.49

2 years ago

3.1.34

2 years ago

3.1.33

2 years ago

3.1.36

2 years ago

3.1.35

2 years ago

3.1.38

2 years ago

3.1.37

2 years ago

3.1.39

2 years ago

3.1.30

2 years ago

3.1.32

2 years ago

3.1.31

2 years ago

3.1.45

2 years ago

3.1.3

2 years ago

3.1.44

2 years ago

3.1.2

2 years ago

3.1.47

2 years ago

3.1.1

2 years ago

3.1.46

2 years ago

3.1.7

2 years ago

3.1.48

2 years ago

3.1.6

2 years ago

3.1.5

2 years ago

3.1.4

2 years ago

3.1.41

2 years ago

3.1.40

2 years ago

3.1.43

2 years ago

3.1.42

2 years ago

3.1.9

2 years ago

3.1.8

2 years ago

3.0.141

2 years ago

3.0.140

2 years ago

3.0.134

2 years ago

3.0.133

2 years ago

3.0.136

2 years ago

3.0.135

2 years ago

3.0.138

2 years ago

3.0.137

2 years ago

3.0.139

2 years ago

3.0.132

2 years ago

3.0.131

2 years ago

3.1.12

2 years ago

3.1.11

2 years ago

3.1.14

2 years ago

3.1.13

2 years ago

3.1.16

2 years ago

3.1.15

2 years ago

3.1.18

2 years ago

3.1.17

2 years ago

3.1.10

2 years ago

3.1.23

2 years ago

3.1.22

2 years ago

3.1.25

2 years ago

3.1.24

2 years ago

3.1.27

2 years ago

3.1.26

2 years ago

3.1.29

2 years ago

3.1.28

2 years ago

3.1.21

2 years ago

3.1.20

2 years ago

3.1.19

2 years ago

3.0.128

2 years ago

3.0.130

2 years ago

3.0.119

2 years ago

3.0.123

2 years ago

3.0.122

2 years ago

3.0.125

2 years ago

3.0.124

2 years ago

3.0.127

2 years ago

3.0.126

2 years ago

3.0.121

2 years ago

3.0.120

2 years ago

3.0.118

2 years ago

3.0.117

2 years ago

3.0.116

2 years ago

3.0.98

2 years ago

3.0.99

2 years ago

3.0.96

2 years ago

3.0.97

2 years ago

3.0.109

2 years ago

3.0.108

2 years ago

3.0.112

2 years ago

3.0.111

2 years ago

3.0.114

2 years ago

3.0.113

2 years ago

3.0.115

2 years ago

3.0.110

2 years ago

3.0.101

2 years ago

3.0.100

2 years ago

3.0.103

2 years ago

3.0.102

2 years ago

3.0.105

2 years ago

3.0.104

2 years ago

3.0.107

2 years ago

3.0.106

2 years ago

3.0.89

2 years ago

3.0.92

2 years ago

3.0.93

2 years ago

3.0.90

2 years ago

3.0.91

2 years ago

3.0.94

2 years ago

3.0.95

2 years ago

3.0.88

2 years ago

3.0.87

2 years ago

3.0.85

2 years ago

3.0.86

2 years ago

3.0.83

2 years ago

3.0.84

2 years ago

3.0.82

2 years ago

3.0.81

2 years ago

3.0.80

2 years ago

3.0.78

2 years ago

3.0.79

2 years ago

3.0.76

2 years ago

3.0.77

2 years ago

3.0.75

2 years ago

3.0.67

3 years ago

3.0.68

3 years ago

3.0.65

3 years ago

3.0.69

3 years ago

3.0.64

3 years ago

3.0.70

3 years ago

3.0.71

3 years ago

3.0.74

2 years ago

3.0.73

2 years ago

3.0.60

3 years ago

3.0.63

3 years ago

3.0.61

3 years ago

3.0.62

3 years ago

3.0.45

3 years ago

3.0.46

3 years ago

3.0.43

3 years ago

3.0.44

3 years ago

3.0.49

3 years ago

3.0.47

3 years ago

3.0.48

3 years ago

3.0.41

3 years ago

3.0.42

3 years ago

3.0.40

3 years ago

3.0.56

3 years ago

3.0.57

3 years ago

3.0.54

3 years ago

3.0.55

3 years ago

3.0.58

3 years ago

3.0.59

3 years ago

3.0.52

3 years ago

3.0.53

3 years ago

3.0.50

3 years ago

3.0.51

3 years ago

3.0.34

3 years ago

3.0.35

3 years ago

3.0.32

3 years ago

3.0.33

3 years ago

3.0.38

3 years ago

3.0.39

3 years ago

3.0.36

3 years ago

3.0.37

3 years ago

3.0.31

3 years ago

3.0.30

3 years ago

3.0.12

3 years ago

3.0.13

3 years ago

3.0.16

3 years ago

3.0.17

3 years ago

3.0.14

3 years ago

3.0.15

3 years ago

3.0.23

3 years ago

3.0.24

3 years ago

3.0.21

3 years ago

3.0.22

3 years ago

3.0.27

3 years ago

3.0.28

3 years ago

3.0.25

3 years ago

3.0.26

3 years ago

3.0.20

3 years ago

3.0.18

3 years ago

3.0.19

3 years ago

3.0.29

3 years ago

3.0.4

3 years ago

3.0.3

3 years ago

3.0.2

3 years ago

3.0.1

3 years ago

3.0.8

3 years ago

3.0.7

3 years ago

3.0.6

3 years ago

3.0.5

3 years ago

6.0.1-alpha.0

3 years ago

6.0.1-alpha.1

3 years ago

3.0.9

3 years ago

6.0.1-alpha.2

3 years ago

6.0.1-alpha.3

3 years ago

6.0.1-alpha.4

3 years ago

6.0.1-alpha.5

3 years ago

3.0.10

3 years ago

3.0.11

3 years ago

2.10.90

3 years ago

2.10.73

3 years ago

2.10.74

3 years ago

2.10.75

3 years ago

2.10.76

3 years ago

2.10.77

3 years ago

2.10.78

3 years ago

2.10.79

3 years ago

2.10.80

3 years ago

2.10.81

3 years ago

2.10.82

3 years ago

2.10.83

3 years ago

2.10.84

3 years ago

2.10.85

3 years ago

2.10.86

3 years ago

2.10.87

3 years ago

2.10.88

3 years ago

2.10.89

3 years ago

2.10.70

3 years ago

2.10.71

3 years ago

2.10.72

3 years ago

2.10.67

3 years ago

2.10.68

3 years ago

2.10.69

3 years ago

2.10.66

3 years ago

2.10.62

3 years ago

2.10.63

3 years ago

2.10.64

3 years ago

2.10.65

3 years ago

2.10.50

4 years ago

2.10.51

4 years ago

2.10.52

3 years ago

2.10.53

3 years ago

2.10.54

3 years ago

2.10.55

3 years ago

2.10.56

3 years ago

2.10.57

3 years ago

2.10.58

3 years ago

2.10.59

3 years ago

2.10.60

3 years ago

2.10.61

3 years ago

2.10.48

4 years ago

2.10.49

4 years ago

2.10.46

4 years ago

2.10.47

4 years ago

2.10.45

4 years ago

2.10.33

4 years ago

2.10.34

4 years ago

2.10.35

4 years ago

2.10.36

4 years ago

2.10.37

4 years ago

2.10.38

4 years ago

2.10.39

4 years ago

2.10.40

4 years ago

2.10.41

4 years ago

2.10.42

4 years ago

2.10.43

4 years ago

2.10.44

4 years ago

2.10.31

4 years ago

2.10.32

4 years ago

2.10.30

4 years ago

2.10.28

4 years ago

2.10.29

4 years ago

2.10.27

4 years ago

2.10.26

4 years ago

2.10.25

4 years ago

2.10.23

4 years ago

2.10.24

4 years ago

2.10.22

4 years ago

2.10.21

4 years ago

2.10.20

4 years ago

2.10.18

4 years ago

2.10.19

4 years ago

2.10.17

4 years ago

2.10.16

4 years ago

2.10.15

4 years ago

2.10.11

4 years ago

2.10.12

4 years ago

2.10.13

4 years ago

2.10.14

4 years ago

2.10.10

4 years ago

2.10.9

4 years ago

2.10.8

4 years ago

2.10.7

4 years ago

2.10.5

4 years ago

2.10.6

4 years ago

2.10.2

4 years ago

2.10.3

4 years ago

2.10.4

4 years ago

2.10.1

4 years ago

2.10.0

4 years ago

2.8.12-alpha.1026855354

4 years ago

2.8.12-alpha.1026182852

4 years ago

2.8.12-alpha.1026286684

4 years ago

2.8.12-alpha.1023706555

4 years ago

2.8.12-alpha.1023306250

4 years ago

2.8.12-alpha.1023020700

4 years ago

2.8.12-alpha.1023100770

4 years ago

2.8.11-alpha.1019811623

4 years ago

2.8.12-alpha.1020133779

4 years ago

2.8.10-alpha.1012973212

4 years ago

2.8.9-alpha.1011326366

4 years ago

2.8.10-alpha.1012542879

4 years ago

2.8.10

4 years ago

2.8.8-alpha.1004770099

4 years ago

2.8.8-alpha.1004488675

4 years ago

2.8.8

4 years ago

2.8.9-alpha.1008579817

4 years ago

2.8.5-alpha.986508723

4 years ago

2.8.7-alpha.990441763

4 years ago

2.8.6-alpha.986850529

4 years ago

2.8.7

4 years ago

2.8.8-alpha.990590960

4 years ago

2.8.7-alpha.987278693

4 years ago

2.8.8-alpha.993988844

4 years ago

2.8.4

4 years ago

2.8.4-alpha.983085154

4 years ago

2.8.4-alpha.979228781

4 years ago

2.8.4-alpha.979711827

4 years ago

2.8.4-alpha.967546081

4 years ago

2.8.3-alpha.963749949

4 years ago

2.8.3

4 years ago

2.8.0-alpha.958143646

4 years ago

2.8.0-alpha.956868304

4 years ago

2.8.1-alpha.960240419

4 years ago

2.7.2-alpha.935485629

4 years ago

2.8.0-alpha.938925036

4 years ago

2.7.1-alpha.925133008

4 years ago

2.7.0-alpha.914147646

4 years ago

2.7.0-alpha.899223383

4 years ago

2.7.0

4 years ago

2.6.0-alpha.882605840

4 years ago

2.7.0-alpha.899153200

4 years ago

2.6.0

4 years ago

2.5.3-alpha.882304930

4 years ago

2.6.1-alpha.899063235

4 years ago

2.6.0-alpha.882306679

4 years ago

2.4.0

4 years ago

2.2.0-alpha.790159397

4 years ago

2.3.2-alpha.828572963

4 years ago

2.3.1-alpha.827337977

4 years ago

2.2.1-alpha.792439675

4 years ago

2.1.1-alpha.786143057

4 years ago

2.3.0-alpha.821142638

4 years ago

2.1.1-alpha.775775142

4 years ago

2.1.1-alpha.773827200

4 years ago

2.5.2-alpha.871326220

4 years ago

2.3.3-alpha.837786371

4 years ago

2.3.3-alpha.837513818

4 years ago

2.2.0-alpha.788357573

4 years ago

2.2.0

4 years ago

2.2.0-alpha.791934138

4 years ago

2.3.0-alpha.820290670

4 years ago

2.2.3-alpha.797626993

4 years ago

2.4.0-alpha.856517865

4 years ago

2.2.0-alpha.790043453

4 years ago

2.5.1-alpha.868632822

4 years ago

2.2.1-alpha.793005583

4 years ago

2.2.0-alpha.789152436

4 years ago

2.5.0-alpha.863482872

4 years ago

2.2.2-alpha.795563073

4 years ago

2.3.3-alpha.856481136

4 years ago

2.2.3-alpha.810138578

4 years ago

2.4.1-alpha.859673669

4 years ago

2.3.1-alpha.827685404

4 years ago

2.1.1-alpha.781999836

4 years ago

2.5.2

4 years ago

2.5.1

4 years ago

2.1.1-alpha.782426431

4 years ago

2.2.1-alpha.792661052

4 years ago

2.1.0-alpha.744215280

4 years ago

2.0.1-alpha.742050278

4 years ago

2.0.0-alpha.738285093

4 years ago

2.0.0

4 years ago

2.0.0-alpha.730990828

4 years ago

2.0.0-alpha.727232343

4 years ago

2.0.0-alpha.725856734

4 years ago

1.29.0-alpha.723476529

4 years ago

1.29.0-alpha.721990103

4 years ago

1.28.0-alpha-split-store

4 years ago

1.28.1-alpha.716537410

4 years ago

1.28.1-alpha.716560112

4 years ago

1.28.1-alpha-split-store

4 years ago

1.28.1-alpha.708303059

4 years ago

1.28.1-alpha.701085574

4 years ago

1.23.40

4 years ago

1.28.0-alpha.673342838

4 years ago

1.23.33

4 years ago

1.25.0-rescript

4 years ago

1.28.1-alpha.678939834

4 years ago

1.28.0

4 years ago

1.28.0-alpha.676463738

4 years ago

1.27.1-alpha.672924481

4 years ago

1.28.0-alpha.672930808

4 years ago

1.28.0-alpha.672929095

4 years ago

1.28.0-alpha.672928030

4 years ago

1.27.1-alpha.672923001

4 years ago

1.26.0

4 years ago

1.26.0-alpha.661751845

4 years ago

1.27.0-alpha.664863047

4 years ago

1.25.1-alpha.660279344

4 years ago

1.23.31

4 years ago

1.23.30

4 years ago

1.23.26

4 years ago

1.23.25

4 years ago

1.25.0

4 years ago

1.25.1-alpha.629538014

4 years ago

1.25.0-alpha.629485945

4 years ago

1.23.24

4 years ago

1.23.21

4 years ago

1.25.0-alpha.620697613

4 years ago

1.24.0

4 years ago

1.23.20

4 years ago

1.24.0-alpha.617618743

4 years ago

1.23.2-alpha.617433979

4 years ago

1.23.2-alpha.613938967

4 years ago

1.23.2

4 years ago

1.23.1-alpha.587087774

4 years ago

1.23.0

4 years ago

1.23.0-alpha.577624310

4 years ago

1.21.5

4 years ago

1.22.1-alpha.572353583

4 years ago

1.22.1

4 years ago

1.22.0

4 years ago

1.22.0-alpha.564239886

4 years ago

1.21.4

4 years ago

1.21.3

4 years ago

1.22.0-alpha.555630737

4 years ago

1.22.0-alpha.555617041

4 years ago

1.22.0-alpha.545249945

4 years ago

1.22.0-alpha.543345108

4 years ago

1.21.1

4 years ago

1.21.1-alpha.538218409

4 years ago

1.21.0

4 years ago

1.21.0-alpha.537970912

4 years ago

1.21.0-alpha.536840932

4 years ago

1.20.2-alpha.530740511

4 years ago

1.20.2-alpha.530574241

4 years ago

1.21.0-alpha.531249694

4 years ago

1.21.0-alpha.532252960

4 years ago

1.20.1-alpha.530302644

4 years ago

1.20.1

4 years ago

1.20.0-alpha.527080678

4 years ago

1.20.0

4 years ago

1.20.0-alpha.527035244

4 years ago

1.20.0-alpha.524019846

4 years ago

1.20.0-alpha.516650307

4 years ago

1.19.2-alpha.514634176

4 years ago

1.19.2-alpha.511499957

4 years ago

1.19.2-alpha.509096374

5 years ago

1.19.2-alpha.509201375

5 years ago

1.19.2-alpha.504029797

5 years ago

1.19.2-alpha.504022749

5 years ago

1.19.2-alpha.503235414

5 years ago

1.19.1

5 years ago

1.19.0

5 years ago

1.19.1-alpha.499171422

5 years ago

1.19.0-alpha.497924979

5 years ago

1.19.0-alpha.497462984

5 years ago

1.18.6

5 years ago

1.18.7-alpha.497456426

5 years ago

1.18.6-alpha.496425254

5 years ago

1.18.6-alpha.495927102

5 years ago

1.18.6-alpha.495730538

5 years ago

1.18.5

5 years ago

1.18.4

5 years ago

1.18.4-alpha.493052959

5 years ago

1.18.5-alpha.494035443

5 years ago

1.18.5-alpha.494109555

5 years ago

1.18.3

5 years ago

1.18.2

5 years ago

1.18.3-alpha.491700996

5 years ago

1.18.4-alpha.492209301

5 years ago

1.18.1

5 years ago

1.18.1-alpha.487308957

5 years ago

1.18.2-alpha.488809971

5 years ago

1.18.0-alpha.485344359

5 years ago

1.18.0

5 years ago

1.17.4-alpha.485129954

5 years ago

1.17.4-alpha.485261207

5 years ago

1.17.3-alpha.482424414

5 years ago

1.17.3

5 years ago

1.17.4-alpha.483194055

5 years ago

1.17.2

5 years ago

1.17.2-alpha.480198362

5 years ago

1.17.1

5 years ago

1.17.1-alpha.464206775

5 years ago

1.17.1-alpha.464245633

5 years ago

1.17.0

5 years ago

1.17.0-alpha.459333635

5 years ago

1.17.0-alpha.453281936

5 years ago

1.17.0-alpha.452408979

5 years ago

1.17.0-alpha.451455795

5 years ago

1.17.0-alpha.450729746

5 years ago

1.17.0-alpha.448727561

5 years ago

1.16.2

5 years ago

1.16.2-alpha.447792251

5 years ago

1.16.1-alpha.447786092

5 years ago

1.16.1-alpha.447759429

5 years ago

1.16.1-alpha.447528786

5 years ago

1.16.1-alpha.447366100

5 years ago

1.16.1-alpha.447338306

5 years ago

1.15.2

5 years ago

1.16.0

5 years ago

1.15.1

5 years ago

1.15.1-alpha.434503369

5 years ago

1.15.0

5 years ago

1.14.2-alpha.433815765

5 years ago

1.14.1

5 years ago

1.14.1-alpha.428491416

5 years ago

1.14.0

5 years ago

1.13.2

5 years ago

1.13.1

5 years ago

1.13.0

5 years ago

1.12.0

5 years ago

1.11.1

5 years ago

1.11.0

5 years ago

1.10.1

5 years ago

1.10.0

5 years ago

1.9.0

5 years ago

1.8.0

5 years ago

1.7.0

5 years ago

1.6.1

5 years ago

1.6.0

5 years ago

1.5.0

5 years ago

1.4.0

5 years ago

1.3.0

5 years ago

1.3.1-alpha.0

5 years ago