Versions Compared

Key

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

...

This page is for PhixFlow administrators who want to integrate PhixFlow authentication with an external login system. It describes how to configure the external login groups in System Configuration and how to map external user groups to PhixFlow's User Groups. See Active Directory or SAML / Single Sign-on for details about configuring external login.

Insert excerpt
_admin_user_topic
_admin_user_topic
nopaneltrue

Overview

PhixFlow can be configured to allow external logins, where users are authenticated by external servers i.e. the user's credentials (username/password) are maintained on external servers and PhixFlow delegates to those external servers to check whether the user's credentials are valid. Currently we support Active Directory and SAML / Single sign-on.

In order to login to a PhixFlow instance, an

...

external user must have an external group

...

that matches the PhixFlow instance's external login group, which is set in System Configuration.

...


Panel
borderColor#7da054
titleColorwhite
titleBGColor#7da054
borderStylesolid
titleSections on this page

Table of Contents
indent12px
stylenone


When an external user logs in, PhixFlow creates a minimal user account for them, including:

  • their user name
  • a default locale, copied from the System Configuration → General Settings → System Locale.

Using External User Templates

Optionally, you can create one or more external user templates to set additional defaults for the user account that PhixFlow. For example, you can specify whether or not the user opens PhixFlow in App Mode or Design Mode. You can also set a default application for the user; see External User Template.

User Groups and Privileges

In PhixFlow local users are manually added to user groups. A user's privileges depend on the user groups to which they belong. For external users, their privileges depend on how you map the user groups in the external system (e.g. their Active Directory groups) to PhixFlow user groups; see Managing User Groups

...

This document describes how to configure the external login group in System Configuration and how to map external user groups to PhixFlow's User Groups.

See Active Directory or SAML / Single Sign-on for how to configure external login.

Contents

Table of Contents

Configure the Login Group

Go to the Active Directory tab in the System Configuration window.

Image Removed

There are two fields to configure:

...

Code Block
local
Code Block
narnia.local

...

The list of names of Active Directory groups authorized to use this instance of PhixFlow, separated by semicolons. There must be no spaces between the groups listed, just semicolons.

Use {instance} to include the PhixFlow instance name (this is set up in System configuration).

Note that these groups do not have to be mapped to any of the PhixFlow User Groups (see below), although they can be if you wish.

Code Block
PHIXFLOW_ADMINS; PHIXFLOW_USERS_{instance}

Image Removed

With the given configuration, assuming the instance name is ‘LIVE’, members of the following Active Directory groups will be authorized to log in into this PhixFlow instance:

  • PHIXFLOW_ADMINS
  • PHIXFLOW_USERS_LIVE

and Privileges

Multiple PhixFlow Instances

Where you have multiple PhixFlow instances (e.g. test v. prod) we recommend the use of group names that contain the instance name e.g. phixflow_test_designer and phixflow_prod_designer. This will allow you to have users who have different access rights in different instances.

Configure the Login Groups

Go to the External Login section of System Configuration.

Set the External Login Groups field to a semi-colon-separated list of external group names. An external user having any one of the external groups listed will be allowed to login.

You can use {instance} to include the PhixFlow instance name.

Examples

Assume the PhixFlow Instance is set to 'TEST'.

External Login GroupsDescription
phixflow_loginAny user with the external group phixflow_login will be allowed to login.
phixflow_admin;phixflow_{instance}_loginAny user with the external group phixflow_admin or the group phixflow_test_login will be allowed to login.

Configure the User Groups

When Active Directory users log into PhixFlow, their Active Directory groups are mapped to PhixFlow Managing User Groups and Privileges. You can set up this mapping by specifying an Active Directory Group in a PhixFlow User Group. When an AD user in that Active Directory group logs into PhixFlow, they will be put into that PhixFlow User Group.

...

It is not necessary to map all of a user's

...

External Groups to PhixFlow User Groups. For each user, any

...

External Groups that are not mapped are simply ignored.

The mapping is configured in the

...

User Group's External Login Group field.

You can use {instance} to include

...

the PhixFlow instance name.

Examples

...

Assume:

With the given configuration, assuming the instance name is ‘LIVE’, members of the Active Directory ‘PHIXFLOW_USERS_LIVE’ will be members of the ‘Designers’ PhixFlow User Group.

Active Directory users appear on the Group Members list. There is a new column which indicates if the user is a local user or a Active Directory user. Only local users can be added or removed from the list.

Image Removed

User Details

While editing an Active Directory user some fields are invisible. Login name cannot be changed. The domain of the User is shown in the header of the editor.

  • the System Configuration External Login Group is set to pf_login
  • the System Configuration instance is set to test
  • the following User Groups are configured:
User GroupExternal Login Groups
Administratorpf_admin;pf_{instance}_admin
Userpf_user;pf_tester

Jane is in external groups user, pf_loginpf_user and pf_admin: Jane is considered to be in both user groups.

Tim is in External groups administrator, user, pf_login and pf_tester: Tim is considered to be in the User user group only.

Max is in the external groups pf_user, user and manager: Max is not allowed to login as he doesn't have the External Login Group.

John is in the External groups administrator, user, and pf_login: John is allowed to login but will not be considered to be a member of any user group.