Authentication Methods
On this page
The Alloy Navigator applications sign people in with four authentication methods:
| Method | How the identity is established |
|---|---|
| Standard | A typed password is compared with the password stored on the account. |
| Windows | Alloy Navigator trusts a Windows identity that IIS or the signing-in client has already established. |
| LDAP | Alloy Navigator binds to a directory with the login and password the user typed. LDAP is a fallback inside standard sign-in, not a separate choice. |
| Single sign-on (SSO) | An external OpenID Connect provider asserts the identity. See Single Sign-On. |
Every method ends at the same point: an active account whose login matches. Standard authentication also compares the password; Windows, LDAP, and SSO establish the identity elsewhere and then require the account to exist. The one exception is the Self Service Portal's accountless sign-in, described below, which signs a person in without an account.
Methods per application
Whether an application supports a method and whether it offers the method are two different questions. Support depends on the application; whether the method is offered depends on the application's settings.
| Application | Standard | Windows | LDAP | SSO | Where it is switched |
|---|---|---|---|---|---|
| Web App | yes | yes | yes | yes | The password form and the SSO provider buttons in the Web App's application settings; Windows authentication in the Web App's Web.config file |
| Self Service Portal | yes | yes | yes | yes | The password form, Windows sign-in, and the SSO providers in the portal's settings |
| REST API | yes | yes | yes | yes | Password authentication and the SSO providers in the API's settings; the mode by IIS Windows authentication |
| Settings App | yes | yes | no | no | The sign-in dialog's authentication choice |
| Automation Server console | yes | yes | no | no | The sign-in dialog's authentication choice |
| Admin Center | yes | from the Web App session | no | from the Web App session | Opened from a signed-in Web App session |
In the Admin Center
You normally open the Admin Center from a signed-in Web App session. The Web App hands the Admin Center a single-use token for your account, so the Admin Center uses the way you signed in to the Web App. As a fallback, the Admin Center also has its own sign-in form that accepts a login and password. An account whose password is still stored in a legacy form cannot sign in through this form; see User Sessions.
In the Settings App
The Settings App's sign-in dialog lets you choose between standard and Windows authentication. LDAP and single sign-on are not available in the Settings App.
Windows authentication
For the Web App and the REST API, Windows authentication is a deployment decision, not a database setting. For the Self Service Portal, it is a portal setting.
In the Web App
Windows authentication for the Web App is the LoginAuthMethod key in the Web
App's Web.config file. The shipped configuration sets it to Standard and
turns IIS Windows authentication off. When Windows authentication is on, the Web App
signs the user in with the Windows identity from IIS and does not show the
sign-out command.
In the REST API
The REST API runs in one of two modes, set by IIS Windows authentication for the API:
- With IIS Windows authentication on, the API accepts Windows credentials and offers no access token: a request for a token returns a message saying that access-token authentication is not configured.
- With it off, the API uses access tokens, and Windows credentials are not consulted.
For the applications that call the API with an application ID and secret, see API Applications.
In the Self Service Portal
The portal's Windows authentication setting turns Windows sign-in on and, on its own, also hides the password form. With it on, once the browser holds the portal's time-zone cookie, a browser without a signed-in session is sent to Windows sign-in before any sign-in page appears, so the customer types nothing into the portal. A session that started with a password or single sign-on is signed out and sent to Windows sign-in, and after the setting is turned off, a session that started with Windows sign-in is signed out. The portal's Windows sign-in answers only when Windows authentication is also enabled in IIS for the portal. See Install the Self Service Portal.
In the Web Configuration Manager
When the Web Configuration Manager installs a web application, its Authentication Method page asks you to "Choose the authentication method" for the application's users (the Web App), visitors (the portal), or calls (the REST API). It offers Windows Authentication and Standard Authentication, or Windows Authentication and Access Token Authentication for the REST API. For the REST API, the page explains that applications supply either the Windows domain credentials of their account, or an application ID and secret or a user name and password. A new instance starts on standard authentication with password authentication allowed. LDAP and single sign-on are not chosen on this page. An upgrade from a version earlier than 2024.2 that passes through this page carries none of the older installation's single sign-on providers over. When the settings imported from an older installation had password authentication turned off, the page therefore does not let you go on with standard authentication. See Install the Web App and Publish the Web Applications.
IMPORTANT: Before an upgrade from a version earlier than 2024.2, note the single sign-on providers of each web application, and check them again after the upgrade. See Single Sign-On.
Directory (LDAP) authentication
On the password form, a directory sign-in uses the login and password that the
user types. Each directory that Alloy Navigator works with is a Domain
Credentials record. A record describes either an Active Directory domain or
another LDAP directory. The two use different login attributes,
sAMAccountName for Active Directory and uid for another LDAP directory,
and the Settings App's edit form for the record requires a base DN for another
LDAP directory, while it clears the base DN of an Active Directory record on
save. A record can
use SSL for the connection to the directory; it does not by default.
Prepare a secure directory connection
A secure connection (LDAPS) is the Secure Connection option of a Domain Credentials record; see Active Directory Synchronization. Before you select it, make sure that the directory server's certificate is one that Alloy Navigator can trust:
- In Alloy Navigator Cloud, the directory server must use a trusted certificate signed by a public certificate authority (CA). LDAPS connections secured with a self-signed certificate are not supported.
- In an on-premises installation, use a trusted certificate signed by a public CA. You can also use a certificate signed by a private CA or a self-signed certificate; the servers that host the Automation Server and the Alloy web applications must then be configured to trust that certificate.
If the secure connection fails when you click Test Connection because the directory server's certificate does not cover the name used to reach the server, for example an alias name, consider the Windows LDAP client setting that Microsoft describes in LDAPS connection fails with event ID 36884. Apply it on each computer that opens the secure connection, the Automation Server computer and the IIS server computer:
- Start Registry Editor.
- Locate the subkey
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\LDAP. - Create a REG_DWORD value named
UseHostnameAsAlias, and set it to any value other than zero, for example1. - Exit Registry Editor, and then restart the computer.
In the Web App
- The typed login and password are compared with the account first.
- Only if that fails, and only for a standard sign-in, the directory is consulted. The directory is chosen by the domain part of the login.
- The account must already exist as a Windows-authentication technician account.
- Alloy Navigator binds to the directory server with the user's own login
and password. A successful bind confirms the password, and the session
continues under the
DOMAIN\userlogin.
A logon failure from the directory is reported as a failed sign-in. Any other directory error is reported as an LDAP connection failure.
A login without a domain part is sent to a directory only when exactly one directory is configured and at least one technician account's login begins with that domain name. A second configured directory turns logins without a domain part off.
In the REST API
The REST API uses the same directory check as the Web App. Its validation refuses Self Service Portal customer accounts outright, and it sends any login that contains a backslash straight to the directory. A login without a domain part goes to the directory after the stored password check fails.
In the Self Service Portal
The portal has its own directory sign-in. It consults a directory for a login that contains a backslash, for a login without a domain part whose stored password check fails, and for a Windows-authenticated user with no account. It takes the directory record whose domain name matches the login's domain part, ignoring case, and finds the user in the directory, binding with the user's typed login and password on the password form, or with the directory record's stored credentials for a Windows sign-in. This path can sign in a customer account.
- An existing active account signs in; an inactive one is refused.
- With no account, the domain must be switched on for accountless sign-in, as described below. The person is then found by their directory import identifier, or created by the action you chose.
- A login without a domain part goes to a directory only when exactly one directory is configured and, in addition, either a technician or customer account's login begins with that domain name or the domain is switched on for accountless sign-in. A second configured directory turns logins without a domain part off.
A directory synchronization job can create the Self Service Portal accounts that this path signs in; the option is on for a job created in the Settings App. See Active Directory Synchronization.
Accountless sign-in to the portal
Accountless sign-in is a Self Service Portal mode. When an SSO provider or a directory is marked as accountless for a portal instance, a person whose identity has no matching account is not refused. For an SSO provider, the portal matches the asserted e-mail address with existing persons and creates a person from the asserted full name and e-mail address if none matches. A domain user of an accountless directory is imported as a person on first sign-in. The session then runs for that person. This is the only sign-in path that creates a record. The switch for directories is set in the Admin Center; the Settings App has no equivalent setting.
In the Admin Center
To let domain users sign in to a portal instance without an account:
- Open Self Service Portal > the portal instance > Authentication.
- In the SSO/LDAP Authentication section, in the Domains list, turn on the switch of the domain. The switches are enabled only while Allow password authentication is on or the instance uses Windows authentication.
- In For new domain users: Create Persons using this Action, choose the Active Directory action that creates the person. This setting is required.
Single sign-on
Single sign-on accepts an identity asserted by an external OpenID Connect provider. Setting up providers is described in Single Sign-On.
Sign-in protection
The Web App can lock out repeated failed sign-ins. You set this in the Admin Center, in the Web App's settings. The protection has four settings:
- whether it is enabled
- the maximum number of attempts
- a rolling window in minutes
- a lock duration in minutes
Protection is off unless it is enabled and all three numbers are above zero. When the number of failed attempts inside the window reaches the maximum, the sign-in button is disabled and further attempts are refused until the lock expires. A successful sign-in clears the count. The Web App caches the setting for five minutes.
When the setting holds no value, protection is off, with five attempts in one minute and a one-minute lock.
The count is kept per browser session, or per client IP address when there is no session, in the memory of the Web App on the web server:
- It counts attempts per browser session, not per account.
- It is reset when the web application's application pool is recycled.
- It is not shared between web servers.
Sign-in protection guards the password form only. Single sign-on does not use it.
Related topics
- Single Sign-On - set up OpenID Connect providers.
- Install the Web App - the Web Configuration Manager and its Authentication Method page.
- API Applications - applications that call the REST API.