Functions

@authorizerdev/authorizer-js (opens in a new tab) SDK comes with bunch of utility functions, that you can use to perform various operations without worrying about the API details.

Migration Guide from 1.x -> 2.x

2.x version of @authorizerdev/authorizer-js has a uniform response structure that will help your applications to get right error codes and success response. Methods here have {data, errors} as response objects for methods of this library.

For 1.x version of this library you can get only data in response and error would be thrown so you had to handle that in catch.

Table of Contents

• authorize
• getToken
• login
• signup
• verifyEmail
• getProfile
• updateProfile
• forgotPassword
• resetPassword
• oauthLogin
• magicLinkLogin
• getMetadata
• getSession
• revokeToken
• logout
• validateJWTToken
• validateSession
• verifyOtp
• resendOtp
• deactivateAccount

These functions can be invoked using the Authorizer instance:

const authRef = new Authorizer({
  authorizerURL: 'YOUR_AUTHORIZER_INSTANCE_URL',
  redirectURL: window.location.origin,
  clientID: 'YOUR_CLIENT_ID',
})

- authorize

Function to auto login from browser using the builtin UI of authorizer. It checks for session, if available returns the token information, else redirects to login page.

• It supports PKCE flow (opens in a new tab). This will help user to perform authentication and authorization in safe memory and prevent from CSRF attack. It also enables perform authorization with safety on mobile applications (Tried and tested with Expo AuthSession (opens in a new tab))

• It supports Implicit Flow (opens in a new tab)

It accepts JSON object as a parameter with following keys

If session exists following keys are returned in data object.

Response

Sample Usage

const { data, errors } = await authRef.authorize({
  response_type: 'code',
  response_mode: 'query',
})

- getToken

Function to get token information based on code / refresh_token

It accepts JSON object as a parameter with following keys

If session exists following keys are returned in the data object.

Response

Sample Usage

// for web apps
const { data, errors } = await authRef.getToken({
  response_type: 'code',
  response_mode: 'query',
})
 
// for mobile applications / desktop apps
const { data, errors } = await authRef.getToken({
  grant_type: 'refresh_token',
  refresh_token:
    'your refresh_token from login (should store in memmory such as store, variables)',
})

- signup

Function to sign-up user using email and password.

It accepts JSON object as a parameter with the following keys

Following is the response for the signup in the data object

Response

Sample Usage

const { data, errors } = await authRef.signup({
  email: 'foo@bar.com',
  password: 'test',
  confirm_password: 'test',
  scope: ['offline_access'], // for refresh token
})

- login

Function to login user using email and password.

It accepts JSON object as a parameter with the following keys

Following is the response for login in the data object

Response

Sample Usage

const { data, errors } = await authRef.login({
  email: 'foo@bar.com',
  password: 'test',
})

- verifyEmail

Function to verify email address of user when they signup.

It accepts JSON object as a parameter with following keys

This mutation returns AuthResponse type with the following keys in the data object

Response

Sample Usage

const { data, errors } = await authRef.verifyEmail({
  token: `some_token`,
})

- getProfile

Function to get profile of user. This function makes an authorized request, hence if it is used from the browser the HTTP cookie is sent if user has logged in else you need to pass headers object.

It accepts the optional JSON object as parameter, you can pass the HTTP Headers there.

It returns the following keys in response data object

Response

Sample Usage

// from browser if HTTP cookie is present
const { data, errors } = await authRef.getProfile()
 
// from NodeJS / if HTTP cookie is not used
const { data, errors } = await authRef.getProfile({
  Authorization: `Bearer ${token}`,
})

- updateProfile

Function to update profile of user. This function makes an authorized request, hence if it is used from the browser the HTTP cookie is sent if user has logged in else you need to pass headers object.

It accepts 2 JSON object as its parameters.

1. data - User data that needs to be updated
2. headers - To pass Authorization header

Here are the keys that data object accepts

