External portal / Add external users

Add external users

When you've finished setting up a portal and its pages, you need to activate the named license package for external users. To do that, contact the sales rep you worked with when purchasing the system.

After that, add and invite external users to the company. Please note, that it is not necessary to add and invite manually users who sign in to the portal using SAML or through an external service with automatic registration enabled. It is enough to pass a link to the portal page to such users.

 

To add a user and invite them to the portal, follow these steps:

 

  1. Open the System apps workspace.
  2. Go to the External users page and click +External user in the upper right corner.
  3. In the window that opens, specify the required user information. By default, only the Full name field is required. All other fields can be filled in later.
  4. Click the Save button to complete the settings.

add_external_user_01

  1. After adding the user to the system, you need to generate a personal link that lets the user access the portal’s pages. To do this, go to the portal page and click +Invite a new user.
  2. In the window that opens, select the user you created by clicking the magnifying glass icon or add a new one.add-external-users-2
  • Without contact data confirmation. Select this option if you specified the user’s email when adding the user to the system. In this case, the user will not need to register to work with the portal. The link will take him or her directly to the sign-in page. If this option is not selected, the user clicking on the link will have to register first.
  • Update the link created earlier. This option allows you to generate a new invite link. The previous link will become invalid.
  1. After you fill out the form, click Get link, copy the invite link, and send it to the user.

 

Grant access to the portal

The personal invite link for an external user has no expiration date. The link allows the user to access only the portal he or she has been invited to. If the portal’s status is changed to Inactive, the user won’t be able to view its pages.

Grant access to several portals

You can add external users and manage their access to a portal using a script. This allows you to grant one user access to several portals. To do that, implement the following methods in the script used to create and manage an external user:

async function add(): Promise<void> {
  let profile = await Global.ns._system_catalogs.app._user_profiles.search().first();
  if (profile) {
      await Namespace.portal.addProfile(profile);
  }
}
 
async function del(): Promise<void> {
  let profile = await Global.ns._system_catalogs.app._user_profiles.search().first();
  if (profile) {
      await Namespace.portal.removeProfile(profile);
  }
}

Found a typo? Highlight the text, press ctrl + enter and notify us