Configure SAML 2.0 single sign on (SSO) in IT Advisor

[JLehr]

These instructions apply to ITA on-premises only. ITA hosted customers can leverage SSO in IT Expert.

Administrators can configure SAML 2.0 SSO on the Configuration > Authentication servers tab in the IT Advisor web client.

Any identity provider (IdP) that supports the SAML protocol is supported. 

Once you configure SSO, all users with an email address on one of the domains you specify must use your identity provider to log in to IT Advisor on-premises.

IMPORTANT: It is strongly recommended that at least one Administrator user who does not require SSO to log in is configured in the web client on the Administration > Users tab.

1. Configure your identity provider

Before you configure SSO in IT Advisor, configure the integration with ITA in your identity provider's user interface. Refer to your identity provider's documentation for more information.

See Configure Azure for IT Advisor SAML SSO

2. Configure SAML SSO in in IT Advisor

After you have added IT Advisor to your authentication providers user interface, configure the authentication server in the ITA web client. 

1. Log in to the ITA web client as an Administrator.
2. Click the cogwheel in the upper right. Go to Configuration > Authentication Servers > Add Authentication Server.

   

3. In Authentication server settings, enter: Type: Select SAML SSO.

   See the documentation for your IdP provider. Azure is used in the examples below.

   • Name: The name of the server, for example, Azure SSO
   • Service provider ID/Application ID/ Client ID: The UUID of IT Advisor in IdP. In Azure, copy the value from the Application (client) ID field.
   • SAML metadata is an XML document that contains information necessary for interaction with the SAML-enabled identity or service providers, for example, URLs of endpoints, information about supported bindings, identifiers and public keys.

     In ITA 9.5.0 and older: Enter the IdP Federation metadata document URL

     In ITA 9.5.1 and newer: Enter the SSO POST URL

   • User name attribute name: The unique name of the user. In Azure, copy the value from federation metadata: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name
   • User email attribute name:  The e-mail address of the user. In Azure, copy the value from federation metadata: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
   • User display name/common name,attribute name: The common name of the user. Copy the value from federation metadata: http://schemas.microsoft.com/identity/claims/displayname
   • User groups/group name, attribute name: Group(s) the user is a member of. Copy the value from federation metadata: http://schemas.microsoft.com/ws/2008/06/identity/claims/groups
   • Default ITA user group name: Enter the ITA user group where the authorized users are assigned. Only one group name can be entered. If this value is defined, Mapping of IdP tenant group’s names to ITA group’s names is ignored. If this value is not defined, the group(s) defined in Mapping of IdP tenant group’s names to ITA group’s names are used.
   • Mapping of IdP tenant group name to ITA group names: If the value for Default ITA user group name is not defined, this mapping is used to assign users to defined group(s) in ITA. Use an equals sign  =  to separate group names, and use  a semicolon ; to separate each mapping.

     Note: If both the Default ITA user group name and Mapping of IdP tenant group name to ITA group names valuesare not defined, or the group’s names are incorrect, users are not automatically assigning to any group in ITA.

   • ITA endpoint URL callback: A SAML Assertion is the XML document the identity provider sends to the service provider that contains the user authorization.

     In ITA, it must always start with https and end with /api/current/authentication/saml2-callback. For example, https://address

      _of _ITA server/api/current/authentication/saml2-callback
   • SAML Request certificate: SAML request signing certificates are X.509 certificates used in SAML responses to allow the Service Provider (SP) to verify the authenticity of a SAML response.

     In Azure, the value from federation metadata with the additional prefix ”-----BEGIN CERTIFICATE----- ” and suffix “-----END CERTIFICATE-----”

   • SAML Request certificate issuer: The issuer of the request certificate. In Azure, the value from federation metadata in the attribute “EntityDescriptor@entityID” 
4. Click OK.