Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

...

NameTypeDescription

Example

hashIterationsintegerHashing iteration value used by SOAJS hasher to encrypt/compare passwords12

optionalAlgorithm

string

Password Hashing algorithm name. "aes256" or "des".

You can go to List of Crypto Algorithms to find the name of the algorithm that you can use.

You do not need to set this configuration if you do not want to specify an algorithm

 aes256

More information can be found in the Complete Example

...

NameTypeDescriptionExample
validateJoinBooleanThis configuration controllers the status of a user after joining. aka ('pendingJoin' : 'active')
 
true
membershipObjectThis configuration allows you to configure different type of membership that can be set while joining to drive different user configuration like groups (make sure the groups is available). Should be an array of groups. 


Code Block
{
	"basic":{
		"groups": ["starter"]
	}
}


...

More information about Variables used, custom data fields used in "content", and examples of the configuration can be found under Mail Configuration

Examples: In provision

Code Block
languagejs
titleIn provision
"commonFields" : {
  "mail": { // to control the smtp configuration
      "from": 'me@localhost.com',
      "transport": {...}
  },
  "sms":{
	  "from": '16170000000',
      "twilio": {
         "accountSid": "WWWW",
         "authToken": "WWWW"
	  }
  }
},
"urac" : {
  "linkslink": {...}, // this object to control the links in the emails
  "mail": { // this object to control the content of the emails
    "join": {...}, // Join - mail content configuration
    "forgotPassword": {...}, // Forgot password mail - content configuration
    "addUser": {...}, // Add User - mail content configuration
    "changeUserStatus": {...}, // Change User Status - mail content configuration
    "changeEmail": {...} // Change Email - mail content configuration
  },
  "sms": {
	"inviteToJoin": {...}
  }	
}

Examples: In custom registry

You should create to entries under custom registry (one for mail, one for urac, and one for uracsms) as follow:

with the following configuration content:

...

Code Block
languagejs
titleURAC
{
  "linkslink": {...}, // this object to control the links in the emails
		"addUser": "...",
		"changeEmail": "...",
		"forgotPassword": "...",
		"inviteToJoin": "...",
		"join": "..."
	},
  "mail": { // this object to control the content of the emails
    "addUser": {...}, 
    "changeEmail": {...}, 
    "changePin": {...}, 
    "changeUserStatus": {...}, 
    "forgotPassword": {...}, 
    "invitePin": {...}, 
    "join": {...},
    "resetPin": {...}
	"inviteToJoin": {...}
  },
  "sms": {
	"inviteToJoin": {...}
  }		
}


Code Block
languagejs
titlesms
{ // to control the smtp configuration
      "from": '16170000000',
      "twilio": {...}
}


4. Mail token configuration

...

You can change the values of the below variable to turn on roaming among main tenants. Either you set masterCode or your set dbCodes.


NameTypeDescription

Example

masterCodeString

consolidate all main tenants' user under one master db and create roaming capabilities among them by invitation only. 

Also this will consolidate all tenants groups under one master db.

"TTTT"
autoRoamingObjectTo automatically allow roaming among main tenants


Code Block
languagejs
{
	"0000_TENANTID_TO_000": {
		"0000_TENANTID_FROM_000": {
			"groups": ["optional", "..."]
		}
	}
}


dbCodesObject

To consolidate

the

designated main

tenant

tenants' users and create roaming capabilities among them by invitation only. 

for example we have tenant TTT turning on roaming with tCODE1 and tCODE2

info


Code Block
languagejs
{

	"TTTT": ["tCODE1", "tCODE2"]

	"XXXX": ["tCODE4", "tCODE5"]

}