General IdP settings

Prev Next

This section will take you through the general settings fields that apply to all identity provider (IdP) types. Review the Before you start information before configuring IdPs.

The Specific IdP settings section takes you through the various fields specific to each new IdP type.

The Built-in IdP settings section takes you through the various fields that can be edited.

To add or edit an IdP, click +Add, select the IdP type, and complete the following fields:

  • Name. Enter a name for the identity provider. This cannot be changed later.

  • Notes. Optional. Enter any notes about the identity provider.

  • Tags. Optional. Add any tags to the identity provider.

Sign-in Settings

To configure the identity provider’s sign-in settings, complete the following fields:

  • Prevent new devices registrations that exceed this per user limit. All new devices are registered by the Controller. This prevents users registering more devices than the set limit. After registration is done, this number can be set to 0 to block all new devices. The registration of new devices (when valid credentials are presented) helps to prevent one of the most common forms of breach, namely when stolen credentials are used to sign-in to a system from a new device.

A cookie is created at sign-in and saved by the Controller and the Client (to present at subsequent connection attempts). This allows the Controller to perform additional checks at sign-in using this information. In the first instance the device count is checked and access will not be allowed if the set limit been exceeded. If this check passes then there is the option to require that users perform MFA at sign-in; either to register a new device (once), or for new and registered devices (always).

From time to time it may be required to remove a registered device:

  • MFA at Sign-in. Provides an additional restriction in respect of device registration. MFA can optionally be used with new devices or with new/registered devices. There are three modes available:

  • Not required (automatically register all devices)

  • Once (MFA required to register all new devices). Required to register any new device, as long as the new device registration count has not been exceeded

  • Always (MFA required at every sign-in). Required whether a device has been registered or not, as long as the new device registration count has not been exceeded

The recommended mode of operation is Once which means a user can onboard their own devices and will be required to provide additional authentication at that time. Thereafter, the device effectively counts as a second factor when authenticating, mitigating the requirement for users to use MFA at every sign-in. See MFA for more details. For Once or Always, an MFA provider must have been pre-configured:

  • MFA Provider. Choose which MFA provider to use for MFA at Sign-in.

  • Message. Message displayed to the user for 'Require MFA'. Defaults to localized message in the client. The client will replace "%RADIUS_MESSAGE%" with the message from radius server (if any).

    The following HTML tags are supported: 'a', 'b', 'i', 'strike', 's', 'strong', 'small', 'del', 'sub', 'sup', 'br', 'code', 'ol', 'ul', 'li', 'dl', 'dt', 'dd'

  • Claim Suffix. Enter a claim name for this 'Require MFA' user interaction which will be passed to the Gateways in the claims token. If you are configuring MFA at sign-in and also plan to use an MFA user interaction, then if you use the same user response claim suffix for both - you can avoid the user having to perform MFA twice over a short period of time.

  • Admin Access. Select Use for Admin UI sign-in to include this identity provider in the list of identity providers presented to the administrator.

Client settings

To configure the client settings for the identity provider, complete the following fields:

  • Client Inactivity. When Enable Timeout is selected, desktop clients will be signed out automatically when inactive.

  • Inactivity Timeout in Minutes. Set the inactivity timeout period after which the user will be signed out.

  • Timeout Trigger. Select between User Inactivity Only or User or Network. The latter triggers when either are inactive. This feature is designed mainly to drop the open tunnels to the Gateways and prevent any background traffic being sent from unattended machines. It is not designed as a user security feature since the client often is configured to sign-in automatically. The user will see "Your session has timed out after being idle for too long."

DNS configuration (deprecated)

The following DNS settings have been deprecated. It is recommended that you set up a Site DNS resolver for this purpose.

  • DNS Servers (deprecated). This setting has been deprecated. It is recommended that you set up a Site DNS resolver for this purpose.

  • DNS Domains (deprecated). This setting has been deprecated. It is recommended that you set up a Site DNS resolver for this purpose. The items in this list can be copied to the clipboard and pasted into a text field, such as the Match Domains (Zone) field in the DNS resolver.

  • Block Local DNS Requests (deprecated). This setting has been deprecated. It is recommended to use a DNS policy for this purpose.

  • Enforce Appgate connection as Domain network profile. Tries to set the client's network adapter to run with a domain network profile. This could then be used to influence local firewall settings. The network profile appears to use the following registry value but this is unsupported and undocumented by Microsoft. Its use is therefore not guaranteed and outcomes may depend on the version and build number of the underlying client operating system.

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\NetworkList\Profiles\{<Network GUID>}

The value of Category can be set as follows; Public = 0, Home = 1, Work = 2. When checked the value is set to 2.

IP pools

To configure IP pool settings for the identity provider, complete the following fields:

  • IPv4 Pool. Select a pre-configured pool of IP addresses to assign to clients authenticated through this identity provider.

  • IPv6 Pool. Select a pre-configured pool of IP addresses to assign to clients authenticated through this identity provider.

Claims

To configure claims settings for the identity provider, complete the following fields:

  • Attributes Mapped to User Claims. Attributes mapping defines how the user attributes in this identity provider directory will be mapped to AppGate ZTNA user claim names. This defines additional user claims that will be available to use when defining access criteria. For the local provider and Connector provider, a default list of mapped attributes is included. For the LDAP providers an example list of AD mapped attributes is included. As well as adding your own attributes, the included attributes can be edited/deleted.

Now is a good time to change or add any user claims you might want to use when you move on to configure user access.

User claims explains how to map extra claims and there is a list of the default user claims used in the AppGate ZTNA system.

  • Scripts Mapped to Device Claims. These scripts run on the users device and return values which are mapped to device claims. Device claims explains how to use these scripts and there is a list of all device claims used in the AppGate ZTNA system.

  • User Claim Scripts. These scripts can be used to make REST calls to external systems and return values which are mapped to user claims. User claims explains how to use these scripts and there is a list of all user claims used in the AppGate ZTNA system.