.. _configure-sso-idp: Configure SSO IdP ------------------- .. _20.1.1|VOSS-568: .. _20.1.1|VOSS-551|EKB-4383: .. _20.1.1|VOSS-551|EKB-7380: .. _20.1|VOSS-693|EKB-8995: .. _19.3.4-PB5|EKB-8995: .. _21.1|EKB-8995: .. _21.3|VOSS-911: .. _24.1-PB1|EKB-21172: .. tip:: :ref:`use-action-search-to-navigate-automate` This procedure configures integration with a SSO identity provider (IdP). 1. Log in as Provider, Reseller, or Customer administrator (depending on your IdP configuration level). #. Go to **Upload SSO IDP Metadata** and upload the IdP metadata file. See :ref:`upload-sso-idp-metadata`. #. Go to **Configure SSO IDP**, then click the Plus (+) icon to add the SSO identity provider configuration. .. note:: Only one instance of an SSO identity provider can be configured for a hierarchy node. While an IdP may exist at more than one hierarchy in Automate, a user will only be permitted to log in if the user exists at or below the hierarchy of a single IdP. #. Complete at least the mandatory settings: * **Entity ID**: Mandatory. Entity ID of the IDP. This field must exactly match the entity ID in the IdP metadata file. * **Login URI**: Mandatory. Login URI for the IDP. This is the URI that will be embedded in SSO Login URL. It can contain only alphanumeric characters and forward slashes. * **Service Provider Domain Name**: The FQDN that will be embedded in the SP metadata for this IdP for URLs that refer back to the service provider. If a customer is using a *custom domain*, the value for service provider domain name is filled out at the hierarchy level and the login and metadata URLs used will be tied to the IdP as follows: :: SSO Login URL: ``https:///sso//login`` Admin Portal: ``https:///admin/sso//login`` The metadata is obtained from: ``https:///sso//metadata`` If the service provider domain name *is* specified, the metadata XML file from Automate then contains ``Service.Provider.Domain.Name`` in the assertion consumer service URL as shown in the example below: :: This metadata needs to be uploaded to the IdP (not the generic metadata obtained from SSO Service Provider Configuration). .. important:: If you have previously uploaded metadata to the IDP and you subsequently complete this **Service Provider Domain Name** field, you need to remove the previous record from the IdP and re-upload the metadata so that it contains this field. If the service provider domain name is *not* specified for a given IdP, the following URLs formats are used for SSO login: :: SSO login URL: ``https:///sso//login`` Admin Portal: ``https:///admin/sso//login`` The IdP redirects to this FQDN on login. * **Local Metadata File**: Mandatory. Choose the IdP metadata file. This file must be unique across the system. * **Note**: A reminder to upload the IdP metadata file. * **SSO Enabled**: Select the checkbox to enable SSO for users synced in or created at the current hierarchy level. Clear this checkbox to disable SSO for the users associated with the defined IDP. * **SSO Login URL**: Read-only. Displays the SSO Login URL to use. Users with ``selfservice`` role and no Authorized Admin Hierarchy will be redirected to Self-service. * **Admin SSO Login URL**: Read-only. Displays the Admin Portal SSO Login URL to use. * **Business Admin SSO Login URL**: Read-only. Displays the new Business Admin Login URL to use. From release 21.4, this will *always* redirect to the new Admin Portal. * **User lookup field**: Mandatory. Select the field to bind the VOSS and SSO user - typically, ``username``. * **UID Attribute Name**: An optional attribute name string value configured on the IdP to be used as UID for authentication. If present, this value is evaluated first by Automate as the UID and used as an alternative user identifier when the default UID record is not present. If this value is not present, the default UID record is used to identify the user. * If a custom attribute is used as the UID from the identity provider (IdP), then use this attribute as the UID attribute name. Automate evaluates the value in **UID Attribute Name** first as the UID to identify the user and is for example used as an alternative user identifier when the default UID record is not present. * If this value is *not* present, the default UID record is used to identify the user. For example, if the UID attribute is not mapped on the IdP, and an attribute, ``ElectronicMail``, is mapped to ``mail`` on the (IdP), the **User lookup field** on the SSO IdP should be the value from the ``email`` field in Automate, and the value for **UID Attribute Name** should be ``ElectronicMail`` (the attribute returned by the IdP). The full URL of a claim in the assertion may be used as the UID attribute name together with the mapped field on User. The SAML response may include claims attributes configured on the IdP as follows: :: 'http:\/\/schemas.microsoft.com\/identity\/claims\/objectidentifier': ['e333df87-4321-4889-852e-45c291234a2b'], 'http:\/\/schemas.microsoft.com\/identity\/claims\/displayname': ['Users_Display_Name'], ... 'http:\/\/schemas.xmlsoap.org\/ws\/2005\/05\/identity\/claims\/name': ['User@some_domain.com'] If 'User@some_domain.com' maps to username in Automate, the SSO may be configured as follows: * User lookup field = username * UID Attribute Name = http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name * **Authentication Scope**: Hierarchical scope this server applies to. * Full tree authentication (default): All nodes at and below this node in its tree can authenticate against this server. * Local authentication: Only users at this node can authenticate against this server. * **User Sync Type**: Type of users that can authenticate against this server. * Synced users only: Only users synced in from LDAP can authenticate against this server. * All users #. Click **Save** to save the SSO IdP configuration and enable SSO if selected. #. Go to **Admins** and filter on **Auth Method** equals ``SSO`` to display enabled SSO users. .. rubric:: Related topics * See **SAML SP Settings FQDN** in :ref:`sso-sp-settings` * For further details on authentication scope, see also :ref:`user-login-auth-method-srv-auth-scope` * :ref:`sso-scenarios-for-user-roles` * :ref:`upload-sso-idp-metadata`