Here is sample of headers object

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.updateProfile(
  {
    given_name: `bob`,
  },
  {
    Authorization: `Bearer some_token`,
  },
)

- forgotPassword

Function that can be used in case if user has forgotten their password. Forgot password is 2 step process.

Step 1: Send email to registered user Step 2: Reset password.

This function is Step 1 process.

It accepts JSON object as parameter with the following keys

Note: You will need a SMTP server with an email address and password configured as authorizer environment using which system can send emails.

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.forgotPassword({
  email: 'foo@bar.com',
})

- resetPassword

Function to reset password. This is the step 2 of forgot password process.

It accepts JSON object as a parameter with following keys

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.resetPassword({
  token: `some_token`,
})

- oauthLogin

Function to login using OAuth Providers. This is mainly used in browser as user is redirect to respective oauth platform.

Note only enabled oauth providers can be used here. To get the information about enabled oauth provider you can use getMetadata function

It supports optional argument for role based login

Sample Usage

await authRef.oauthLogin('google')
 
// login with specific role
await authRef.oauthLogin('google', 'admin')

- magicLinkLogin

Function to perform password less login.

Note: You will need a SMTP server with an email address and password configured as authorizer environment using which system can send emails.

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.magicLinkLogin({
  email: 'foo@bar.com',
})

- getMetadata

Function to get meta information about your authorizer instance. eg, version, configurations, etc

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } await authRef.getMetadata()

- getSession

Function to get session information. This function makes an authorized request, hence if it is used from the browser the HTTP cookie is sent if user has logged in else you need to pass headers object.

It accepts the optional JSON object as parameter, you can pass the HTTP Headers there. Optionally you can also validate the roles against the given token by passing the roles as second argument to function.

It returns the following keys in response data object

Response

Sample Usage

// from browser with HTTP Cookie
const { data, errors } = await authRef.getSession()
 
// role validation with http cookie
const { data, errors } = await authRef.getSession(null, 'admin')
 
// from NodeJS / if HTTP cookie is not used
const { data, errors } = await authRef.getSession(
  {
    Authorization: `Bearer some_token`,
  },
  'admin',
)

- revokeToken

Function to revoke refresh token. It accepts json object as its parameter with following keys

JSON Object

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.revokeToken({
  refresh_token: 'foo',
})

- logout

Function to logout user. This function makes an authorized request, hence if it is used from the browser the HTTP cookie is sent if user has logged in else you need to pass headers object.

It accepts the optional JSON object as parameter, you can pass the HTTP Headers there.

It returns the following keys in response data object

Response

Sample Usage

// from browser with HTTP Cookie
const { data, errors } = await authRef.logout()
 
// from NodeJS / if HTTP cookie is not used
const { data, errors } = await authRef.logout({
  Authorization: `Bearer some_token`,
})

- validateJWTToken

Function to validate jwt tokens.

It expects the JSON object as parameter with following parameters

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.validateJWTToken({
  token_type: `access_token`
  token: `some jwt token string`
})

- validateSession

Function to validate cookie / browser session.

It expects the JSON object as parameter with following parameters

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.validateSession({
  cookie: ``,
})

- verifyOtp

Function to verify OTP sent to the user when they login.

It accepts JSON object as a parameter with following keys

Either email or phone_number is required

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.verifyOtp({
  email: 'foo@bar.com',
  otp: 'AB123C',
})

- resendOtp

Function to resend OTP to the user.

It accepts JSON object as a parameter with following keys

Either email or phone_number is required

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.resendOtp({
  email: 'foo@bar.com',
})

- deactivateAccount

Function to deactivate user account. This function makes an authorized request, hence if it is used from the browser the HTTP cookie is sent if user has logged in else you need to pass headers object.

It accepts 1 JSON object as its parameters.

1. headers - To pass Authorization header

Here is sample of headers object

It returns the following keys in response data object

Response

Sample Usage

const { data, errors } = await authRef.deactivateAccount({
  Authorization: `Bearer some_token`,
})