pod-sso-pkce v2.1.1

pod-sso-pkce

This package includes methods for using SSO POD (https://docs.pod.ir/v1.6.0.0/SSO/Introduction/149/SSO) by The PKCE method.

You can use this package in any frontend project.

Installation

Use npm to install the package:

npm i pod-sso-pkce

Notice: All data is stored in Local Storage.

Methods

authenticate()

After calling this method, your app will be redirected to the SSO POD.

authenticateWithAutologin()

Notice: You must enter 4 parameters in url query string: keyId, accessToken, timestamp, sign

Read this link for more information: https://docs.pod.ir/v1.6.0.0/SSO/User/8660/autologin

After calling this method, your app will be redirected to the SSO POD.

validate()

After calling this method, if the validation is successful, the user will be redirected to your target url (redirectUrlAfterValidate) but if it isn't, the onError event will occur.

refreshToken()

After calling this method, you can get a new access token with the getAccessToken() Method. the onError event will occurs if an error happens.

getAccessToken()

isAuthenticated()

This method is improving...

logout()

Usage

authenticate() Example

import { authenticate } from 'pod-sso-pkce';

function App() {
  const ssoURL = 'https://accounts.pod.ir/';
  const clientId = '20200000egh98412ea0a164708f109210';
  const redirectUrlSso = 'http://myapp.ir/validate';
  const ssoScope = 'profile email';

  // ...
  authenticate(ssoURL, clientId, redirectUrlSso, ssoScope);
  // ...
}

authenticateWithAutologin() Example

sample address: http://myapp.ir/autologin?access_token=123&key_id=456×tamp=789&signature=101112

import { authenticateWithAutologin } from 'pod-sso-pkce';

function App() {
  const ssoURL = 'https://accounts.pod.ir/';
  const clientId = '20200000egh98412ea0a164708f109210';
  const redirectUrlSso = 'http://myapp.ir/validate';
  const ssoScope = 'profile email';

  // ...
  authenticateWithAutologin(ssoURL, clientId, redirectUrlSso, ssoScope);
  // ...
}

validate() Example

import { validate } from 'pod-sso-pkce';

function App() {
  const ssoURL = 'https://accounts.pod.ir/';
  const clientId = '20200000egh98412ea0a164708f109210';
  const redirectUrlSso = 'http://myapp.ir/validate';
  const ssoScope = 'profile email';
  const redirectUrlAfterValidate = 'http://myapp.ir/mypanel';

  // ...
  validate(ssoURL, clientId, redirectUrlSso, redirectUrlAfterValidate, () => {
    console.log('error in validation');
  });
  // ...
}

refreshToken() Example

import { refreshToken, getAccessToken } from 'pod-sso-pkce';

async function fetch() {
  // ...
  if (error.response.status === 401) {
    await refreshToken({
      clientId: '20200000egh98412ea0a164708f109210',
      ssoURL: 'https://accounts.pod.ir/',
      onError: () => alert('something wrong'),
    });

    const accessToken = getAccessToken();
  }
  // ...
}

getAccessToken() Example

import { getAccessToken } from 'pod-sso-pkce';

function App() {
  // ...
  const accessToken = getAccessToken();
  // ...
}

isAuthenticated() Example

import { isAuthenticated } from 'pod-sso-pkce';

function App() {
  // ...
  if (isAuthenticated()) {
    alert('you are login.');
  } else {
    alert('you are not login');
  }
  // ...
}

logout() Example

import { logout } from 'pod-sso-pkce';

function App() {
  // ...
  logout('http://myapp.ir/home'); // :D
  // ...
}

LICENSE

MIT