Before performing any operation, a user must first call the login operation. This will provide the library with a token which it will use to authenticate the user on the system.

Parameters for the login

• accountKey: the account of the account user belong
• userId: UserId of user in the system
• userSecret: userSecret of user in the system.

const { auth } = require("./index");

let token = await users.login(accountKey, userId, userSecret)

Requirement parameters to create a new user on the system

The Create Users function takes four parameters:

• accountId: the account of the account user belong
• role: role of the user in the system.
• email: email of the user in the system.
• username:username of user .

const { users } = require("./index");

let newUser = await users.create(accountId, role, username, email);

The update user Lib is responsible for updating the information of a specific user in the database

• accountId: the account of the account user belong
• role: role of the user in the system.
• email: email of the user in the system.
• username:username of user .

Code to create a new user :

const { users } = require("./index");
let updatedUser = await users.update(accountId, role, username, email);

A workspace acts as a container for your projects and allows you to manage different configurations for each project. It provides a separate space for managing different project configurations and enables developers to switch between projects without affecting the settings of other projects.

Paramaters to create a new configuration

workspaceId : domain for workspace
name : name of the workspace
displayName : account id of the account 
displayName : account id of the account 
type : VERIFICATION | AUTHORIZATION
//example of a  configuration for OAUTH type
socialProviders : [{
        "name" : "twitter|facebook|discord|linkedin|gitub",
        "clientId": "<clientId>",
        "clientSecret" : "<clientSecret>"
}],
blockchainAssets : [{
        "address" : "<contract adddress>",
        "type": "ERC20|ERC721|ERC1155",
        "id" : "<clientSecret>"
}]

Example for creating a new workspace

const { configuration } = require("./index");

let workspace = await workspace.create(workspaceId, name, displayName, type, providers);

** More about prodivers configurations here

Paramaters to create a new workspace

• domain: domain for workspace
• name: name of the workspace
• workspaceId: account id of the account
• status:A=active | X=cancelled .

Example for creating a new workspace

const { workspace } = require("./index");

let workspace = await workspace.update(workspaceId, domain, name, status);

When you create a workspace, you should provide the configuration for social profiles and blockchain assets.

Social provider you should supply the configuration socialProviders when you create the workspace, if workspace have any configuration for social provider using OAuth protocol.

You can setup the workspace configration for authorization and verification

• authorization : Allow users to log in only using a social media profile, and then retrieve their user profile information and tokens.
• verification : In addition to authorization, you can use social media profiles to request and verify additional parameters on the user's account.

Setup social profiles for authorization and verification you should supply the following params

{    
        name         : twitter|facebook|discord|linkedin|gitub",
        clientId     : <clientId>,
        clientSecret : <clientSecret>,
        type         : authorizer|verification     
        verficiation : {
                minimalFollowers : "1", // valid for twitter|facebook
                minimalPosts     : "1", / valid for twitter|facebook
                numberOfRepos     : "1", / valid for github
                numberOfReposForked     : "1", / valid for github
                numberOfReposStarred     : "1", / valid for github
                numberOfPostKarma    : "1", / valid for reddit
                numberOfCommentKarma    : "1", / valid for reddit
                numberOfawarderKarma    : "1", / valid for reddit
        }
}

In the workspace configuration, you can set up authorization and verification processes using both fungible and non-fungible tokens from the blockchain assets.

Setup blockchain assets for authorization and verification you should supply the following params :

{  
        iFungible    :  true|false",
        type         :  ERC20 | ERC721 | ERC1155 ,
        address      :  <contract address>
        verficiation : {
                   minimalAmount : minimalAmout to validate user flow,
                   amountOfNFT   : verify user flow if the amount is greather then this number (only valid for ERC721 and ERC1155),
                   byUniqueId  :  {
                                   id  : id of nft contract (only available for ERC721 and ERC1155) 
                                   qyt : minimal amount
                    }
}