Versions Compared

Key

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

Introduction

...

2. 3rd party login configuration

URAC allows third party login via one of the below methods:

  1. Passport Login: Define application keys for passport integration. Currently supporting Azure, Github, Twitter, Facebook, and Google. 

...

  1. Got to the link for more information and an example of the configuration

...

  1. .
  2. OpenAM login: SSO (Single Sign-On).
  3. LDAP (Lightweight Directory Access Protocol) login: Active directory login.

3. Mail Configuration

Mail configuration can be found under two configuration objects:

  1. Under common fields in order to be used in other microservices not only in URAC. This includes the transport configuration for the mail provider.
  2. Under URAC configuration in order to customize mail options to handle URAC requirements. This includes links and content of emails sent in each stage.


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

Examples: 

Code Block
languagejs
titleMail Configuration in Common Fields
"commonFields" : {
 
  "mail" : { 				// to control the smtp configuration
			}
}

"urac" : {
	// this object to control the links in the emails
	"links": {...}

	// this object to control the content of the emails
	"mail": {
		"join": {... //this is the join email content configuration}
		"forgotPassword": {... //}
	}
}

"mail":
{         "from": 'me@localhost.com',
    "transport":
{     "type": "sendmail",
    "options"transport": {...}
  }
}


Code Block
languagejs
titleMail Configuration in URAC Config
"mailurac" : { //urac mail options
  "joinlinks": {...}, // this object to "subject": 'Welcome to SOAJS',
    "path": "./mail/urac/join.tmpl"
  },
  "forgotPassword"control the links in the emails
  "mail": { // this object to "subject": 'Reset Your Password at SOAJS',control the content of the emails
    "pathjoin": "./mail/urac/forgotPassword.tmpl"
  {...}, // Join "addUser": {
 - mail content configuration
  "subject": 'Account Created at SOAJS',
    "path"forgotPassword": "./mail/urac/addUser.tmpl"
  },
  "changeUserStatus": {{...}, // Forgot password mail - content configuration
     "subjectaddUser": "Account Status changed at SOAJS",
    //use custom HTML{...}, // Add User - mail content configuration
    "contentchangeUserStatus": "<p>Dear <b>{{ username }}</b>, <br />Your account status has changed to <b>{{ status }}</b> by the administrator on {{ ts|date('F jS, Y') }}.<br /><br /> Regards,<br/> SOAJS Team. </p>"
  },{...}, // Change User Status - mail content configuration
    "changeEmail": {
    "subject": "Change Account Email at SOAJS",
    "path": "./mail/urac/changeEmail.tmpl"...} // Change Email - mail content configuration
  }	
}

...

4. Pin login configuration

Pin configuration is made to add code adds a second layer of authentication to URAC. For example, having restaurants with multiple branches and multiple positions. User should put a password and should use a pin code to gain access. For full information go to Pin Configuration.

5. Data configuration

Resources and database creation steps can be found under Database needed by URAC. More information can be found under the registry configuration layer below.

...



Name


Local Configuration (Default)

config.js

Registry Configuration (Per Environment)

req.soajs.registry


Tenant Configuration (Per Tenant Per Environment)

SettingsCustom
pinConfiguration
model¹"mongo"

hashIterations

24

seedLength12

model¹: We currently only support mongo models.

...