• authorizer-js
• Functions

Functions

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

Table of Contents

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

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. 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)

• It supports Implicit Flow

It accepts JSON object as a parameter with following keys

If session exists following keys are returned.

Response

Sample Usage

const res = 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.

Response

Sample Usage

const res = await authRef.getToken({
  response_type: 'code',
  response_mode: 'query',
})

- signup

Function to sign-up user using email and password.

It accepts JSON object as a parameter with following keys

Following is the response for signup function

Response

Sample Usage

const res = await authRef.signup({
  email: 'foo@bar.com',
  password: 'test',
  confirm_password: 'test',
})

- login

Function to login user using email and password.

It accepts JSON object as a parameter with following keys

Following is the response for login function

Response

Sample Usage

const res = 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 following keys

Response

Sample Usage

const res = 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.

Response

Sample Usage

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

- updateProfile

Function to update profile of user.

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

Response

Sample Usage

const res = 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 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.

Response

Sample Usage

const res = 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

Response

Sample Usage

const res = 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.

Response

Sample Usage

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

- getMetadata

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

Response

Sample Usage

const res 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.

Response

Sample Usage

// from browser with HTTP Cookie
const res = await authRef.getSession()
 
// role validation with http cookie
const res = await authRef.getSession(null, 'admin')
 
// from NodeJS / if HTTP cookie is not used
const res = 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

Response

Sample Usage

const res = 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.

Response

Sample Usage

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

- validateJWTToken

Function to validate jwt tokens.

It expects the JSON object as parameter with following parameters

Response

Sample Usage

const res = 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

Response

Sample Usage

const res = 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

Following is the response for verifyOtp function

Response

Sample Usage

const res = 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

Following is the response for resendOtp function

Response

Sample Usage

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