A-Auth Authentication SDK for ADAAS SDKs

| LTS | Latest | npm | |---------------|----------|---------------------------| | v1.0.0 | v1.0.1 | @adaas/a-auth |

Table of Contents

• About the Project
• Quick Start
• ENV Variables
• Links

Overview

Using the SDKs provided within the ADF (Application Development Framework), ADAAS offers a suite of valuable tools for building applications within the ADAAS ecosystem. By leveraging these libraries, you can create a product-centric system with complete end-to-end control over all digital product development activities, including permissions management, authentication, delivery, analytics, marketing, and more.

Concept

There are 2 ways to use authentication with ADAAS Products and ADAAS SSO.

1. Act on behalf of user via Application
2. Act as an application (server-to-server)

The 1st option is needed when it's necessary to do some operations from user perspectives using users' permissions, roles and access. For example, using A-folder, In this case if user is going to create a new folder, or upload document it's important to act on users' behalf. The 2nd option is for the operations where user is not an initiator of the operation. For example if application needs to access user profile, or receive access_token -> then application auth should be used.

Therefore, it's important always to provide application credentials to authenticate an application. And then, optionally pass user token, if operation should be performed on user behalf.

Quick Start

Step 1: Install SDK

cd /your/project/location
adf
npm i @adaas/a-auth

Step 2: Provide Credentials

You can pass credentials through ENV variable or via code:

BASH

# Mandatory
ADAAS_API_CREDENTIALS_CLIENT_ID=ADAAS--client::769e6cb6597b...YOUR_ID...911f3060c161
ADAAS_API_CREDENTIALS_CLIENT_SECRET=ADAAS--secret::5ca6204b...YOUR_SECRET...e90c00a263f4db

In APPLICATION

const ADAAS_API_CREDENTIALS_CLIENT_ID = process.env.ADAAS_API_CREDENTIALS_CLIENT_ID!;
const ADAAS_API_CREDENTIALS_CLIENT_SECRET = process.env.ADAAS_API_CREDENTIALS_CLIENT_SECRET!
ADAAS_A_AUTH_Context.setCredentials(
    ADAAS_API_CREDENTIALS_CLIENT_ID,
    ADAAS_API_CREDENTIALS_CLIENT_SECRET

await ADAAS_A_AUTH_Context.authenticate();

Step 4: Start Using

By installing this app into your application then you will be able to access the ADAAS API or ADAAS products API via SSO

Environment Variables

| Variable Name | Required | Description | |---------------|----------|---------------------------| | ADAAS_API_CREDENTIALS_CLIENT_ID | YES | Your ADAAS API Credentials Key. Not mandatory in case when it's provided through the code | | ADAAS_API_CREDENTIALS_CLIENT_SECRET | YES | Your ADAAS Api Credentials Secret Not mandatory in case when it's provided through the code | | ADAAS_A_AUTH_CONFIG_SDK_VALIDATION | NO | Allows to ignore configurations validation | | ADAAS_A_AUTH_CONFIG_VERBOSE | NO | Allows to turn off extra library logs | | ADAAS_A_AUTH_CONFIG_IGNORE_ERRORS | NO | Allows to ignore error |

Links

• ADAAS Website
• Report Issues
• Become Future Creator